Get Editor Catalogue
Every MDX component, prop, frontmatter key, icon name and @stx tag the renderer and parser support — the list behind the web editor's completions and block picker.
Returns the catalogue of what a Syntext page can use: every MDX component with its props, every frontmatter key the build reads, every icon name, and every @stx annotation tag the parser understands. It describes what the renderer supports today, so a component or key that isn't listed here isn't supported.
The web editor reads it for completions, hover docs and inline checks in Edit, and for the block picker and component settings in Preview. The editor's Assistant is taught from the same list, and its proposals are refused if they use a component, prop or value that isn't in it, so the three never disagree.
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}. Available on every plan. It doesn't touch the repository, so it works before a repository or GitHub App installation is connected.
The catalogue is the same for every project today. Responses carry Cache-Control: private, max-age=300, so you can cache one for five minutes.
Path Parameters
projectIdResponse — 200 OK
Trimmed to a few entries per list:
Response Fields
components[]
nameNote, CardGroup.categorycallout, layout, navigation, code, api, content or other.summarydescriptionprops{ name, type, values?, default?, required?, description }. type is one of string, number, boolean, enum, expression, icon or href. values lists the allowed values of an enum prop; default is what the renderer uses when the prop is omitted. Names are in the case authors write (defaultOpen); the renderer also accepts them lowercased.childrennone for a self-closing tag, markdown for free content, or the names of the components allowed inside.parentColumn inside Columns. Absent when it can go anywhere.inlinetrue for a component used inside a line of prose rather than as a block.snippetinsertablenotedeprecated<Warning> for Caution. Deprecated components are never offered in the block picker. Absent when the component is current.frontmatter[]
keytypestring, number, boolean, enum, string[], object, href or icon.valuesenum key.requiredtrue for title.descriptionprotocolprotocol value the key is read under — rest, websocket, graphql, grpc or event.notedeprecatedicons[]
iconsicon props and the frontmatter icon key accept. Any other name shows no icon. Doc engine v2 draws a subset of these — see Cards › Available icons.stxTags[]
tag@ — stx, stx.http, stx.cli.flag. Covers the HTTP, WebSocket, GraphQL, CLI, gRPC and event families. The editor completes these after @stx in code samples.descriptionThe parser's tag list is built from the same source, so a tag listed here is one the parser reads.
Callouts are five tags — Note, Info, Tip, Warning and Danger. <Caution> and <Callout type="…"> still render but are deprecated; the catalogue lists Caution with deprecated: "<Warning>".
Error Responses
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.
404 Not Found
not_found — the project does not exist or was deleted.