OpenAPI Specification

Every Dyrected project generates an OpenAPI document from its current content model.

Accessing the specification

GET /api/openapi.json

Use the runtime document for client generation and validation because it contains your actual collection slugs, fields, access-oriented route families, globals, uploads, and workflows.

The documentation site also publishes a representative OpenAPI document built from a maximal fixture. It is useful for tooling tests and general route discovery, but it is not your project's schema.

Interactive documentation

GET /api/docs

The interactive UI executes real requests against the application. Use non-production credentials and least-privilege test users when exploring mutation routes.

Workflows and generated schemas

Workflow-enabled collections add transition and history operations with their request and response schemas. Upload, auth, preference, preview, and dynamic-option route families are also represented when enabled by the configuration.

Why use OpenAPI?

• Generate clients for languages not covered by the TypeScript SDK.
• Validate integration requests in tests and gateways.
• Give development tools an exact, project-specific API contract.
• Detect route or schema drift during deployment.

Regenerate clients when the content contract changes. Do not treat an old downloaded specification as permanently compatible.

Generated representative facts

The representative document currently contains 49 operations. Use the runtime document for client generation because its schemas reflect your own collections and globals.