Download this API description as JSON
/v1/openapi.jsonReturns the machine-readable description of this API, the OpenAPI 3.1 document this page is drawn from, as JSON. Use it to generate a client library, to import the API into a tool such as Postman, or to check which version of the API you are talking to. The answer is the OpenAPI document itself and is not wrapped in {data, meta, links}.
There is nothing to send except an optional If-None-Match.
What comes back: a JSON object with openapi (the OpenAPI version the document follows), info (title, version and the introduction shown at the top of this page), paths (every endpoint), components (the shared parameters, headers, responses and schemas) and the other standard OpenAPI members.
Response
The OpenAPI document as JSON. It is not wrapped in the response envelope.
| Field | Type | Description |
|---|---|---|
| info | object | The API's title, version, summary and introduction. |
| openapi | string | The version of the OpenAPI specification the document follows. |
| paths | object | Every endpoint of the API, keyed by path. |
Cost
0 credits. The request still counts toward your per-IP rate limit.
Errors
| Status | Code |
|---|---|
| 400 | invalid_query |
| 429 | rate_limited |
| 500 | internal |
400 invalid_query if you add a query string. 429 rate_limited if you send requests faster than your rate limit allows.