Skip to main content
GET
Get symbols in a specific file (uses ast-grep)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

file_path
string
required

The path to the file to get the symbols for, relative to the root of the workspace.

Response

Symbols retrieved successfully

file_range
object
required

The full range of the symbol.

identifier_position
object
required

The start position of the symbol's identifier.

kind
string
required

The kind of the symbol (e.g., function, class).

Example:

"class"

name
string
required

The name of the symbol.

Example:

"User"