OpenAPI reference

The human docs explain how to integrate. The OpenAPI YAML is the canonical machine-readable contract.

Local spec

The repository copy lives at docs/external-api-v1.openapi.yaml.

Public download

Download the currently deployed API contract.

Current public endpoints

Path	Purpose
`/api/v1/source-assets`	Create a source asset ingest job.
`/api/v1/source-assets/{ingest_id}`	Read a source asset ingest job.
`/api/v1/generations`	Create a generation job.
`/api/v1/generations/{job_id}`	Read a generation job.
`/api/v1/generations/{job_id}/regenerate`	Create a new job from the same source asset.
`/api/v1/usage/summary`	Read the current billing-period summary.
`/api/v1/billing/events`	Read the API billing ledger.
`/api/v1/openapi`	Download the YAML spec.

Keep docs aligned

If the request or response model changes, update docs/external-api-v1.openapi.yaml first, then update the human guide pages that explain the integration flow.

Getting Started

API

Operations

Reference

Local spec

Public download

Current public endpoints

Keep docs aligned

Local spec

Public download

​Current public endpoints

​Keep docs aligned

Current public endpoints

Keep docs aligned