Symbols API

List symbols

GET /v1/workspaces/{workspace_id}/repos/{repo_id}/symbols

Returns paginated symbols for a repository.

Parameter	Type	In	Description
workspace_id	string	path	Workspace ID
repo_id	string	path	Repository ID
kind	string	query	Filter by symbol kind (function, class, method, etc.)
language	string	query	Filter by language
is_exported	boolean	query	Filter exported symbols only
search	string	query	Full-text search on symbol name and FQN
cursor	string	query	Pagination cursor
limit	integer	query	Page size (default 50, max 200)

Response

{
  "items": [
    {
      "id": "sym_abc123",
      "repo_id": "repo_xyz",
      "fqn": "com.example.UserService.findById",
      "short_name": "findById",
      "kind": "method",
      "language": "java",
      "file_path": "src/main/java/com/example/UserService.java",
      "line_start": 42,
      "line_end": 55,
      "signature": "public User findById(Long id)",
      "is_exported": true,
      "is_deprecated": false
    }
  ],
  "next_cursor": "eyJpZCI6..."
}

Get symbol by ID

GET /v1/workspaces/{workspace_id}/repos/{repo_id}/symbols/{symbol_id}

Returns full details for a single symbol, including docstring and LLM description.

Get symbol references

GET /v1/workspaces/{workspace_id}/repos/{repo_id}/symbols/{symbol_id}/refs

Returns all locations where this symbol is referenced.

Response

{
  "items": [
    {
      "id": "ref_001",
      "symbol_id": "sym_abc123",
      "repo_id": "repo_xyz",
      "file_path": "src/main/java/com/example/UserController.java",
      "line": 28,
      "context_snippet": "User user = userService.findById(id);",
      "ref_kind": "call"
    }
  ]
}

Search symbols by FQN

GET /v1/workspaces/{workspace_id}/repos/{repo_id}/symbols/fqn/{fqn}

Look up a symbol by its fully qualified name. Returns an exact match.