Get Editor Symbols
The @stx-annotated symbols in a project's repository — what the web editor offers for {@embed} completions and Code from @stx.
Returns the functions, classes, interfaces, types and enums in the project's repository that carry an @stx annotation, each with the value to put in an {@embed} directive.
The web editor uses it for {@embed src="…"} completions, for Code from @stx in the Preview's block picker, and to flag an {@embed} that names a symbol that doesn't exist.
Any member of the workspace can call this, signed in with a session JWT — API keys are refused with 401. You must belong to the organization that owns {projectId}. The project's repository is read through its GitHub App installation — see Pages & Content API. A project written in Syntext has no code to annotate, so its index is always empty.
Limited to 30 requests per user, per project, per minute — see Rate limits.
How the index is built
*.test.*, *.spec.*, _test.go, test_*.py, __tests__/…) and node_modules, dist, build, vendor and .git folders are skipped. truncated is true when there were more files than that.@stx tag.502 github_error.Path Parameters
projectIdResponse Fields
symbolssymbols[].namesymbols[].pathsymbols[].kindfunction, class, interface, type or enum.symbols[].linesymbols[].summary@stx description. Absent when it has none.symbols[].signatureclass Name extends Base for a class. Absent when the parser didn't capture one.symbols[].embedpath#name — the value of {@embed src="…"} for this symbol.indexedAttruncatedtrue when the repository has more code files than the index reads, so some symbols may be missing.repoowner/repo.Error Responses
400 Bad Request
bad_request — the project has no repository, an invalid repository URL or no GitHub App installation.
401 Unauthorized
No session JWT, an expired one, or an API key.
403 Forbidden
forbidden — you are not a member of the organization that owns the project. installation_not_owned — the GitHub App installation isn't connected to the project's workspace.
404 Not Found
not_found — the project does not exist or was deleted.
429 Too Many Requests
rate_limited — more than 30 symbol requests from you on this project in the current minute. Wait details.retryAfterSeconds before trying again.
502 Bad Gateway
github_error — GitHub refused a request, or didn't answer in time. details.githubStatus has GitHub's status, or 504 for a timeout.