Skip to main content
GET
Returns everything an agent needs to author valid instruction manuals without guessing: the canonical schema version, the closed node/mark vocabulary, per-node attribute allowlists, the changeset operation kinds, node-level patch operations, audiences, render formats, tree depth bound, and per-kind asset size limits. Call this first in any authoring session. Requirements: instructions:read.

​
Response

​
string
The instructions API version.
​
string
The canonical document schema identifier (opentrain-tiptap/1). Every document envelope must carry it.
​
number
Maximum page nesting depth per manual.
​
string[]
Read-audience ladder: ADMIN, CONTRIBUTOR, REVIEWER, WORKER.
​
string[]
IMAGE, FILE, AUDIO, VIDEO — with per-kind byte limits in maxAssetSizeBytes.
​
string[]
The operation kinds accepted by changesets, e.g. PATCH_CONTENT, CREATE_PAGE, MOVE_PAGE.
​
string[]
Stable-node patch operations usable inside PATCH_CONTENT (replace_node, insert_before, insert_after, append_children, set_attrs, delete_node).
​
string[]
The closed node vocabulary. Node types outside this list are rejected at write time.
​
string[]
The closed mark vocabulary — same rejection rule.
​
object
Per-node-type attribute allowlists. Unknown attribute keys surface as validation warnings; invalid attribute values are errors.
​
string[]
json (canonical), html, markdown (derived; carries a loss report).