Docs

API conventions

Request correlation

API conventions

Request correlation

  • every response includes `Request-Id`
  • callers can provide `x-request-id` to make local benchmarking and smoke output deterministic

Metering

  • API responses include `Omni-Meter-Class`
  • this is the canonical hint for billing/quota classification in logs, smoke output, and reconciliation jobs

Error model

Error responses use a stable JSON shape:

{
  "object": "error",
  "id": "err_...",
  "code": "ownership_lookup_failed",
  "type": "api_error",
  "message": "Human-readable explanation",
  "requestId": "req_...",
  "details": {}
}

Auth conventions

  • machine access uses `x-api-key`
  • MCP protected-resource metadata is available before WorkOS is fully configured
  • OAuth authorization-server metadata intentionally returns an explicit `503 workos_authorization_server_unavailable` until real WorkOS values are present