---
title: "Get document symbols"
method: POST
path: "/v1/devboxes/{id}/lsp/document-symbols"
tags: ["ts-ls"]
---

# Get document symbols

`POST /v1/devboxes/{id}/lsp/document-symbols`

Get document symbols for a given document.

## Path parameters

- `id` string, required

## Request body

- FileRequestBody — Requesting a file parameter with a URI with absolute or relative path example with absolute uri: file://Users/user/project/src/index.ts
  - `uri` string, required

## Response `200`

A list of document symbols.

- BaseDocumentSymbol[]
  - `selectionRange` BaseRange, required
    - `end` object, required
      - `character` number, double, required
      - `line` number, double, required
    - `start` object, required
      - `character` number, double, required
      - `line` number, double, required
  - `range` BaseRange, required
    - `end` object, required
      - `character` number, double, required
      - `line` number, double, required
    - `start` object, required
      - `character` number, double, required
      - `line` number, double, required
  - `kind` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26, required — A symbol kind.
  - `name` string, required

---

[API](https://skmtc.dev/runloopai/apis/runloop-api.md) · [All operations](https://skmtc.dev/runloopai/apis/runloop-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/runloopai/runloop-api/revisions/0cb966ca566f/schema)