Sign Up

LSP

POST/lsp/completions

Get code completion suggestions from the LSP server

Request Body

application/json

Completion request

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/lsp/completions" \  -H "Content-Type: application/json" \  -d '{    "languageId": "string",    "pathToProject": "string",    "position": {      "character": 0,      "line": 0    },    "uri": "string"  }'
{  "isIncomplete": true,  "items": [    {      "detail": "string",      "documentation": null,      "filterText": "string",      "insertText": "string",      "kind": 0,      "label": "string",      "sortText": "string"    }  ]}
POST/lsp/did-close

Notify the LSP server that a document has been closed

Request Body

application/json

Document request

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/lsp/did-close" \  -H "Content-Type: application/json" \  -d '{    "languageId": "string",    "pathToProject": "string",    "uri": "string"  }'
Empty
POST/lsp/did-open

Notify the LSP server that a document has been opened

Request Body

application/json

Document request

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/lsp/did-open" \  -H "Content-Type: application/json" \  -d '{    "languageId": "string",    "pathToProject": "string",    "uri": "string"  }'
Empty
GET/lsp/document-symbols

Get symbols (functions, classes, etc.) from a document

Query Parameters

languageId*string

Language ID (e.g., python, typescript)

pathToProject*string

Path to project

uri*string

Document URI

Response Body

application/json

application/json

curl -X GET "https://example.com/lsp/document-symbols?languageId=string&pathToProject=string&uri=string"
[  {    "kind": 0,    "location": {      "range": {        "end": {          "character": 0,          "line": 0        },        "start": {          "character": 0,          "line": 0        }      },      "uri": "string"    },    "name": "string"  }]
POST/lsp/start

Start a Language Server Protocol server for the specified language

Request Body

application/json

LSP server request

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/lsp/start" \  -H "Content-Type: application/json" \  -d '{    "languageId": "string",    "pathToProject": "string"  }'
Empty
POST/lsp/stop

Stop a Language Server Protocol server

Request Body

application/json

LSP server request

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/lsp/stop" \  -H "Content-Type: application/json" \  -d '{    "languageId": "string",    "pathToProject": "string"  }'
Empty
GET/lsp/workspacesymbols

Search for symbols across the entire workspace

Query Parameters

query*string

Search query

languageId*string

Language ID (e.g., python, typescript)

pathToProject*string

Path to project

Response Body

application/json

application/json

curl -X GET "https://example.com/lsp/workspacesymbols?query=string&languageId=string&pathToProject=string"
[  {    "kind": 0,    "location": {      "range": {        "end": {          "character": 0,          "line": 0        },        "start": {          "character": 0,          "line": 0        }      },      "uri": "string"    },    "name": "string"  }]