Preview — not for production reliance
Documentation

Docs API reference

Documentation

This document.

1 operation. See the API overview for authentication, errors, idempotency and caching rules that apply to all of them.

This OpenAPI document

GET/v1/openapi.yaml

Authentication
Public, no credentials
Operation ID
getOpenApiDocument

The public OpenAPI 3.1 description of the directory and organization APIs.

Responses

StatusDescriptionBody
200The OpenAPI document.
Headers: Cache-Control: public, max-age=3600
application/yaml string
404not_found. No such resource, or one the caller may not see (the two are indistinguishable by design).application/json Error

404 example

json
{
  "code": "not_found",
  "message": "No such resource.",
  "request_id": "req_3m6p9s2v5y8b1e4h7k0n3q6t9w"
}