/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Get syntext.json Schema

Get syntext.json Schema

The JSON Schema for syntext.json and syntext.yml — public and cacheable

GET/v1/schema/syntext.jsonTry it

Returns the JSON Schema (draft-07) for syntext.json, syntext.yaml and syntext.yml, generated from the same definition the build validates against. Point $schema at it to get autocomplete and validation in your editor — see $schema.

The same document is served at https://syntext.dev/schema/syntext.json, the URL stx init writes into new projects.

Authentication

None. The endpoint is public and holds no project data.

Caching

HeaderValue
Content-Typeapplication/schema+json; charset=utf-8
Cache-Controlpublic, max-age=3600, s-maxage=86400
ETagA hash of the document. Send it back as If-None-Match to get 304 Not Modified
Access-Control-Allow-Origin*

Example

Abbreviated — the full schema describes every key on the syntext.json reference.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/schema/syntext.json
Responseapplication/json
json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://syntext.dev/schema/syntext.json",
"title": "syntext.json",
"description": "Syntext site configuration (syntext.json, syntext.yml or syntext.yaml).",
"type": "object",
"properties": {
"$schema": { "type": "string" },
"name": { "type": "string" },
"theme": { "type": "string" },
"appearance": { "type": "object" }
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext