Skip to content

JSON Schemas

These canonical files are generated from the installed Pydantic models. The docs test suite regenerates each file in memory and fails on any byte-level drift.

The configuration schema uses Pydantic serialization mode. Credential fields and the callable token provider are excluded because they cannot be persisted. Use the configuration guide for environment-only fields and precedence.

Regenerate or verify the files from a source checkout:

uv run python scripts/generate_docs_reference.py
uv run python scripts/generate_docs_reference.py --check

The CLI also exports the canonical routing schema to standard output:

survey-scribe schema export routing > questionnaire-routing.schema.json