symbol

Get symbols in a specific file (uses ast-grep)

Returns a list of symbols (functions, classes, variables, etc.) defined in the specified file.

Only the variabels defined at the file level are included.

The returned positions point to the start of the symbol’s identifier.

e.g. for User on line 0 of src/main.py:

0: class User:
_________^
1:     def __init__(self, name, age):
2:         self.name = name
3:         self.age = age

GET

symbol

definitions-in-file

curl --request GET \
  --url http://localhost:4444/v1/symbol/definitions-in-file \
  --header 'Authorization: Bearer <token>'

[
  {
    "file_range": {
      "path": "src/main.py",
      "range": {
        "end": {
          "character": 5,
          "line": 10
        },
        "start": {
          "character": 5,
          "line": 10
        }
      }
    },
    "identifier_position": {
      "path": "src/main.py",
      "position": {
        "character": 5,
        "line": 10
      }
    },
    "kind": "class",
    "name": "User"
  }
]

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

200

application/json

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"

Get the definition of a symbol at a specific position in a file

curl --request GET \
  --url http://localhost:4444/v1/symbol/definitions-in-file \
  --header 'Authorization: Bearer <token>'

[
  {
    "file_range": {
      "path": "src/main.py",
      "range": {
        "end": {
          "character": 5,
          "line": 10
        },
        "start": {
          "character": 5,
          "line": 10
        }
      }
    },
    "identifier_position": {
      "path": "src/main.py",
      "position": {
        "character": 5,
        "line": 10
      }
    },
    "kind": "class",
    "name": "User"
  }
]

symbol

system

workspace

Authorizations

Query Parameters

Response