/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Get Editor Catalogue

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.

GET/v1/projects/{projectId}/editor/catalogueTry it
Session token

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.

Note

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

NameDescription
projectId:stringpathRequired
The project ID.

Response — 200 OK

Trimmed to a few entries per list:

Response Fields

components[]

NameDescription
name:string
The tag name as written in MDX, case-sensitive — Note, CardGroup.
category:string
One of callout, layout, navigation, code, api, content or other.
summary:string
One line, in plain words.
description:string
One to three sentences on what the component renders.
props:object[]
The props the renderer reads, each { 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.
children:string | string[]
none for a self-closing tag, markdown for free content, or the names of the components allowed inside.
parent:string
The component this one must sit inside — Column inside Columns. Absent when it can go anywhere.
inline:boolean
true for a component used inside a line of prose rather than as a block.
snippet:string
Minimal valid MDX for the component — what the editor inserts.
insertable:boolean
Whether the editor's block picker offers it.
note:string
Where the renderer differs from the docs, or a limit worth knowing. Absent when there's nothing to say.
deprecated:string
The replacement to write instead — <Warning> for Caution. Deprecated components are never offered in the block picker. Absent when the component is current.

frontmatter[]

NameDescription
key:string
The frontmatter key, case-sensitive.
type:string
One of string, number, boolean, enum, string[], object, href or icon.
values:string[]
The allowed values of an enum key.
required:boolean
true for title.
description:string
What the key does.
protocol:string
For API-page keys only: the protocol value the key is read under — rest, websocket, graphql, grpc or event.
note:string
Where the renderer differs from the docs, or a limit worth knowing.
deprecated:string
The key to write instead, for a deprecated key. Absent when the key is current.

icons[]

NameDescription
icons:string[]
The icon names that icon 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[]

NameDescription
tag:string
The annotation tag without its @ — 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.
description:string
One sentence on what the tag documents.

The parser's tag list is built from the same source, so a tag listed here is one the parser reads.

Tip

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.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl "https://api.syntext.dev/v1/projects/3f2b9c1e-8d4a-4c6b-9e2f-1a7d5b0c8e93/editor/catalogue" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."
Responseapplication/json
200OK
{
"data": {
"components": [
{
"name": "Note",
"category": "callout",
"summary": "A highlighted box for context readers should not miss.",
"description": "A blue-toned callout for prerequisites and key facts. Takes any Markdown, including code fences.",
"props": [
{
"name": "title",
"type": "string",
"description": "Heading shown in bold on its own line above the body, in the callout colour. Skipped if the body already opens with bold text."
}
],
"children": "markdown",
"snippet": "<Note>\nAPI keys are scoped to a single project.\n</Note>",
"insertable": true
}
],
"frontmatter": [
{
"key": "title",
"type": "string",
"required": true,
"description": "Page title: browser tab, sidebar, SEO, and the h1 when the body has none.",
"note": "Falls back to the file name when absent."
}
],
"icons": ["rocket", "zap", "shield", "globe", "code", "terminal", "book", "key"],
"stxTags": [
{ "tag": "stx", "description": "Marks a symbol for the docs and gives it a summary." },
{ "tag": "stx.http", "description": "Documents an HTTP endpoint with its method and path." }
]
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext