Skip to content

Get completions

POST
/v1/sandbox/{sandboxID}/lsp/completions

Request code completions at a given position in a document.

sandboxID
required
string

Unique sandbox identifier.

object
language_id
required
string
Example
python
path_to_project
required
string
Example
/home/user/project
uri
required

Document URI.

string
Example
file:///home/user/project/main.py
position
required
object
line
required

Zero-based line number.

integer
Example
10
character
required

Zero-based character offset.

integer
Example
3
context
object
trigger_kind

Completion trigger kind.

integer
Example
1
trigger_character

Trigger character when completion was invoked by a specific character.

string
Example
.

JSON-RPC 2.0 response from the language server.

One of:

JSON-RPC 2.0 response envelope returned by LSP request endpoints.

object
jsonrpc
string
Allowed values: 2.0
id
One of:
integer
result
required

Method-specific success payload.

error
object
code
required

JSON-RPC error code.

integer
Example
-32602
message
required

Human-readable error message.

string
Example
Invalid params
data

Optional method-specific error data.

Bad request – validation error.

object
message
required

Summary message, e.g. “Invalid request”.

string
errors
required
Array<object>
object
field
required

JSON field name that failed validation (e.g. “path”, “command”).

string
error
required

Human-readable description of the validation failure.

string

Unauthorized – invalid or missing API key.

object
message
required

Human-readable error message.

string