Skip to main content
The generated endpoint pages in this section are the complete public REST reference. They are built from the same live OpenAPI specification as the running API.

​
Spec URL

The specification defines the documented paths, authentication, request fields, response schemas, and error codes. Beta operations are labeled in the reference. Base URL:

​
Errors

Failed REST responses contain an error object with code, status, and message. Use the stable code to decide retries and recovery; message is human-readable. Each generated endpoint reference lists its error codes.

​
What you can do with it

  • Generate a typed SDK with openapi-typescript, OpenAPI Generator, or another OpenAPI tool.
  • Import the API into Postman, HTTPie, or Insomnia.
  • Give the specification to an agent that needs the exact REST contract.
  • Compare a generated client with the live schema in continuous integration.

​
Quick example

Generate TypeScript types directly from the live spec:
Or save the spec locally to inspect or feed into another tool:
The spec follows OpenAPI 3.1.1. Start with the API quickstart for an end-to-end request or API authentication for credential details.