Skip to main content

​
Client API OpenAPI Contract

​
Canonical endpoint

GET https://api.omnibrief.app/v1/openapi.json
The OpenAPI schema published here is the source of truth for generated endpoint reference and SDK workflows.

​
Docs-generated reference (interactive)

This docs site renders an interactive endpoint reference from OpenAPI under:
  • Client API (Generated) in the left navigation
The generated reference is backed by the snapshot contract file:
  • openapi/omni-client-api.v1.json

​
Usage

curl "https://api.omnibrief.app/v1/openapi.json" \
  -H "Authorization: Bearer omni_live_..."

​
Contract governance

  1. Additive changes are allowed without version pin updates.
  2. Behavioral or breaking changes require changelog entries and migration notes.
  3. Deprecated endpoints must include replacement references and sunset dates.

​
What the schema includes

  • All /v1/* Client API routes
  • Request and response models
  • Error response schema
  • Authentication requirements

​
Relationship to docs

Narrative docs remain human-authored. Schema-heavy reference sections should be generated or validated from openapi.json to prevent drift.