OpenAPI specification

Goal

Obtain the machine-readable OpenAPI 3 document for Public API v1.

Who it is for

Integrators.

Steps

1. Download the YAML: public-api-v1-openapi.yaml
2. Import it into your API client (Insomnia, Postman, openapi-generator, etc.).
3. Read human notes in Public API v1 and the narrative reference.

Result

Your client stubs and tests match the shipped contract.

Note

The YAML in Help Center is copied from docs/product-readiness/public-api-v1-openapi.yaml. When the API contract changes, update both in the same change set.