Docs pageResources › OpenAPI file

OpenAPI file

The whole API as an OpenAPI 3.1 document, for generating a client or importing into Postman or Insomnia.

The file

/api/openapi.json describes the whole API in OpenAPI 3.1: every endpoint, its parameters, its answers with examples, the errors and the headers. Each endpoint’s credits are in x-credits.

It’s built from the same definitions as these pages, so the two always match.

Use it

Postman or Insomnia: import it from the link https://www.cubdomain.com/api/openapi.json, then set your key as the Bearer token.
Types and clients: generate them with openapi-typescript, openapi-python-client or OpenAPI Generator. The samples show how.