Civitai Developer Docs

Source for developer.civitai.com — built with VitePress.

Covers the Orchestration API (submit AI workflows for video, image, audio, and text generation through a single contract) and the Civitai Site API (browse models, images, creators, and tags on civitai.com). Structured to host additional product docs (SDKs, Signals, etc.) over time.

Quick start

npm install
npm run dev

The dev server starts with HMR. The OpenAPI spec is pulled automatically from the sibling civitai-orchestration repo if present, otherwise fetched from the production API.

Build

npm run build       # outputs .vitepress/dist/
npm run preview     # serve the built site locally

Docker

docker build . -t civitai-developer-docs

Produces an nginx:alpine image serving the static site.

Project structure

├── index.md                           # Developer Hub landing page
├── orchestration/
│   ├── guide/                         # Consumer onboarding (auth, workflows, results, errors)
│   ├── recipes/                       # Runnable examples with interactive Try It widgets
│   ├── reference/                     # Auto-generated from OpenAPI spec (dynamic routes)
│   └── internals/                     # Architecture diagrams
├── site/
│   ├── guide/                         # Civitai site API: auth, pagination, errors, AIR
│   └── reference/                     # Hand-written per-resource endpoint docs
├── .vitepress/
│   ├── config.mts                     # Nav, sidebar, plugins
│   └── theme/
│       ├── components/                # AuthBar, RecipeRun, ResultViewer
│       └── composables/               # useAuthToken, useWorkflow
├── scripts/copy-spec.mjs             # OpenAPI spec sync script
├── public/openapi/                    # Spec destination (gitignored)
├── Dockerfile                         # Multi-stage build for production
└── nginx.conf                         # cleanUrls routing + caching

Interactive features

Recipe pages include Try It widgets (<RecipeRun>) that let readers preview cost, submit real workflows, and see results inline. Set an API token via the Token button in the navbar.

The API reference uses vitepress-openapi for interactive playgrounds on each operation page.

OpenAPI spec sync

The spec at public/openapi/v2-consumers.json is gitignored and resolved at dev/build time by scripts/copy-spec.mjs:

1. Sibling repo: ../../civitai-orchestration/repo/src/.../wwwroot/openapi/v2-consumers.json
2. Fallback: https://orchestration.civitai.com/openapi/v2-consumers.json

To refresh manually:

npm run copy:spec

Adding a new section

1. Create a top-level directory (e.g. signals/)
2. Add sidebar and nav entries in .vitepress/config.mts
3. Add a feature card to index.md

Testing interactive samples

<ApiTry> widgets (site docs) and <RecipeRun> widgets (orchestrator recipes) can be exercised against the live APIs via:

CIVITAI_TOKEN=your-token npm run test:samples           # all
CIVITAI_TOKEN=your-token npm run test:samples:site      # /site only
CIVITAI_TOKEN=your-token npm run test:samples:orch      # /orchestration/recipes only

Orchestrator samples are submitted with ?whatif=true — no Buzz is spent and no jobs actually run. Site samples are plain GETs. CI runs this on every PR that touches the samples and on a daily cron (see .github/workflows/test-samples.yml) so API drift surfaces even when docs don't change.

Skipping a known-broken sample

When a sample is intentionally broken (orchestrator-side bug, placeholder URL awaiting a real asset, etc.), precede the widget with a <!-- test-skip: --> HTML comment on the line immediately before it:

<!-- test-skip: editVideo whatif returns empty-body 500 — unskip once fixed -->
<RecipeRun :body="editBody" />

The widget still renders in the docs, but the test script reports it as skipped (with the reason) instead of failing. Skipped samples are listed in the test summary as a reminder to revisit.

License

Proprietary. Copyright Civitai.