APIAPI

Production API reference map

Human orientation for the canonical production surface. The generated API reference and OpenAPI contract remain the exact machine authority.

API / MCP maturity

The public documentation is shareable, but API and MCP capability availability is governed by the live product manifest and account access. Foundation or experimental operations are not stability promises.

MethodEndpointAuthorityPurpose
GET/api/v1/product/manifestreadProduct truth and maturity
GET/api/v1/openapireadMachine-readable API contract
GET/api/v1/production/capabilitiesreadDiscover available production capabilities
GET/api/v1/production/verticalsreadList production recipes
POST/api/v1/production/plansplanCompile a non-spending production plan
POST/api/v1/production/plans/:planId/preflightreadValidate readiness before execution
POST/api/v1/production/plans/:planId/storyboard/applymutateApply an approved Storyboard plan
POST/api/v1/production/plans/:planId/steps/:stepId/executespendExecute one confirmed plan step
POST/api/v1/production/plans/:planId/generatespendStart confirmed durable production
GET/api/v1/production/jobs/:jobIdreadRead durable job status
GET/api/v1/production/plans/:planId/ledgerreadRead the execution ledger

Use the generated contract for field-level truth

This page explains intent and authority. For exact request schemas, response schemas and currently published operations, use /api/v1/docs and /api/v1/openapi.

Treat errors as state, not prose

Handle machine-readable error codes and HTTP status. Typical boundaries include authentication, forbidden project access, invalid project identity, missing idempotency, insufficient credits, preflight blockers, rate limiting and infrastructure/provider failures.

Read operations may be retried carefully

Production transport currently rate-limits authenticated actors and distinguishes retryable read failures from operations that must never be blindly replayed.

Workspace · Project · Asset · Entity · Storyboard · Plan · JobGenerated ≠ Certified