Skip to content

Reference ​

The pages in this section are generated from pinned sources rather than hand-maintained. Each page states its exact source at the top. Not all of it is regenerated on every build: a site build rebuilds the data behind the rendered Scopes, Manifest, Messages, Hooks and CLI tables, but the Markdown copy of each table committed in the page source (what .md and llms.txt readers get) is refreshed by a maintainer running npm run gen:appblocks:md, and the Components page is a committed file regenerated by hand. A pull-request check fails when a committed Markdown copy no longer matches its generator. Manifest, Hooks and the Messages payload shapes follow pinned @civitai/* package releases; Scopes, the Messages page-only flags, Components and the CLI follow committed snapshots of their sources (the civitai repo's constants, the @civitai/components markup contract and the CLI's --help). Either way, an upstream change reaches these pages when the site re-pins or re-snapshots.

PageWhat it coversSource of truth
ScopesThe scope catalog: what each scope authorizes, its OAuth bit, and its bindingcivitai block-scope constants
ManifestEvery block.manifest.json field, type, and constraintthe published JSON Schema
ComponentsThe @civitai/components design-system pack: each component's data-civitai-ui name, attributes, and ARIA markupthe @civitai/components MARKUP.md contract
MessagesThe full postMessage bridge protocol (payloads, directions, page-only)@civitai/app-sdk + host parity inventory
HooksEvery @civitai/blocks-react hook: signature + example@civitai/blocks-react types + README
CLIThe civitai CLI's App-authoring commands and flagsthe Go civitai CLI (civitai/cli)

A note on authority ​

The generated tables describe the shape of the contract. The Civitai server is the enforcement boundary — it validates more than these artifacts can express (host allowlists, scope subsets, trust tiers). Where a generated page and the server ever disagree, the server wins. Each page calls out the semantics it can't capture.

Civitai Developer Documentation