OpenAPI reference
The machine-readable contract is an OpenAPI 3.1 document:
- Browse it: Interactive reference
- Download it:
/openapi.json - Live copy served by the API itself:
https://app.atlahq.com/api/v1/openapi.json
It lists exactly the routes an API key can reach, with every parameter, request body and response schema. Anything not in it is not part of the public contract.
Generate a client
Any OpenAPI tool works. For example, with openapi-typescript:
npx openapi-typescript https://app.atlahq.com/api/v1/openapi.json -o atla-api.d.ts
Or import the JSON into Postman, Insomnia or Bruno: each reads OpenAPI 3.1 directly and will prompt for the bearer token.
Keeping up
The document carries info.version. It only ever gains fields and routes within /api/v1; see the
API changelog for what changed and when.