# Endpoint catalogue — OpenAI + Anthropic + xAI + Gemini (rendered from `generated/endpoints.json`) **Status:** generated from `generated/endpoints.json` (870 endpoint records: OpenAI 359, Anthropic 282, xAI 104, Gemini 125). Each row carries the statuses recorded by the domain agents; “Verification” is the record's `verification` block (method · result · HTTP). This page is the human twin of `generated/endpoints.csv`; a status-grouped view is in [by-status.md](by-status.md). **Sources:** per record `sources[]` in `generated/endpoints.json` (OpenAI reference https://developers.openai.com/api/reference/… and OpenAPI `sources/openai/openapi/openapi-master.yaml`; Anthropic reference https://platform.claude.com/docs/en/api/…; xAI reference https://docs.x.ai/developers/rest-api-reference/… and OpenAPI `sources/xai/openapi/openapi.json`; Gemini reference https://ai.google.dev/api/… and discovery documents `sources/gemini/openapi/discovery-v1beta.json` / `discovery-v1.json`). **Last verified:** 2026-09-18 ## Legend | Column | Meaning | |---|---| | Status | atlas vocabulary: `DOCUMENTED` in current docs · `LIVE_VERIFIED` called successfully with our key · `LIVE_DISCOVERED` seen live, weak docs · `BETA`/`PREVIEW` gated or pre-GA · `GA` (Gemini fragments only: explicitly marked generally available) · `LEGACY` maintained but superseded · `DEPRECATED` retirement announced · `RETIRED` gone · `ACCOUNT_RESTRICTED` documented, our key got 401/403/404-for-access (xAI: Management API key we do not have, ACL-gated models; Gemini: paid-tier-only models on a free-tier key) · `UNVERIFIED` not tried · `FAILED_VERIFICATION` tried, unexpected failure · `DOCUMENTATION_INCOMPLETE` reference lacks a shape | | Auth | credential accepted: OpenAI Bearer project/Admin key; Anthropic `x-api-key` or Bearer, Admin/Compliance keys, cloud IAM; xAI `Authorization: Bearer xai-…` (inference key) or a **Management key** for `management-api.x.ai`; Gemini `x-goog-api-key` (never in the URL) or OAuth Bearer, `Authorization: Bearer ` on `/v1beta/openai/*` | | Beta header | header value required to reach the surface (`OpenAI-Beta: …` or `anthropic-beta: …`); `—` = none. xAI has **no** version or beta headers; Gemini gates features by **URL version** (`/v1beta` vs `/v1`) and `-preview` model ids, not by header | | Verification | `live_api · success · HTTP 200` = exercised; `docs_only` = not called in this run; `restricted` = 401/403 (or access-404) with our key; `failure` = call made, unexpected status (see record `request_note`); `not_tested` = Gemini/xAI records deliberately skipped (cost, destructive, needs a peer) | ### Status totals (a record may carry several statuses) | Status | Total | OpenAI | Anthropic | xAI | Gemini | |---|---|---|---|---|---| | `DOCUMENTED` | 862 | 357 | 282 | 103 | 120 | | `LIVE_VERIFIED` | 269 | 123 | 47 | 53 | 46 | | `BETA` | 214 | 56 | 111 | 0 | 47 | | `ACCOUNT_RESTRICTED` | 126 | 18 | 59 | 41 | 8 | | `UNVERIFIED` | 75 | 34 | 24 | 4 | 13 | | `DEPRECATED` | 39 | 35 | 1 | 2 | 1 | | `PREVIEW` | 39 | 0 | 0 | 0 | 39 | | `LEGACY` | 33 | 4 | 4 | 3 | 22 | | `RETIRED` | 31 | 24 | 0 | 2 | 5 | | `LIVE_DISCOVERED` | 25 | 10 | 0 | 12 | 3 | | `FAILED_VERIFICATION` | 23 | 10 | 3 | 4 | 6 | | `DOCUMENTATION_INCOMPLETE` | 8 | 0 | 4 | 0 | 4 | | `GA` | 4 | 0 | 0 | 0 | 4 | ## Counts per provider → api_family | Provider | api_family | Endpoints | LIVE_VERIFIED | ACCOUNT_RESTRICTED | BETA / PREVIEW | DEPRECATED/RETIRED | |---|---|---|---|---|---|---| | openai | `admin` | 124 | 0 | 14 | 0 | 0 | | openai | `agents-platform/agents` | 34 | 21 | 0 | 34 | 0 | | openai | `agents-platform/assistants` | 23 | 0 | 0 | 0 | 23 | | openai | `agents-platform/chatkit` | 6 | 1 | 0 | 6 | 0 | | openai | `agents-platform/vaults` | 9 | 1 | 0 | 9 | 0 | | openai | `agents-platform/workspace-agents` | 2 | 0 | 0 | 2 | 0 | | openai | `audio` | 10 | 3 | 1 | 0 | 0 | | openai | `auth` | 2 | 0 | 0 | 0 | 0 | | openai | `batches` | 4 | 3 | 0 | 0 | 0 | | openai | `chat-audio` | 1 | 0 | 0 | 0 | 0 | | openai | `chat_completions` | 6 | 6 | 0 | 0 | 0 | | openai | `completions` | 1 | 1 | 0 | 0 | 0 | | openai | `containers` | 9 | 9 | 0 | 0 | 0 | | openai | `content_provenance` | 1 | 1 | 0 | 0 | 0 | | openai | `conversations` | 8 | 8 | 0 | 0 | 0 | | openai | `embeddings` | 1 | 1 | 0 | 0 | 0 | | openai | `evals` | 12 | 12 | 0 | 0 | 12 | | openai | `files` | 5 | 5 | 0 | 0 | 0 | | openai | `fine_tuning` | 11 | 5 | 2 | 0 | 11 | | openai | `graders` | 2 | 2 | 0 | 2 | 2 | | openai | `images` | 3 | 1 | 0 | 0 | 1 | | openai | `live` | 10 | 0 | 0 | 0 | 0 | | openai | `moderations` | 1 | 1 | 0 | 0 | 0 | | openai | `realtime` | 14 | 3 | 0 | 2 | 0 | | openai | `responses` | 9 | 8 | 0 | 1 | 0 | | openai | `safety` | 2 | 1 | 1 | 0 | 0 | | openai | `skills` | 11 | 6 | 0 | 0 | 0 | | openai | `uploads` | 4 | 4 | 0 | 0 | 0 | | openai | `vector_stores` | 16 | 15 | 0 | 0 | 0 | | openai | `videos` | 10 | 3 | 0 | 0 | 10 | | openai | `webhooks` | 8 | 2 | 0 | 0 | 0 | | **openai total** | 31 families | **359** | 123 | 18 | 56 | 59 | | anthropic | `admin` | 100 | 1 | 22 | 11 | 0 | | anthropic | `cloud:bedrock` | 6 | 0 | 0 | 0 | 0 | | anthropic | `cloud:claude_platform_on_aws` | 12 | 0 | 0 | 2 | 0 | | anthropic | `cloud:microsoft_foundry` | 3 | 0 | 0 | 1 | 0 | | anthropic | `cloud:vertex_ai` | 3 | 0 | 0 | 0 | 0 | | anthropic | `completions` | 1 | 0 | 0 | 0 | 1 | | anthropic | `compliance` | 36 | 0 | 36 | 0 | 0 | | anthropic | `files` | 5 | 5 | 0 | 0 | 0 | | anthropic | `managed-agents` | 96 | 21 | 1 | 96 | 0 | | anthropic | `messages` | 3 | 3 | 0 | 1 | 0 | | anthropic | `messages-batches` | 6 | 6 | 0 | 0 | 0 | | anthropic | `models` | 2 | 2 | 0 | 0 | 0 | | anthropic | `skills` | 9 | 9 | 0 | 0 | 0 | | **anthropic total** | 13 families | **282** | 47 | 59 | 111 | 1 | | xai | `account` | 3 | 3 | 0 | 0 | 0 | | xai | `batches` | 8 | 7 | 0 | 0 | 0 | | xai | `chat_completions` | 2 | 2 | 0 | 0 | 0 | | xai | `collections` | 13 | 9 | 11 | 0 | 0 | | xai | `embeddings` | 1 | 0 | 1 | 0 | 0 | | xai | `files` | 10 | 7 | 0 | 0 | 0 | | xai | `images` | 2 | 2 | 0 | 0 | 0 | | xai | `legacy` | 2 | 0 | 0 | 0 | 2 | | xai | `management` | 21 | 0 | 21 | 0 | 0 | | xai | `messages_compat` | 1 | 1 | 0 | 0 | 1 | | xai | `models` | 10 | 8 | 2 | 0 | 0 | | xai | `responses` | 5 | 5 | 0 | 0 | 0 | | xai | `skills` | 5 | 0 | 5 | 0 | 0 | | xai | `videos` | 4 | 2 | 0 | 0 | 0 | | xai | `voice` | 17 | 7 | 1 | 0 | 0 | | **xai total** | 15 families | **104** | 53 | 41 | 0 | 3 | | gemini | `agents` | 4 | 0 | 0 | 4 | 0 | | gemini | `auth-tokens` | 1 | 1 | 0 | 1 | 0 | | gemini | `batch` | 9 | 1 | 2 | 0 | 0 | | gemini | `caching` | 5 | 0 | 5 | 5 | 0 | | gemini | `credentials` | 5 | 0 | 0 | 5 | 0 | | gemini | `dynamic` | 2 | 0 | 0 | 2 | 0 | | gemini | `embeddings` | 2 | 2 | 0 | 0 | 0 | | gemini | `environments` | 7 | 5 | 0 | 7 | 0 | | gemini | `file-search` | 12 | 9 | 0 | 12 | 0 | | gemini | `files` | 8 | 6 | 0 | 0 | 0 | | gemini | `generate-content` | 4 | 2 | 0 | 0 | 0 | | gemini | `image-generation` | 1 | 0 | 0 | 0 | 1 | | gemini | `interactions` | 9 | 4 | 0 | 4 | 0 | | gemini | `legacy-palm` | 7 | 1 | 0 | 0 | 0 | | gemini | `live` | 3 | 3 | 0 | 2 | 0 | | gemini | `models` | 3 | 3 | 0 | 0 | 0 | | gemini | `music-generation` | 1 | 1 | 0 | 1 | 0 | | gemini | `openai-compat` | 7 | 3 | 0 | 7 | 0 | | gemini | `operations` | 6 | 3 | 1 | 0 | 0 | | gemini | `tokens` | 1 | 1 | 0 | 0 | 0 | | gemini | `transcription` | 1 | 1 | 0 | 0 | 0 | | gemini | `triggers` | 7 | 0 | 0 | 7 | 0 | | gemini | `tuning` | 12 | 0 | 0 | 0 | 4 | | gemini | `video-generation` | 1 | 0 | 0 | 1 | 0 | | gemini | `webhooks` | 7 | 0 | 0 | 6 | 0 | | **gemini total** | 25 families | **125** | 46 | 8 | 64 | 5 | | **all providers** | 84 families | **870** | 269 | 126 | 231 | 68 | ### Reading the four surfaces | Provider | Base URL(s) | Path style | Families worth knowing | |---|---|---|---| | openai | `https://api.openai.com/v1` (+ regional `us.|eu.|au.|jp.|in.api.openai.com`, `api.chatgpt.com` for workspace agents) | REST nouns (`/v1/responses`, `/v1/agents/sessions`), WebSocket `wss://api.openai.com/v1/{responses,realtime}` | `responses`, `chat_completions`, `agents-platform/*`, `realtime`, `live`, `admin` (124) | | anthropic | `https://api.anthropic.com/v1` (+ Bedrock, Vertex, Foundry, Claude Platform on AWS hosts under `cloud:*`) | REST nouns (`/v1/messages`, `/v1/sessions`), beta surfaces gated by `anthropic-beta` | `messages`, `messages-batches`, `managed-agents` (96), `admin` (100), `compliance` (36) | | xai | `https://api.x.ai/v1` (global), `https://us.api.x.ai/v1` (US-pinned, grok-4.6, 1.1× price), `https://eu-west-1.api.x.ai/v1` (LIVE_DISCOVERED), `https://management-api.x.ai` (separate key), gRPC `api.x.ai:443` | OpenAI-shaped REST (`/v1/responses`, `/v1/chat/completions`, `/v1/batches`) + Anthropic-shaped `/v1/messages`; WebSocket `wss://api.x.ai/v1/{realtime,stt,tts}` | `responses`, `chat_completions` (LEGACY), `collections`, `files`, `voice` (17), `management` (21, ACCOUNT_RESTRICTED) | | gemini | `https://generativelanguage.googleapis.com/v1beta` (also `/v1` stable subset, `/upload/v1beta/*` resumable uploads, `/v1beta/openai/*` compatibility layer), WebSocket `wss://generativelanguage.googleapis.com/ws/google.ai.generativelanguage.v1beta.GenerativeService.BidiGenerateContent` | Google RPC-style verbs on resources (`/v1beta/models/{model}:generateContent`, `:streamGenerateContent`, `:countTokens`, `:embedContent`, `:predictLongRunning`), resource collections (`/v1beta/cachedContents`, `/v1beta/fileSearchStores`, `/v1beta/interactions`, `/v1beta/batches`) | `generate-content`, `interactions`, `live`, `file-search` (12), `tuning` (12, RETIRED/LEGACY), `legacy-palm` (7), `openai-compat` (7) | # OpenAI endpoints (359) ## openai · `admin` (124) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/organization/admin_api_keys` | List all organization and project API keys. | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | bearer / admin_api_key | — | live_api · restricted · HTTP 403 | | `POST` | `/v1/organization/admin_api_keys` | Create admin API key | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/admin_api_keys/{key_id}` | Retrieve admin API key | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/admin_api_keys/{key_id}` | Delete admin API key | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/audit_logs` | List audit logs | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | bearer / admin_api_key | — | live_api · restricted · HTTP 401 | | `GET` | `/v1/organization/certificates` | List organization certificates | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | bearer / admin_api_key | — | live_api · restricted · HTTP 403 | | `POST` | `/v1/organization/certificates` | Upload certificate | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/certificates/activate` | Activate certificates for organization | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/certificates/deactivate` | Deactivate certificates for organization | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/certificates/{certificate_id}` | Get certificate | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/certificates/{certificate_id}` | Modify certificate | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/certificates/{certificate_id}` | Delete certificate | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/costs` | Costs | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | bearer / admin_api_key | — | live_api · restricted · HTTP 403 | | `GET` | `/v1/organization/data_retention` | Retrieve organization data retention | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | bearer / admin_api_key | — | live_api · restricted · HTTP 403 | | `POST` | `/v1/organization/data_retention` | Update organization data retention | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/external_storage` | List external storage configurations | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | bearer / admin_api_key | — | live_api · restricted · HTTP 403 | | `POST` | `/v1/organization/external_storage` | Create an external storage configuration | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/external_storage/{external_storage_id}` | Get an external storage configuration | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/external_storage/{external_storage_id}` | Delete an external storage configuration | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/external_storage/{external_storage_id}/validate` | Validate an external storage configuration | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/groups` | List groups | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | bearer / admin_api_key | — | live_api · restricted · HTTP 403 | | `POST` | `/v1/organization/groups` | Create group | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/groups/{group_id}` | Retrieve group | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/groups/{group_id}` | Update group | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/groups/{group_id}` | Delete group | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/groups/{group_id}/roles` | List group organization role assignments | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/groups/{group_id}/roles` | Assign organization role to group | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/groups/{group_id}/roles/{role_id}` | Retrieve group organization role | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/groups/{group_id}/roles/{role_id}` | Unassign organization role from group | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/groups/{group_id}/users` | List group users | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/groups/{group_id}/users` | Add group user | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/groups/{group_id}/users/{user_id}` | Retrieve group user | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/groups/{group_id}/users/{user_id}` | Remove group user | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/invites` | List invites | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | bearer / admin_api_key | — | live_api · restricted · HTTP 403 | | `POST` | `/v1/organization/invites` | Create invite | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/invites/{invite_id}` | Retrieve invite | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/invites/{invite_id}` | Delete invite | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects` | List projects | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | bearer / admin_api_key | — | live_api · restricted · HTTP 403 | | `POST` | `/v1/organization/projects` | Create project | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}` | Retrieve project | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}` | Modify project | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/api_keys` | List project API keys | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/api_keys/{api_key_id}` | Retrieve project API key | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/projects/{project_id}/api_keys/{api_key_id}` | Delete project API key | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/archive` | Archive project | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/certificates` | List project certificates | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/certificates/activate` | Activate certificates for project | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/certificates/deactivate` | Deactivate certificates for project | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/data_retention` | Retrieve project data retention | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/data_retention` | Update project data retention | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/groups` | List project groups | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/groups` | Add project group | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/groups/{group_id}` | Retrieve project group | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/projects/{project_id}/groups/{group_id}` | Remove project group | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/hosted_tool_permissions` | Retrieve project hosted tool permissions | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/hosted_tool_permissions` | Modify project hosted tool permissions | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/model_permissions` | Retrieve project model permissions | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/model_permissions` | Modify project model permissions | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/projects/{project_id}/model_permissions` | Delete project model permissions | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/rate_limits` | List project rate limits | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/rate_limits/{rate_limit_id}` | Modify project rate limit | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/service_accounts` | List project service accounts | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/service_accounts` | Create project service account | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/service_accounts/{service_account_id}` | Retrieve project service account | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/service_accounts/{service_account_id}` | Update project service account | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/projects/{project_id}/service_accounts/{service_account_id}` | Delete project service account | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys` | Create an API key for a service account | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/spend_alerts` | List project spend alerts | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/spend_alerts` | Create project spend alert | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/spend_alerts/{alert_id}` | Retrieve project spend alert | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/spend_alerts/{alert_id}` | Update project spend alert | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/projects/{project_id}/spend_alerts/{alert_id}` | Delete project spend alert | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/spend_limit` | Get project spend limit | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/spend_limit` | Update project spend limit | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/projects/{project_id}/spend_limit` | Delete project spend limit | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/users` | List project users | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/users` | Create project user | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/projects/{project_id}/users/{user_id}` | Retrieve project user | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/projects/{project_id}/users/{user_id}` | Modify project user | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/projects/{project_id}/users/{user_id}` | Delete project user | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/roles` | List organization roles | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | bearer / admin_api_key | — | live_api · restricted · HTTP 403 | | `POST` | `/v1/organization/roles` | Create organization role | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/roles/{role_id}` | Retrieve organization role | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/roles/{role_id}` | Update organization role | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/roles/{role_id}` | Delete organization role | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/spend_alerts` | List organization spend alerts | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | bearer / admin_api_key | — | live_api · restricted · HTTP 403 | | `POST` | `/v1/organization/spend_alerts` | Create organization spend alert | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/spend_alerts/{alert_id}` | Retrieve organization spend alert | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/spend_alerts/{alert_id}` | Update organization spend alert | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/spend_alerts/{alert_id}` | Delete organization spend alert | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/spend_limit` | Get organization spend limit | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | bearer / admin_api_key | — | live_api · restricted · HTTP 403 | | `POST` | `/v1/organization/spend_limit` | Update organization spend limit | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/spend_limit` | Delete organization spend limit | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/usage/audio_speeches` | Audio speeches | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/usage/audio_transcriptions` | Audio transcriptions | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/usage/code_interpreter_sessions` | Code interpreter sessions | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/usage/completions` | Completions | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | bearer / admin_api_key | — | live_api · restricted · HTTP 403 | | `GET` | `/v1/organization/usage/embeddings` | Embeddings | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/usage/file_search_calls` | File search calls | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/usage/images` | Images | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/usage/moderations` | Moderations | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/usage/vector_stores` | Vector stores | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/usage/web_search_calls` | Web search calls | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/users` | List users | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | bearer / admin_api_key | — | live_api · restricted · HTTP 403 | | `GET` | `/v1/organization/users/{user_id}` | Retrieve user | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/users/{user_id}` | Modify user | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/users/{user_id}` | Delete user | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/users/{user_id}/roles` | List user organization role assignments | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/organization/users/{user_id}/roles` | Assign organization role to user | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/organization/users/{user_id}/roles/{role_id}` | Retrieve user organization role | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/organization/users/{user_id}/roles/{role_id}` | Unassign organization role from user | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/projects/{project_id}/groups/{group_id}/roles` | List project group role assignments | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/projects/{project_id}/groups/{group_id}/roles` | Assign project role to group | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/projects/{project_id}/groups/{group_id}/roles/{role_id}` | Retrieve project group role | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/projects/{project_id}/groups/{group_id}/roles/{role_id}` | Unassign project role from group | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/projects/{project_id}/roles` | List project roles | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/projects/{project_id}/roles` | Create project role | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/projects/{project_id}/roles/{role_id}` | Retrieve project role | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/projects/{project_id}/roles/{role_id}` | Update project role | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/projects/{project_id}/roles/{role_id}` | Delete project role | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/projects/{project_id}/users/{user_id}/roles` | List project user role assignments | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `POST` | `/v1/projects/{project_id}/users/{user_id}/roles` | Assign project role to user | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `GET` | `/v1/projects/{project_id}/users/{user_id}/roles/{role_id}` | Retrieve project user role | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | | `DELETE` | `/v1/projects/{project_id}/users/{user_id}/roles/{role_id}` | Unassign project role from user | `DOCUMENTED` | bearer / admin_api_key | — | docs_only · not_tested | ## openai · `agents-platform/agents` (34) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/agents` | listAgents | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `POST` | `/v1/agents` | createAgent | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 201 | | `GET` | `/v1/agents/environments/templates` | listAgentEnvironmentTemplates | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `POST` | `/v1/agents/environments/templates` | createAgentEnvironmentTemplate | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 201 | | `GET` | `/v1/agents/environments/templates/{environment_template_id}` | retrieveAgentEnvironmentTemplate | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `POST` | `/v1/agents/environments/templates/{environment_template_id}` | updateAgentEnvironmentTemplate | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `DELETE` | `/v1/agents/environments/templates/{environment_template_id}` | deleteAgentEnvironmentTemplate | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `GET` | `/v1/agents/environments/{environment_id}` | retrieveAgentEnvironment | `DOCUMENTED` · `BETA` · `LIVE_DISCOVERED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 404 | | `GET` | `/v1/agents/environments/{environment_id}/files` | listAgentEnvironmentFiles | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | docs only | | `POST` | `/v1/agents/environments/{environment_id}/files` | createAgentEnvironmentFile | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | docs only | | `GET` | `/v1/agents/sessions` | listAgentSessions | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `POST` | `/v1/agents/sessions` | createAgentSession | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 201 | | `GET` | `/v1/agents/sessions/{session_id}` | retrieveAgentSession | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `POST` | `/v1/agents/sessions/{session_id}` | updateAgentSession | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `DELETE` | `/v1/agents/sessions/{session_id}` | deleteAgentSession | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `GET` | `/v1/agents/sessions/{session_id}/artifacts` | listAgentSessionArtifacts | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `GET` | `/v1/agents/sessions/{session_id}/artifacts/{artifact_id}` | retrieveAgentSessionArtifact | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | docs only | | `DELETE` | `/v1/agents/sessions/{session_id}/artifacts/{artifact_id}` | deleteAgentSessionArtifact | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | docs only | | `GET` | `/v1/agents/sessions/{session_id}/artifacts/{artifact_id}/content` | retrieveAgentSessionArtifactContent | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | docs only | | `GET` | `/v1/agents/sessions/{session_id}/events` | listAgentSessionEvents | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `POST` | `/v1/agents/sessions/{session_id}/events` | createAgentSessionEvents | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 202 | | `GET` | `/v1/agents/sessions/{session_id}/items` | listAgentSessionItems | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `GET` | `/v1/agents/sessions/{session_id}/subagents` | listAgentSessionSubagents | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `GET` | `/v1/agents/sessions/{session_id}/subagents/{subagent_id}` | retrieveAgentSessionSubagent | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | docs only | | `GET` | `/v1/agents/sessions/{session_id}/subagents/{subagent_id}/items` | listAgentSessionSubagentItems | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | docs only | | `GET` | `/v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns` | listAgentSessionSubagentTurns | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | docs only | | `GET` | `/v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}` | retrieveAgentSessionSubagentTurn | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | docs only | | `GET` | `/v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}/items` | listAgentSessionSubagentTurnItems | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | docs only | | `GET` | `/v1/agents/sessions/{session_id}/traces` | listAgentSessionTraces (docs-only) | `DOCUMENTED` · `BETA` · `LIVE_DISCOVERED` | Bearer API key (api.traces.read or api.agents.read) | OpenAI-Beta: agents=v1 | live_api · success · HTTP 404 | | `GET` | `/v1/agents/sessions/{session_id}/turns` | listAgentSessionTurns | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `GET` | `/v1/agents/sessions/{session_id}/turns/{turn_id}` | retrieveAgentSessionTurn | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `GET` | `/v1/agents/{agent_id}` | retrieveAgent | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `POST` | `/v1/agents/{agent_id}` | updateAgent | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | docs only | | `DELETE` | `/v1/agents/{agent_id}` | deleteAgent | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.wr… | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | ## openai · `agents-platform/assistants` (23) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/assistants` | listAssistants | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | live_api · failure · HTTP 404 | | `POST` | `/v1/assistants` | createAssistant | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `GET` | `/v1/assistants/{assistant_id}` | getAssistant | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `POST` | `/v1/assistants/{assistant_id}` | modifyAssistant | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `DELETE` | `/v1/assistants/{assistant_id}` | deleteAssistant | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `POST` | `/v1/threads` | createThread | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `POST` | `/v1/threads/runs` | createThreadAndRun | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `GET` | `/v1/threads/{thread_id}` | getThread | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | live_api · failure · HTTP 404 | | `POST` | `/v1/threads/{thread_id}` | modifyThread | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `DELETE` | `/v1/threads/{thread_id}` | deleteThread | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `GET` | `/v1/threads/{thread_id}/messages` | listMessages | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `POST` | `/v1/threads/{thread_id}/messages` | createMessage | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `GET` | `/v1/threads/{thread_id}/messages/{message_id}` | getMessage | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `POST` | `/v1/threads/{thread_id}/messages/{message_id}` | modifyMessage | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `DELETE` | `/v1/threads/{thread_id}/messages/{message_id}` | deleteMessage | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `GET` | `/v1/threads/{thread_id}/runs` | listRuns | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `POST` | `/v1/threads/{thread_id}/runs` | createRun | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `GET` | `/v1/threads/{thread_id}/runs/{run_id}` | getRun | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `POST` | `/v1/threads/{thread_id}/runs/{run_id}` | modifyRun | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `POST` | `/v1/threads/{thread_id}/runs/{run_id}/cancel` | cancelRun | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `GET` | `/v1/threads/{thread_id}/runs/{run_id}/steps` | listRunSteps | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `GET` | `/v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}` | getRunStep | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | | `POST` | `/v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs` | submitToolOuputsToRun | `RETIRED` · `DOCUMENTED` | Bearer API key | OpenAI-Beta: assistants=v2 (historical) | docs_only · failure | ## openai · `agents-platform/chatkit` (6) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/chatkit/sessions` | CreateChatSessionMethod | `DOCUMENTED` · `BETA` | Bearer API key | OpenAI-Beta: chatkit_beta=v1 | docs only | | `POST` | `/v1/chatkit/sessions/{session_id}/cancel` | CancelChatSessionMethod | `DOCUMENTED` · `BETA` | Bearer API key | OpenAI-Beta: chatkit_beta=v1 | docs only | | `GET` | `/v1/chatkit/threads` | ListThreadsMethod | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key | OpenAI-Beta: chatkit_beta=v1 | live_api · success · HTTP 200 | | `GET` | `/v1/chatkit/threads/{thread_id}` | GetThreadMethod | `DOCUMENTED` · `BETA` · `LIVE_DISCOVERED` | Bearer API key | OpenAI-Beta: chatkit_beta=v1 | live_api · success · HTTP 404 | | `DELETE` | `/v1/chatkit/threads/{thread_id}` | DeleteThreadMethod | `DOCUMENTED` · `BETA` | Bearer API key | OpenAI-Beta: chatkit_beta=v1 | docs only | | `GET` | `/v1/chatkit/threads/{thread_id}/items` | ListThreadItemsMethod | `DOCUMENTED` · `BETA` | Bearer API key | OpenAI-Beta: chatkit_beta=v1 | docs only | ## openai · `agents-platform/vaults` (9) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/vaults` | listVaults | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write | OpenAI-Beta: agents=v1 | live_api · success · HTTP 200 | | `POST` | `/v1/vaults` | createVault | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write | OpenAI-Beta: agents=v1 | docs only | | `GET` | `/v1/vaults/{vault_id}` | retrieveVault | `DOCUMENTED` · `BETA` · `LIVE_DISCOVERED` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write | OpenAI-Beta: agents=v1 | live_api · success · HTTP 404 | | `DELETE` | `/v1/vaults/{vault_id}` | deleteVault | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write | OpenAI-Beta: agents=v1 | docs only | | `GET` | `/v1/vaults/{vault_id}/credentials` | listVaultCredentials | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write | OpenAI-Beta: agents=v1 | docs only | | `POST` | `/v1/vaults/{vault_id}/credentials` | createVaultCredential | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write | OpenAI-Beta: agents=v1 | docs only | | `GET` | `/v1/vaults/{vault_id}/credentials/{credential_id}` | retrieveVaultCredential | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write | OpenAI-Beta: agents=v1 | docs only | | `POST` | `/v1/vaults/{vault_id}/credentials/{credential_id}` | rotateVaultCredential | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write | OpenAI-Beta: agents=v1 | docs only | | `DELETE` | `/v1/vaults/{vault_id}/credentials/{credential_id}` | deleteVaultCredential | `DOCUMENTED` · `BETA` | Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write | OpenAI-Beta: agents=v1 | docs only | ## openai · `agents-platform/workspace-agents` (2) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/workspace_agents/{id}/runs/{run_id}` | retrieveWorkspaceAgentRun | `DOCUMENTED` · `BETA` · `UNVERIFIED` | Authorization: Bearer (ChatGPT Admin > Access tokens, scope "Workspace Agent… | OpenAI-Beta: workspace_agent_runs=v1 (required to get age… | docs_only · restricted | | `POST` | `/v1/workspace_agents/{id}/trigger` | triggerWorkspaceAgent | `DOCUMENTED` · `BETA` · `UNVERIFIED` | Authorization: Bearer (ChatGPT Admin > Access tokens, scope "Workspace Agent… | OpenAI-Beta: workspace_agent_runs=v1 (required to get age… | docs_only · restricted | ## openai · `audio` (10) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/audio/speech` | Create speech (TTS) | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer standard API key (server-side) | — | live_api · success · HTTP 200 | | `POST` | `/v1/audio/transcriptions` | Create transcription (STT) | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer standard API key (server-side) | — | live_api · success · HTTP 200 | | `POST` | `/v1/audio/translations` | Create translation (→ English) | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer standard API key (server-side) | — | live_api · success · HTTP 200 | | `GET` | `/v1/audio/voice_consents` | List voice consents | `DOCUMENTED` · `FAILED_VERIFICATION` | Bearer standard API key (server-side) | — | live_api · failure · HTTP 404 | | `POST` | `/v1/audio/voice_consents` | Create voice consent | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `GET` | `/v1/audio/voice_consents/{consent_id}` | Retrieve voice consent | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `POST` | `/v1/audio/voice_consents/{consent_id}` | Update voice consent (metadata) | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `DELETE` | `/v1/audio/voice_consents/{consent_id}` | Delete voice consent | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `GET` | `/v1/audio/voices` | List voices (NOT DOCUMENTED) | `UNVERIFIED` · `FAILED_VERIFICATION` | Bearer standard API key (server-side) | — | live_api · failure · HTTP 404 | | `POST` | `/v1/audio/voices` | Create custom voice | `DOCUMENTED` · `ACCOUNT_RESTRICTED` · `UNVERIFIED` | Bearer standard API key (server-side) (project-scoped key with custom voice access) | — | docs only | ## openai · `auth` (2) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `https://auth.openai.com/oauth/token` | Workload identity token exchange (JWT / OIDC id_token / SPIFFE JWT-SVID) | `DOCUMENTED` | none (subject_token in body) / external OIDC JWT | — | docs_only · not_tested | | `POST` | `https://mtls.auth.openai.com/oauth/token` | Workload identity token exchange (X.509 client certificate over mTLS) | `DOCUMENTED` | mTLS client certificate / X.509 certificate chained to an active Mutual TLS root | — | docs_only · not_tested | ## openai · `batches` (4) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/batches` | listBatches | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/batches` | createBatch | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/batches/{batch_id}` | retrieveBatch | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/batches/{batch_id}/cancel` | cancelBatch | `DOCUMENTED` · `LIVE_DISCOVERED` | Bearer API key (project or user key) | — | live_api · failure · HTTP 409 | ## openai · `chat-audio` (1) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/chat/completions (audio)` | Chat Completions with audio (pointer) | `DOCUMENTED` · `LIVE_DISCOVERED` | Bearer standard API key (server-side) | — | live_api · failure · HTTP 400 | ## openai · `chat_completions` (6) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/chat/completions` | Chat Completions: list | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `POST` | `/v1/chat/completions` | Chat Completions: create | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `GET` | `/v1/chat/completions/{completion_id}` | Chat Completions: retrieve | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `POST` | `/v1/chat/completions/{completion_id}` | Chat Completions: update | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/chat/completions/{completion_id}` | Chat Completions: delete | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `GET` | `/v1/chat/completions/{completion_id}/messages` | Chat Completions: list messages | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | ## openai · `completions` (1) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/completions` | Completions (legacy): create | `DOCUMENTED` · `LEGACY` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | ## openai · `containers` (9) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/containers` | ListContainers | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/containers` | CreateContainer | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/containers/{container_id}` | RetrieveContainer | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/containers/{container_id}` | DeleteContainer | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/containers/{container_id}/files` | ListContainerFiles | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/containers/{container_id}/files` | CreateContainerFile | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/containers/{container_id}/files/{file_id}` | RetrieveContainerFile | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/containers/{container_id}/files/{file_id}` | DeleteContainerFile | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/containers/{container_id}/files/{file_id}/content` | RetrieveContainerFileContent | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | ## openai · `content_provenance` (1) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/content_provenance_checks` | Create content provenance check | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key | — | live_api · success · HTTP 200 | ## openai · `conversations` (8) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/conversations` | Conversations: create | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `GET` | `/v1/conversations/{conversation_id}` | Conversations: retrieve | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `POST` | `/v1/conversations/{conversation_id}` | Conversations: update | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/conversations/{conversation_id}` | Conversations: delete | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `GET` | `/v1/conversations/{conversation_id}/items` | Conversations: list items | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `POST` | `/v1/conversations/{conversation_id}/items` | Conversations: create items | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `GET` | `/v1/conversations/{conversation_id}/items/{item_id}` | Conversations: retrieve item | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/conversations/{conversation_id}/items/{item_id}` | Conversations: delete item | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | ## openai · `embeddings` (1) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/embeddings` | Create embeddings | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key | — | live_api · success · HTTP 200 | ## openai · `evals` (12) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/evals` | listEvals | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/evals` | createEval | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 201 | | `GET` | `/v1/evals/{eval_id}` | getEval | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/evals/{eval_id}` | updateEval | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/evals/{eval_id}` | deleteEval | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/evals/{eval_id}/runs` | getEvalRuns | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/evals/{eval_id}/runs` | createEvalRun | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 201 | | `GET` | `/v1/evals/{eval_id}/runs/{run_id}` | getEvalRun | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/evals/{eval_id}/runs/{run_id}` | cancelEvalRun | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/evals/{eval_id}/runs/{run_id}` | deleteEvalRun | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/evals/{eval_id}/runs/{run_id}/output_items` | getEvalRunOutputItems | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}` | getEvalRunOutputItem | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | ## openai · `files` (5) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/files` | listFiles | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/files` | createFile | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/files/{file_id}` | retrieveFile | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/files/{file_id}` | deleteFile | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/files/{file_id}/content` | downloadFile | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | ## openai · `fine_tuning` (11) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions` | listFineTuningCheckpointPermissions | `DOCUMENTED` · `ACCOUNT_RESTRICTED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · restricted · HTTP 401 | | `POST` | `/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions` | createFineTuningCheckpointPermission | `DOCUMENTED` · `DEPRECATED` | Bearer API key (project or user key) | — | docs_only · success | | `DELETE` | `/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}` | deleteFineTuningCheckpointPermission | `DOCUMENTED` · `DEPRECATED` | Bearer API key (project or user key) | — | docs_only · success | | `GET` | `/v1/fine_tuning/jobs` | listPaginatedFineTuningJobs | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/fine_tuning/jobs` | createFineTuningJob | `DOCUMENTED` · `ACCOUNT_RESTRICTED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · restricted · HTTP 403 | | `GET` | `/v1/fine_tuning/jobs/{fine_tuning_job_id}` | retrieveFineTuningJob | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 404 | | `POST` | `/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel` | cancelFineTuningJob | `DOCUMENTED` · `DEPRECATED` | Bearer API key (project or user key) | — | docs_only · success | | `GET` | `/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints` | listFineTuningJobCheckpoints | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 404 | | `GET` | `/v1/fine_tuning/jobs/{fine_tuning_job_id}/events` | listFineTuningEvents | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 404 | | `POST` | `/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause` | pauseFineTuningJob | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` | Bearer API key (project or user key) | — | live_api · success · HTTP 404 | | `POST` | `/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume` | resumeFineTuningJob | `DOCUMENTED` · `DEPRECATED` | Bearer API key (project or user key) | — | docs_only · success | ## openai · `graders` (2) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/fine_tuning/alpha/graders/run` | runGrader | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` · `BETA` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/fine_tuning/alpha/graders/validate` | validateGrader | `DOCUMENTED` · `LIVE_VERIFIED` · `DEPRECATED` · `BETA` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | ## openai · `images` (3) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/images/edits` | Create image edit | `DOCUMENTED` · `UNVERIFIED` | Bearer API key | — | docs_only · not_run | | `POST` | `/v1/images/generations` | Create image | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key | — | live_api · success · HTTP 200 | | `POST` | `/v1/images/variations` | Create image variation (legacy) | `DOCUMENTED` · `LEGACY` · `RETIRED` · `FAILED_VERIFICATION` | Bearer API key | — | live_api · failure · HTTP 404 | ## openai · `live` (10) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/live/sessions` | Create Live session (WebRTC) | `DOCUMENTED` · `LIVE_DISCOVERED` | Bearer standard API key (server-side) | — | live_api · failure · HTTP 400 | | `POST` | `/v1/live/sessions/{session_id}/accept` | Accept Live SIP call | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `GET` | `/v1/live/sessions/{session_id}/content` | Download Live recording | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `POST` | `/v1/live/sessions/{session_id}/fork` | Fork stored Live session (WebRTC) | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `POST` | `/v1/live/sessions/{session_id}/hangup` | Hang up Live session | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `POST` | `/v1/live/sessions/{session_id}/refer` | Transfer Live SIP call | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `POST` | `/v1/live/sessions/{session_id}/reject` | Reject Live SIP call | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `WS` | `wss://api.openai.com/v1/live/sessions` | Live primary WebSocket | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `WS` | `wss://api.openai.com/v1/live/sessions/{session_id}/attach` | Live sideband WebSocket | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `WS` | `wss://api.openai.com/v1/live/sessions/{session_id}/fork` | Live fork WebSocket | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | ## openai · `moderations` (1) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/moderations` | Create moderation | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key | — | live_api · success · HTTP 200 | ## openai · `realtime` (14) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/realtime/calls` | Create call (WebRTC unified interface) | `DOCUMENTED` · `UNVERIFIED` | Bearer ephemeral client secret `ek_…` (browser/mobile) OR standard API key (server) | — | docs only | | `POST` | `/v1/realtime/calls/{call_id}/accept` | Accept call (SIP) | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `POST` | `/v1/realtime/calls/{call_id}/hangup` | Hang up call | `DOCUMENTED` · `LIVE_DISCOVERED` | Bearer standard API key (server-side) | — | live_api · failure · HTTP 404 | | `POST` | `/v1/realtime/calls/{call_id}/refer` | Refer call (SIP transfer) | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `POST` | `/v1/realtime/calls/{call_id}/reject` | Reject call (SIP) | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `POST` | `/v1/realtime/client_secrets` | Create client secret | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer standard API key (server-side) | — | live_api · success · HTTP 200 | | `POST` | `/v1/realtime/sessions` | Create session (LEGACY beta) | `DOCUMENTED` · `LEGACY` · `BETA` · `FAILED_VERIFICATION` | Bearer standard API key (server-side) | OpenAI-Beta: realtime=v1 | live_api · failure · HTTP 404 | | `POST` | `/v1/realtime/transcription_sessions` | Create transcription session (LEGACY beta) | `DOCUMENTED` · `LEGACY` · `BETA` · `FAILED_VERIFICATION` | Bearer standard API key (server-side) | OpenAI-Beta: realtime=v1 | live_api · failure · HTTP 404 | | `POST` | `/v1/realtime/translations/calls` | Create translation call (WebRTC) | `DOCUMENTED` · `UNVERIFIED` | Bearer ephemeral client secret from /v1/realtime/translations/client_secrets | — | docs only | | `POST` | `/v1/realtime/translations/client_secrets` | Create translation client secret | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer standard API key (server-side) | — | live_api · success · HTTP 200 | | `SIP` | `sip:{PROJECT_ID}@sip.api.openai.com;transport=tls` | Realtime SIP endpoint | `DOCUMENTED` · `UNVERIFIED` | project webhook + standard API key for call control | — | docs only | | `WS` | `wss://api.openai.com/v1/realtime?model={model}` | Realtime WebSocket (new session) | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer ephemeral client secret `ek_…` (browser/mobile) OR standard API key (server); browser subprotocols: … | — | live_api · success · HTTP 101 | | `WS` | `wss://api.openai.com/v1/realtime?call_id={call_id}` | Realtime WebSocket sideband (existing WebRTC/SIP call) | `DOCUMENTED` · `UNVERIFIED` | Bearer standard API key (server-side) | — | docs only | | `WS` | `wss://api.openai.com/v1/realtime/translations?model=gpt-realtime-translate` | Realtime translation WebSocket | `DOCUMENTED` · `UNVERIFIED` | Bearer ephemeral client secret `ek_…` (browser/mobile) OR standard API key (server) | — | docs only | ## openai · `responses` (9) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/responses` | Responses: create | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `POST` | `/v1/responses?beta=true` | Responses: create (beta surface) | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | openai-beta (optional, array of strings: "Optional beta f… | live_api · success · HTTP 200 | | `POST` | `/v1/responses/compact` | Responses: compact | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `POST` | `/v1/responses/input_tokens` | Responses: count input tokens | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `GET` | `/v1/responses/{response_id}` | Responses: retrieve | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/responses/{response_id}` | Responses: delete | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `POST` | `/v1/responses/{response_id}/cancel` | Responses: cancel | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `GET` | `/v1/responses/{response_id}/input_items` | Responses: list input items | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | live_api · success · HTTP 200 | | `WS` | `wss://api.openai.com/v1/responses` | Responses: WebSocket mode | `DOCUMENTED` · `UNVERIFIED` | Authorization: Bearer (project or user key; Organization/Project headers optional) | — | docs_only · success | ## openai · `safety` (2) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/safety/alerts/{id}` | Get project safety alert | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key | — | live_api · failure · HTTP 404 | | `GET` | `/v1/safety/cases/{id}` | Get safety case | `LIVE_DISCOVERED` · `ACCOUNT_RESTRICTED` | Bearer API key | — | live_api · restricted · HTTP 403 | ## openai · `skills` (11) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/skills` | ListSkills | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/skills` | CreateSkill | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/skills/{skill_id}` | GetSkill | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/skills/{skill_id}` | UpdateSkillDefaultVersion | `DOCUMENTED` · `FAILED_VERIFICATION` | Bearer API key (project key) | — | live_api · failure · HTTP 404 | | `DELETE` | `/v1/skills/{skill_id}` | DeleteSkill | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/skills/{skill_id}/content` | GetSkillContent | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/skills/{skill_id}/versions` | ListSkillVersions | `DOCUMENTED` · `FAILED_VERIFICATION` | Bearer API key (project key) | — | live_api · failure · HTTP 200 | | `POST` | `/v1/skills/{skill_id}/versions` | CreateSkillVersion | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/skills/{skill_id}/versions/{version}` | GetSkillVersion | `DOCUMENTED` · `FAILED_VERIFICATION` | Bearer API key (project key) | — | live_api · failure · HTTP 404 | | `DELETE` | `/v1/skills/{skill_id}/versions/{version}` | DeleteSkillVersion | `DOCUMENTED` · `FAILED_VERIFICATION` | Bearer API key (project key) | — | live_api · failure · HTTP 404 | | `GET` | `/v1/skills/{skill_id}/versions/{version}/content` | GetSkillVersionContent | `DOCUMENTED` | Bearer API key (project key) | — | docs_only · success | ## openai · `uploads` (4) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/uploads` | createUpload | `DOCUMENTED` · `LIVE_VERIFIED` · `LIVE_DISCOVERED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/uploads/{upload_id}/cancel` | cancelUpload | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/uploads/{upload_id}/complete` | completeUpload | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/uploads/{upload_id}/parts` | addUploadPart | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | ## openai · `vector_stores` (16) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/vector_stores` | listVectorStores | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/vector_stores` | createVectorStore | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/vector_stores/{vector_store_id}` | getVectorStore | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/vector_stores/{vector_store_id}` | modifyVectorStore | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/vector_stores/{vector_store_id}` | deleteVectorStore | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/vector_stores/{vector_store_id}/file_batches` | createVectorStoreFileBatch | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}` | getVectorStoreFileBatch | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel` | cancelVectorStoreFileBatch | `DOCUMENTED` · `FAILED_VERIFICATION` | Bearer API key (project or user key) | — | live_api · failure · HTTP 500 | | `GET` | `/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files` | listFilesInVectorStoreBatch | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/vector_stores/{vector_store_id}/files` | listVectorStoreFiles | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/vector_stores/{vector_store_id}/files` | createVectorStoreFile | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/vector_stores/{vector_store_id}/files/{file_id}` | getVectorStoreFile | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/vector_stores/{vector_store_id}/files/{file_id}` | updateVectorStoreFileAttributes | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/vector_stores/{vector_store_id}/files/{file_id}` | deleteVectorStoreFile | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `GET` | `/v1/vector_stores/{vector_store_id}/files/{file_id}/content` | retrieveVectorStoreFileContent | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | | `POST` | `/v1/vector_stores/{vector_store_id}/search` | searchVectorStore | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (project or user key) | — | live_api · success · HTTP 200 | ## openai · `videos` (10) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/videos` | List videos | `DOCUMENTED` · `DEPRECATED` · `LIVE_VERIFIED` | Bearer API key | — | live_api · success · HTTP 200 | | `POST` | `/v1/videos` | Create video | `DOCUMENTED` · `DEPRECATED` · `UNVERIFIED` | Bearer API key | — | docs_only · not_run | | `POST` | `/v1/videos/characters` | Create character | `DOCUMENTED` · `DEPRECATED` · `UNVERIFIED` | Bearer API key | — | live_api · failure · HTTP 400 | | `GET` | `/v1/videos/characters/{character_id}` | Retrieve character | `DOCUMENTED` · `DEPRECATED` · `UNVERIFIED` | Bearer API key | — | docs_only · not_run | | `POST` | `/v1/videos/edits` | Create video edit | `DOCUMENTED` · `DEPRECATED` · `UNVERIFIED` | Bearer API key | — | docs_only · not_run | | `POST` | `/v1/videos/extensions` | Create video extension | `DOCUMENTED` · `DEPRECATED` · `UNVERIFIED` | Bearer API key | — | docs_only · not_run | | `GET` | `/v1/videos/{video_id}` | Retrieve video | `DOCUMENTED` · `DEPRECATED` · `LIVE_VERIFIED` | Bearer API key | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/videos/{video_id}` | Delete video | `DOCUMENTED` · `DEPRECATED` · `UNVERIFIED` | Bearer API key | — | docs_only · not_run | | `GET` | `/v1/videos/{video_id}/content` | Download video content | `DOCUMENTED` · `DEPRECATED` · `LIVE_VERIFIED` | Bearer API key | — | live_api · failure · HTTP 404 | | `POST` | `/v1/videos/{video_id}/remix` | Create video remix (being replaced by edits) | `DOCUMENTED` · `DEPRECATED` · `UNVERIFIED` | Bearer API key | — | docs_only · not_run | ## openai · `webhooks` (8) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/webhook_endpoints` | List Webhook Endpoints | `DOCUMENTED` · `LIVE_VERIFIED` | bearer / project_api_key (or service-account key / WIF access token) | — | live_api · success · HTTP 200 | | `POST` | `/v1/webhook_endpoints` | Create Webhook Endpoint | `DOCUMENTED` | bearer / project_api_key (or service-account key / WIF access token) | — | docs_only · not_tested | | `GET` | `/v1/webhook_endpoints/{webhook_endpoint_id}` | Retrieve Webhook Endpoint | `DOCUMENTED` | bearer / project_api_key (or service-account key / WIF access token) | — | docs_only · not_tested | | `POST` | `/v1/webhook_endpoints/{webhook_endpoint_id}` | Update Webhook Endpoint | `DOCUMENTED` | bearer / project_api_key (or service-account key / WIF access token) | — | docs_only · not_tested | | `DELETE` | `/v1/webhook_endpoints/{webhook_endpoint_id}` | Delete Webhook Endpoint | `DOCUMENTED` | bearer / project_api_key (or service-account key / WIF access token) | — | docs_only · not_tested | | `POST` | `/v1/webhook_endpoints/{webhook_endpoint_id}/rotate_secret` | Rotate Webhook Endpoint Signing Secret | `DOCUMENTED` | bearer / project_api_key (or service-account key / WIF access token) | — | docs_only · not_tested | | `POST` | `/v1/webhook_endpoints/{webhook_endpoint_id}/test` | Test Webhook Endpoint | `DOCUMENTED` | bearer / project_api_key (or service-account key / WIF access token) | — | docs_only · not_tested | | `GET` | `/v1/webhook_event_types` | List Webhook Event Types | `DOCUMENTED` · `LIVE_VERIFIED` | bearer / project_api_key (or service-account key / WIF access token) | — | live_api · success · HTTP 200 | # Anthropic endpoints (282) ## anthropic · `admin` (100) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/organizations/analytics/apps/chat/projects` | Get Chat Project Usage | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/analytics/artifacts` | Get Artifact Activity | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/analytics/connectors` | Get Connector Usage | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/analytics/cost_report` | Get Cost Over Time | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/analytics/plugins` | Get Plugin Usage | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/analytics/skills` | Get Skill Usage | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/analytics/summaries` | Get Activity Summaries | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `GET` | `/v1/organizations/analytics/usage_report` | Get Token Usage Over Time | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `GET` | `/v1/organizations/analytics/user_cost_report` | Get Per-User Cost | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/analytics/user_usage_report` | Get Per-User Token Usage | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/analytics/users` | List User Activity | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `GET` | `/v1/organizations/api_keys` | List API Keys | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `GET` | `/v1/organizations/api_keys/{api_key_id}` | Retrieve API Key (Admin API) | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/api_keys/{api_key_id}` | Update API Key | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/compliance_settings` | Get Compliance Settings | `DOCUMENTED` · `BETA` · `ACCOUNT_RESTRICTED` | api_key / admin_api_key (sk-ant-admin01-…) | unknown (reference page lists no anthropic-beta header; S… | docs_only · restricted | | `POST` | `/v1/organizations/compliance_settings` | Update Compliance Settings | `DOCUMENTED` · `BETA` · `ACCOUNT_RESTRICTED` | api_key / admin_api_key (sk-ant-admin01-…) | unknown (reference page lists no anthropic-beta header; S… | docs_only · restricted | | `GET` | `/v1/organizations/cost_report` | Get Cost Report | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `GET` | `/v1/organizations/external_keys` | List External Keys | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `POST` | `/v1/organizations/external_keys` | Create External Key | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/external_keys/{external_key_id}` | Get External Key | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/external_keys/{external_key_id}` | Update External Key | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `DELETE` | `/v1/organizations/external_keys/{external_key_id}` | Delete External Key | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/external_keys/{external_key_id}/validate` | Validate External Key | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/federation_issuers` | List Federation Issuers | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `POST` | `/v1/organizations/federation_issuers` | Create Federation Issuer | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/federation_issuers/{federation_issuer_id}` | Get Federation Issuer | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/federation_issuers/{federation_issuer_id}` | Update Federation Issuer | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` | Archive Federation Issuer | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/federation_rules` | List Federation Rules | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `POST` | `/v1/organizations/federation_rules` | Create Federation Rule | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/federation_rules/{federation_rule_id}` | Get Federation Rule | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/federation_rules/{federation_rule_id}` | Update Federation Rule | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/federation_rules/{federation_rule_id}/archive` | Archive Federation Rule | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` | List Federation Rule Workspaces | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` | Add Federation Rule Workspace | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `DELETE` | `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` | Remove Federation Rule Workspace | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/invites` | List Invites | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `POST` | `/v1/organizations/invites` | Create Invite | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/invites/{invite_id}` | Get Invite | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `DELETE` | `/v1/organizations/invites/{invite_id}` | Delete Invite | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/me` | Get Current Organization | `DOCUMENTED` · `LIVE_VERIFIED` | Admin API key (sk-ant-admin…) or org:admin OAuth bearer or non-workspace-scoped personal/service-account ke… | — | live_api · success · HTTP 200 | | `GET` | `/v1/organizations/rate_limits` | List Organization Rate Limits | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `GET` | `/v1/organizations/rbac_groups` | List RBAC Groups | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `POST` | `/v1/organizations/rbac_groups` | Create RBAC Group | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/rbac_groups/{group_id}` | Get RBAC Group | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/rbac_groups/{group_id}` | Update RBAC Group | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `DELETE` | `/v1/organizations/rbac_groups/{group_id}` | Delete RBAC Group | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/rbac_groups/{group_id}/members` | List RBAC Group Members | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/rbac_groups/{group_id}/members` | Add RBAC Group Member | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `DELETE` | `/v1/organizations/rbac_groups/{group_id}/members/{user_id}` | Remove RBAC Group Member | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/rbac_roles` | List RBAC Roles | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `GET` | `/v1/organizations/rbac_roles/{role_id}` | Get RBAC Role | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/rbac_roles/{role_id}/permissions` | List RBAC Role Permissions | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/service_accounts` | List Service Accounts | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `POST` | `/v1/organizations/service_accounts` | Create Service Account | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/service_accounts/{service_account_id}` | Get Service Account | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/service_accounts/{service_account_id}` | Update Service Account | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/service_accounts/{service_account_id}/archive` | Archive Service Account | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/service_accounts/{service_account_id}/workspaces` | List Workspaces For Service Account | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/service_accounts/{service_account_id}/workspaces` | Add Workspace To Service Account | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `DELETE` | `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` | Remove Workspace From Service Account | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/spend_limit_increase_requests` | List Spend Limit Increase Requests | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `GET` | `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}` | Get Spend Limit Increase Request | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve` | Approve Spend Limit Increase Request | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny` | Deny Spend Limit Increase Request | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/spend_limits` | Set Spend Limit | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/spend_limits/effective` | List Effective Spend Limits | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `GET` | `/v1/organizations/spend_limits/{spend_limit_id}` | Get Spend Limit | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `DELETE` | `/v1/organizations/spend_limits/{spend_limit_id}` | Delete Spend Limit | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/tunnels` | List Tunnels | `DOCUMENTED` · `BETA` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | mcp-tunnels-2026-05-19 | live_api · restricted · HTTP 401 | | `GET` | `/v1/organizations/tunnels/{tunnel_id}` | Get Tunnel | `DOCUMENTED` · `BETA` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | mcp-tunnels-2026-05-19 | docs only | | `POST` | `/v1/organizations/tunnels/{tunnel_id}/archive` | Archive Tunnel | `DOCUMENTED` · `BETA` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | mcp-tunnels-2026-05-19 | docs only | | `GET` | `/v1/organizations/tunnels/{tunnel_id}/certificates` | List Tunnel Certificates | `DOCUMENTED` · `BETA` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | mcp-tunnels-2026-05-19 | docs only | | `POST` | `/v1/organizations/tunnels/{tunnel_id}/certificates` | Create Tunnel Certificate | `DOCUMENTED` · `BETA` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | mcp-tunnels-2026-05-19 | docs only | | `GET` | `/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}` | Get Tunnel Certificate | `DOCUMENTED` · `BETA` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | mcp-tunnels-2026-05-19 | docs only | | `POST` | `/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` | Archive Tunnel Certificate | `DOCUMENTED` · `BETA` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | mcp-tunnels-2026-05-19 | docs only | | `POST` | `/v1/organizations/tunnels/{tunnel_id}/reveal_token` | Reveal Tunnel Token | `DOCUMENTED` · `BETA` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | mcp-tunnels-2026-05-19 | docs only | | `POST` | `/v1/organizations/tunnels/{tunnel_id}/rotate_token` | Rotate Tunnel Token | `DOCUMENTED` · `BETA` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | mcp-tunnels-2026-05-19 | docs only | | `GET` | `/v1/organizations/usage_report/claude_code` | Get Claude Code Usage Report | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `GET` | `/v1/organizations/usage_report/messages` | Get Messages Usage Report | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `GET` | `/v1/organizations/users` | List Users | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `GET` | `/v1/organizations/users/{user_id}` | Get User | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/users/{user_id}` | Update User | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `DELETE` | `/v1/organizations/users/{user_id}` | Remove User | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/workspaces` | List Workspaces | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | live_api · restricted · HTTP 401 | | `POST` | `/v1/organizations/workspaces` | Create Workspace | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/workspaces/{workspace_id}` | Get Workspace | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/workspaces/{workspace_id}` | Update Workspace | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/workspaces/{workspace_id}/archive` | Archive Workspace | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/workspaces/{workspace_id}/members` | List Workspace Members | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/workspaces/{workspace_id}/members` | Create Workspace Member | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` | Get Workspace Member | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` | Update Workspace Member | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `DELETE` | `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` | Delete Workspace Member | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/workspaces/{workspace_id}/rate_limits` | List Workspace Rate Limits | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/workspaces/{workspace_id}/service_accounts` | List Service Account Workspace Members | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/workspaces/{workspace_id}/service_accounts` | Create Service Account Workspace Member | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `GET` | `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` | Get Service Account Workspace Member | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `POST` | `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` | Update Service Account Workspace Member | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | | `DELETE` | `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` | Delete Service Account Workspace Member | `DOCUMENTED` | Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federa… | — | docs only | ## anthropic · `cloud:bedrock` (6) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `https://bedrock-mantle.{region}.api.aws/anthropic/v1/messages` | Claude in Amazon Bedrock: Messages | `DOCUMENTED` · `UNVERIFIED` | AWS SigV4 | anthropic-beta header not supported per comparison table | docs_only · restricted | | `POST` | `https://bedrock-mantle.{region}.api.aws/anthropic/v1/messages/count_tokens` | Claude in Amazon Bedrock: count tokens | `DOCUMENTED` · `UNVERIFIED` · `DOCUMENTATION_INCOMPLETE` | AWS SigV4 | — | docs_only · restricted | | `POST` | `https://bedrock-runtime.{region}.amazonaws.com/model/{modelId}/converse` | Amazon Bedrock (legacy): Converse | `DOCUMENTED` · `UNVERIFIED` · `LEGACY` | AWS SigV4 | — | docs_only · restricted | | `POST` | `https://bedrock-runtime.{region}.amazonaws.com/model/{modelId}/invoke` | Amazon Bedrock (legacy): InvokeModel | `DOCUMENTED` · `UNVERIFIED` · `LEGACY` | AWS SigV4 | anthropic-beta header not supported; no body-level beta m… | docs_only · restricted | | `POST` | `https://bedrock-runtime.{region}.amazonaws.com/model/{modelId}/invoke-with-response-stream` | Amazon Bedrock (legacy): InvokeModelWithResponseStream | `DOCUMENTED` · `UNVERIFIED` · `LEGACY` | AWS SigV4 | — | docs_only · restricted | | `GET` | `https://bedrock.{region}.amazonaws.com/foundation-models?byProvider=anthropic` | Amazon Bedrock: ListFoundationModels | `DOCUMENTED` · `UNVERIFIED` | AWS SigV4 | — | docs_only · restricted | ## anthropic · `cloud:claude_platform_on_aws` (12) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `https://aws-external-anthropic.{region}.api.aws/v1/agents` | Claude Platform on AWS: Claude Managed Agents | `DOCUMENTED` · `UNVERIFIED` · `BETA` | AWS SigV4 (service aws-external-anthropic) or API key | — | docs_only · restricted | | `GET` | `https://aws-external-anthropic.{region}.api.aws/v1/compliance/activities` | Claude Platform on AWS: Compliance API activity feed | `DOCUMENTED` · `UNVERIFIED` | AWS SigV4 (service aws-external-anthropic) or API key | — | docs_only · restricted | | `POST` | `https://aws-external-anthropic.{region}.api.aws/v1/files` | Claude Platform on AWS: Files (beta) | `DOCUMENTED` · `UNVERIFIED` · `BETA` | AWS SigV4 (service aws-external-anthropic) or API key | — | docs_only · restricted | | `POST` | `https://aws-external-anthropic.{region}.api.aws/v1/messages` | Claude Platform on AWS: Messages | `DOCUMENTED` · `UNVERIFIED` | AWS SigV4 (service aws-external-anthropic) or API key | anthropic-beta header (pass-through, same as Claude API) | docs_only · restricted | | `GET` | `https://aws-external-anthropic.{region}.api.aws/v1/messages/batches` | Claude Platform on AWS: list batches | `DOCUMENTED` · `UNVERIFIED` | AWS SigV4 (service aws-external-anthropic) or API key | — | docs_only · restricted | | `POST` | `https://aws-external-anthropic.{region}.api.aws/v1/messages/batches` | Claude Platform on AWS: create Message Batch | `DOCUMENTED` · `UNVERIFIED` | AWS SigV4 (service aws-external-anthropic) or API key | — | docs_only · restricted | | `GET` | `https://aws-external-anthropic.{region}.api.aws/v1/messages/batches/{id}` | Claude Platform on AWS: get batch / results | `DOCUMENTED` · `UNVERIFIED` | AWS SigV4 (service aws-external-anthropic) or API key | — | docs_only · restricted | | `DELETE` | `https://aws-external-anthropic.{region}.api.aws/v1/messages/batches/{id}` | Claude Platform on AWS: delete batch | `DOCUMENTED` · `UNVERIFIED` | AWS SigV4 (service aws-external-anthropic) or API key | — | docs_only · restricted | | `POST` | `https://aws-external-anthropic.{region}.api.aws/v1/messages/batches/{id}/cancel` | Claude Platform on AWS: cancel batch | `DOCUMENTED` · `UNVERIFIED` | AWS SigV4 (service aws-external-anthropic) or API key | — | docs_only · restricted | | `POST` | `https://aws-external-anthropic.{region}.api.aws/v1/messages/count_tokens` | Claude Platform on AWS: count tokens | `DOCUMENTED` · `UNVERIFIED` | AWS SigV4 (service aws-external-anthropic) or API key | — | docs_only · restricted | | `GET` | `https://aws-external-anthropic.{region}.api.aws/v1/models` | Claude Platform on AWS: list models | `DOCUMENTED` · `UNVERIFIED` | AWS SigV4 (service aws-external-anthropic) or API key | — | docs_only · restricted | | `POST` | `https://aws-external-anthropic.{region}.api.aws/v1/organizations/workspaces` | Claude Platform on AWS: Admin API workspaces | `DOCUMENTED` · `UNVERIFIED` | AWS SigV4 (service aws-external-anthropic) or API key | — | docs_only · restricted | ## anthropic · `cloud:microsoft_foundry` (3) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `https://{resource}.services.ai.azure.com/anthropic/v1/files` | Claude in Microsoft Foundry: Files (beta, Hosted on Anthropic only) | `DOCUMENTED` · `UNVERIFIED` · `BETA` | Azure api-key or Microsoft Entra ID bearer | — | docs_only · restricted | | `POST` | `https://{resource}.services.ai.azure.com/anthropic/v1/messages` | Claude in Microsoft Foundry: Messages | `DOCUMENTED` · `UNVERIFIED` | Azure api-key or Microsoft Entra ID bearer | unknown — beta features exist on Foundry but header mecha… | docs_only · restricted | | `POST` | `https://{resource}.services.ai.azure.com/anthropic/v1/messages/count_tokens` | Claude in Microsoft Foundry: count tokens | `DOCUMENTED` · `UNVERIFIED` · `DOCUMENTATION_INCOMPLETE` | Azure api-key or Microsoft Entra ID bearer | — | docs_only · restricted | ## anthropic · `cloud:vertex_ai` (3) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `https://{region}-aiplatform.googleapis.com/v1/projects/{project}/locations/{region}/publishers/anthropic/models/count-tokens:rawPredict` | Google Cloud: count tokens | `DOCUMENTED` · `UNVERIFIED` · `DOCUMENTATION_INCOMPLETE` | Google OAuth2 bearer (Application Default Credentials) | — | docs_only · restricted | | `POST` | `https://{region}-aiplatform.googleapis.com/v1/projects/{project}/locations/{region}/publishers/anthropic/models/{model}:rawPredict` | Google Cloud (Vertex AI / Agent Platform): rawPredict | `DOCUMENTED` · `UNVERIFIED` | Google OAuth2 bearer (Application Default Credentials) | unknown — docs say 'pass the beta value as described in B… | docs_only · restricted | | `POST` | `https://{region}-aiplatform.googleapis.com/v1/projects/{project}/locations/{region}/publishers/anthropic/models/{model}:streamRawPredict` | Google Cloud: streamRawPredict | `DOCUMENTED` · `UNVERIFIED` · `DOCUMENTATION_INCOMPLETE` | Google OAuth2 bearer (Application Default Credentials) | — | docs_only · restricted | ## anthropic · `completions` (1) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/complete` | Create a Text Completion (LEGACY) | `DOCUMENTED` · `LEGACY` · `DEPRECATED` · `FAILED_VERIFICATION` | x-api-key: (or Authorization: Bearer ) + anthropic-version: 2023-06-01 + content-type:… | — | live_api · failure · HTTP 400 | ## anthropic · `compliance` (36) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/compliance/activities` | Query compliance activities | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) OR admin_api_key (sk-ant-admin01-…) (scopes: read:compliance_ | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/artifacts/{artifact_version_id}` | Get artifact metadata | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/artifacts/{artifact_version_id}/content` | Download artifact content | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/chats` | List chats | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/chats/files/{claude_file_id}` | Get file metadata | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `DELETE` | `/v1/compliance/apps/chats/files/{claude_file_id}` | Delete file | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: delete:compliance_user_data) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/chats/files/{claude_file_id}/content` | Download file content | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}` | Get Claude-generated file metadata | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content` | Download a Claude-generated file | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `DELETE` | `/v1/compliance/apps/chats/{claude_chat_id}` | Delete chat | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: delete:compliance_user_data) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/chats/{claude_chat_id}/messages` | Get chat messages | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/code/artifacts` | List Code Artifacts | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `DELETE` | `/v1/compliance/apps/code/artifacts/{artifact_id}` | Delete Code Artifact | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: delete:compliance_user_data) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` | Download Code Artifact Version Content | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/projects` | List projects | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/projects/documents/{document_id}` | Get project document content | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `DELETE` | `/v1/compliance/apps/projects/documents/{document_id}` | Delete project document | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: delete:compliance_user_data) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/projects/documents/{document_id}/metadata` | Get project document metadata | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/projects/{project_id}` | Get project details | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `DELETE` | `/v1/compliance/apps/projects/{project_id}` | Delete project | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: delete:compliance_user_data) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/projects/{project_id}/attachments` | List project attachments | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/projects/{project_id}/collaborators` | List project collaborators | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/sessions/local` | List local sessions | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/sessions/local/{local_session_id}` | Retrieve a local session | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/sessions/local/{local_session_id}/messages` | Retrieve local session messages | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/sessions/remote` | List remote sessions | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages` | Retrieve remote session messages | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/groups` | List Compliance Groups | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_org_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/groups/{group_id}` | Get Compliance Group | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_org_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/groups/{group_id}/members` | List Compliance Group Members | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/organizations` | List organizations | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_org_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/organizations/{org_uuid}/roles` | List Compliance Roles | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_org_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/organizations/{org_uuid}/roles/{role_id}` | Get Compliance Role | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_org_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions` | List Compliance Role Permissions | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_org_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/organizations/{org_uuid}/users` | List organization users | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_user_data, read:org_audit) | — | docs_only · restricted | | `GET` | `/v1/compliance/organizations/{organization_id}/settings` | Get effective organization settings | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | api_key / compliance_access_key (sk-ant-api01-…) (scopes: read:compliance_org_data, read:org_audit) | — | docs_only · restricted | ## anthropic · `files` (5) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/files` | List Files | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key + anthropic-version | — | live_api · success · HTTP 200 | | `POST` | `/v1/files` | Upload File | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key + anthropic-version | — | live_api · success · HTTP 200 | | `GET` | `/v1/files/{file_id}` | Get File Metadata | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key + anthropic-version | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/files/{file_id}` | Delete File | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key + anthropic-version | — | live_api · success · HTTP 200 | | `GET` | `/v1/files/{file_id}/content` | Download File | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key + anthropic-version | — | live_api · failure · HTTP 400 | ## anthropic · `managed-agents` (96) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/agents` | List Agents | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `POST` | `/v1/agents` | Create Agent | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `GET` | `/v1/agents/{agent_id}` | Get Agent | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `POST` | `/v1/agents/{agent_id}` | Update Agent | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/agents/{agent_id}/archive` | Archive Agent | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `GET` | `/v1/agents/{agent_id}/versions` | List Agent Versions | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `GET` | `/v1/deployment_runs` | List Deployment Runs | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `GET` | `/v1/deployment_runs/{deployment_run_id}` | Get Deployment Run | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/deployments` | List Deployments | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `POST` | `/v1/deployments` | Create Deployment | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/deployments/{deployment_id}` | Get Deployment | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/deployments/{deployment_id}` | Update Deployment | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/deployments/{deployment_id}/archive` | Archive Deployment | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/deployments/{deployment_id}/pause` | Pause Deployment | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/deployments/{deployment_id}/run` | Run Deployment Now | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/deployments/{deployment_id}/unpause` | Unpause Deployment | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/dreams` | List Dreams | `DOCUMENTED` · `BETA` · `FAILED_VERIFICATION` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | dreaming-2026-04-21 | live_api · failure · HTTP 404 | | `POST` | `/v1/dreams` | Create a Dream | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | dreaming-2026-04-21 | docs only | | `GET` | `/v1/dreams/{dream_id}` | Get a Dream | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | dreaming-2026-04-21 | docs only | | `POST` | `/v1/dreams/{dream_id}/archive` | Archive a Dream | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | dreaming-2026-04-21 | docs only | | `POST` | `/v1/dreams/{dream_id}/cancel` | Cancel a Dream | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | dreaming-2026-04-21 | docs only | | `GET` | `/v1/environments` | List Environments | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `POST` | `/v1/environments` | Create Environment | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `GET` | `/v1/environments/{environment_id}` | Get Environment | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/environments/{environment_id}` | Update Environment | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `DELETE` | `/v1/environments/{environment_id}` | Delete Environment | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `POST` | `/v1/environments/{environment_id}/archive` | Archive Environment | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `GET` | `/v1/environments/{environment_id}/work` | List Work Items | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/environments/{environment_id}/work/poll` | Poll for Work | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/environments/{environment_id}/work/stats` | Get Queue Statistics | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/environments/{environment_id}/work/{work_id}` | Get Work Item | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/environments/{environment_id}/work/{work_id}` | Update Work Item | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/environments/{environment_id}/work/{work_id}/ack` | Acknowledge Work | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/environments/{environment_id}/work/{work_id}/heartbeat` | Record Heartbeat | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/environments/{environment_id}/work/{work_id}/stop` | Stop Work | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/memory_stores` | List memory stores | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | agent-memory-2026-07-22 | live_api · success · HTTP 200 | | `POST` | `/v1/memory_stores` | Create a memory store | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | agent-memory-2026-07-22 | docs only | | `GET` | `/v1/memory_stores/{memory_store_id}` | Retrieve a memory store | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | agent-memory-2026-07-22 | docs only | | `POST` | `/v1/memory_stores/{memory_store_id}` | Update a memory store | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | agent-memory-2026-07-22 | docs only | | `DELETE` | `/v1/memory_stores/{memory_store_id}` | Delete a memory store | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | agent-memory-2026-07-22 | docs only | | `POST` | `/v1/memory_stores/{memory_store_id}/archive` | Archive a memory store | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | agent-memory-2026-07-22 | docs only | | `GET` | `/v1/memory_stores/{memory_store_id}/memories` | List memories | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | agent-memory-2026-07-22 | docs only | | `POST` | `/v1/memory_stores/{memory_store_id}/memories` | Create a memory | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | agent-memory-2026-07-22 | docs only | | `GET` | `/v1/memory_stores/{memory_store_id}/memories/{memory_id}` | Retrieve a memory | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | agent-memory-2026-07-22 | docs only | | `POST` | `/v1/memory_stores/{memory_store_id}/memories/{memory_id}` | Update a memory | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | agent-memory-2026-07-22 | docs only | | `DELETE` | `/v1/memory_stores/{memory_store_id}/memories/{memory_id}` | Delete a memory | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | agent-memory-2026-07-22 | docs only | | `GET` | `/v1/memory_stores/{memory_store_id}/memory_versions` | List memory versions | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | agent-memory-2026-07-22 | docs only | | `GET` | `/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}` | Retrieve a memory version | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | agent-memory-2026-07-22 | docs only | | `POST` | `/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact` | Redact a memory version | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | agent-memory-2026-07-22 | docs only | | `GET` | `/v1/sessions` | List Sessions | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `POST` | `/v1/sessions` | Create Session | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `GET` | `/v1/sessions/{session_id}` | Get Session | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `POST` | `/v1/sessions/{session_id}` | Update Session | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `DELETE` | `/v1/sessions/{session_id}` | Delete Session | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `POST` | `/v1/sessions/{session_id}/archive` | Archive Session | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `GET` | `/v1/sessions/{session_id}/events` | List Events | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `POST` | `/v1/sessions/{session_id}/events` | Send Events | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `GET` | `/v1/sessions/{session_id}/events/stream` | Stream Events | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `GET` | `/v1/sessions/{session_id}/resources` | List Session Resources | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/sessions/{session_id}/resources` | Add Session Resource | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/sessions/{session_id}/resources/{resource_id}` | Get Session Resource | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/sessions/{session_id}/resources/{resource_id}` | Update Session Resource | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `DELETE` | `/v1/sessions/{session_id}/resources/{resource_id}` | Delete Session Resource | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/sessions/{session_id}/threads` | List Session Threads | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/sessions/{session_id}/threads/{thread_id}` | Get Session Thread | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/sessions/{session_id}/threads/{thread_id}/archive` | Archive Session Thread | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/sessions/{session_id}/threads/{thread_id}/events` | List Session Thread Events | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/sessions/{session_id}/threads/{thread_id}/stream` | Stream Session Thread Events | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/tunnels` | List Tunnels | `DOCUMENTED` · `BETA` · `ACCOUNT_RESTRICTED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | mcp-tunnels-2026-06-22 | live_api · restricted · HTTP 401 | | `POST` | `/v1/tunnels` | Create Tunnel | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | mcp-tunnels-2026-06-22 | docs only | | `GET` | `/v1/tunnels/{tunnel_id}` | Get Tunnel | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | mcp-tunnels-2026-06-22 | docs only | | `POST` | `/v1/tunnels/{tunnel_id}/archive` | Archive Tunnel | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | mcp-tunnels-2026-06-22 | docs only | | `GET` | `/v1/tunnels/{tunnel_id}/certificates` | List Tunnel Certificates | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | mcp-tunnels-2026-06-22 | docs only | | `POST` | `/v1/tunnels/{tunnel_id}/certificates` | Create Tunnel Certificate | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | mcp-tunnels-2026-06-22 | docs only | | `GET` | `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` | Get Tunnel Certificate | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | mcp-tunnels-2026-06-22 | docs only | | `POST` | `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` | Archive Tunnel Certificate | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | mcp-tunnels-2026-06-22 | docs only | | `POST` | `/v1/tunnels/{tunnel_id}/reveal_token` | Reveal Tunnel Token | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | mcp-tunnels-2026-06-22 | docs only | | `POST` | `/v1/tunnels/{tunnel_id}/rotate_token` | Rotate Tunnel Token | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | mcp-tunnels-2026-06-22 | docs only | | `GET` | `/v1/user_profiles` | List User Profiles | `DOCUMENTED` · `BETA` · `FAILED_VERIFICATION` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | user-profiles-2026-08-18 | live_api · failure · HTTP 404 | | `POST` | `/v1/user_profiles` | Create User Profile | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | user-profiles-2026-08-18 | docs only | | `GET` | `/v1/user_profiles/{user_profile_id}` | Get User Profile | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | user-profiles-2026-08-18 | docs only | | `POST` | `/v1/user_profiles/{user_profile_id}` | Update User Profile | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | user-profiles-2026-08-18 | docs only | | `POST` | `/v1/user_profiles/{user_profile_id}/enrollment_url` | Create Enrollment URL | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | user-profiles-2026-08-18 | docs only | | `GET` | `/v1/vaults` | List Vaults | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | live_api · success · HTTP 200 | | `POST` | `/v1/vaults` | Create Vault | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/vaults/{vault_id}` | Get Vault | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/vaults/{vault_id}` | Update Vault | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `DELETE` | `/v1/vaults/{vault_id}` | Delete Vault | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/vaults/{vault_id}/archive` | Archive Vault | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/vaults/{vault_id}/credentials` | List Credentials | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/vaults/{vault_id}/credentials` | Create Credential | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `GET` | `/v1/vaults/{vault_id}/credentials/{credential_id}` | Get Credential | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/vaults/{vault_id}/credentials/{credential_id}` | Update Credential | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `DELETE` | `/v1/vaults/{vault_id}/credentials/{credential_id}` | Delete Credential | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/vaults/{vault_id}/credentials/{credential_id}/archive` | Archive Credential | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | | `POST` | `/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate` | Validate Credential | `DOCUMENTED` · `BETA` | x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header | managed-agents-2026-04-01 | docs only | ## anthropic · `messages` (3) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/messages` | Create a Message | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key: (or Authorization: Bearer ) + anthropic-version: 2023-06-01 + content-type:… | — | live_api · success · HTTP 200 | | `POST` | `/v1/messages (beta surface)` | Create a Message (beta parameters) | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-api-key: (or Authorization: Bearer ) + anthropic-version: 2023-06-01 + content-type:… | feature-specific (see anthropic-beta list in the models/b… | live_api · success · HTTP 200 | | `POST` | `/v1/messages/count_tokens` | Count tokens in a Message | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key: (or Authorization: Bearer ) + anthropic-version: 2023-06-01 + content-type:… | — | live_api · success · HTTP 200 | ## anthropic · `messages-batches` (6) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/messages/batches` | List Message Batches | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key) | message-batches-2024-09-24 | live_api · success · HTTP 200 | | `POST` | `/v1/messages/batches` | Create a Message Batch | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key) | message-batches-2024-09-24 | live_api · success · HTTP 200 | | `GET` | `/v1/messages/batches/{message_batch_id}` | Retrieve a Message Batch | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key) | message-batches-2024-09-24 | live_api · success · HTTP 200 | | `DELETE` | `/v1/messages/batches/{message_batch_id}` | Delete a Message Batch | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key) | message-batches-2024-09-24 | live_api · success · HTTP 200 | | `POST` | `/v1/messages/batches/{message_batch_id}/cancel` | Cancel a Message Batch | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key) | message-batches-2024-09-24 | live_api · success · HTTP 200 | | `GET` | `/v1/messages/batches/{message_batch_id}/results` | Retrieve Message Batch results | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key) | message-batches-2024-09-24 | live_api · success · HTTP 200 | ## anthropic · `models` (2) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/models` | List Models | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key: (or Authorization: Bearer ) + anthropic-version: 2023-06-01 + content-type:… | — | live_api · success · HTTP 200 | | `GET` | `/v1/models/{model_id}` | Get a Model | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key: (or Authorization: Bearer ) + anthropic-version: 2023-06-01 + content-type:… | — | live_api · success · HTTP 200 | ## anthropic · `skills` (9) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/skills` | List Skills | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key); optional anthropic-workspace-id header | — | live_api · success · HTTP 200 | | `POST` | `/v1/skills` | Create Skill | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key); optional anthropic-workspace-id header | — | live_api · success · HTTP 200 | | `GET` | `/v1/skills/{skill_id}` | Get Skill | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key); optional anthropic-workspace-id header | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/skills/{skill_id}` | Delete Skill | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key); optional anthropic-workspace-id header | — | live_api · success · HTTP 200 | | `GET` | `/v1/skills/{skill_id}/versions` | List Skill Versions | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key); optional anthropic-workspace-id header | — | live_api · success · HTTP 200 | | `POST` | `/v1/skills/{skill_id}/versions` | Create Skill Version | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key); optional anthropic-workspace-id header | — | live_api · success · HTTP 200 | | `GET` | `/v1/skills/{skill_id}/versions/{version}` | Get Skill Version | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key); optional anthropic-workspace-id header | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/skills/{skill_id}/versions/{version}` | Delete Skill Version | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key); optional anthropic-workspace-id header | — | live_api · success · HTTP 200 | | `GET` | `/v1/skills/{skill_id}/versions/{version}/content` | Download Skill Version Content | `DOCUMENTED` · `LIVE_VERIFIED` | x-api-key (regular API key); optional anthropic-workspace-id header | — | live_api · success · HTTP 200 | # xAI endpoints (104) ## xai · `account` (3) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/api-key` | Get API key info | `DOCUMENTED` · `LIVE_VERIFIED` | API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints … | — | live_api · success · HTTP 200 | | `GET` | `/v1/me` | Get current caller | `DOCUMENTED` · `LIVE_DISCOVERED` · `LIVE_VERIFIED` | API key or OAuth bearer | — | live_api · success · HTTP 200 | | `POST` | `/v1/tokenize-text` | Tokenize text | `DOCUMENTED` · `LIVE_VERIFIED` | API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints … | — | live_api · success · HTTP 200 | ## xai · `batches` (8) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/batches` | Batches: list | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `POST` | `/v1/batches` | Batches: create | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `GET` | `/v1/batches/{batch_id}` | Batches: get | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/batches/{batch_id}` | Batches: delete (not offered) | `LIVE_DISCOVERED` | Authorization: Bearer (inference API key; no version header) | — | live_api · failure · HTTP 405 | | `GET` | `/v1/batches/{batch_id}/requests` | Batches: list request metadata | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `POST` | `/v1/batches/{batch_id}/requests` | Batches: add requests | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `GET` | `/v1/batches/{batch_id}/results` | Batches: list results | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `POST` | `/v1/batches/{batch_id}:cancel` | Batches: cancel | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | ## xai · `chat_completions` (2) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/chat/completions` | Chat Completions: create | `DOCUMENTED` · `LEGACY` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `GET` | `/v1/chat/deferred-completion/{request_id}` | Chat Completions: fetch deferred result | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | ## xai · `collections` (13) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/collections` | Collections: list | `DOCUMENTED` · `LIVE_DISCOVERED` · `LIVE_VERIFIED` · `ACCOUNT_RESTRICTED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `POST` | `/v1/collections` | Collections: create | `DOCUMENTED` · `LIVE_DISCOVERED` · `LIVE_VERIFIED` · `ACCOUNT_RESTRICTED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `GET` | `/v1/collections/{collection_id}` | Collections: get | `DOCUMENTED` · `LIVE_DISCOVERED` · `LIVE_VERIFIED` · `ACCOUNT_RESTRICTED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `PUT` | `/v1/collections/{collection_id}` | Collections: update | `DOCUMENTED` · `LIVE_DISCOVERED` · `FAILED_VERIFICATION` · `ACCOUNT_RESTRICTED` | Authorization: Bearer (inference API key; no version header) | — | live_api · failure · HTTP 422 | | `DELETE` | `/v1/collections/{collection_id}` | Collections: delete | `DOCUMENTED` · `LIVE_DISCOVERED` · `LIVE_VERIFIED` · `ACCOUNT_RESTRICTED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `GET` | `/v1/collections/{collection_id}/documents` | Collections: list documents | `DOCUMENTED` · `LIVE_DISCOVERED` · `LIVE_VERIFIED` · `ACCOUNT_RESTRICTED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `POST` | `/v1/collections/{collection_id}/documents` | Collections: upload document (multipart, guide only) | `DOCUMENTED` · `FAILED_VERIFICATION` | Authorization: Bearer (inference API key; no version header) | — | live_api · failure · HTTP 405 | | `GET` | `/v1/collections/{collection_id}/documents/{file_id}` | Collections: get document | `DOCUMENTED` · `LIVE_DISCOVERED` · `LIVE_VERIFIED` · `ACCOUNT_RESTRICTED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `POST` | `/v1/collections/{collection_id}/documents/{file_id}` | Collections: add document | `DOCUMENTED` · `LIVE_DISCOVERED` · `LIVE_VERIFIED` · `ACCOUNT_RESTRICTED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `PATCH` | `/v1/collections/{collection_id}/documents/{file_id}` | Collections: reindex document | `DOCUMENTED` · `ACCOUNT_RESTRICTED` · `UNVERIFIED` | Authorization: Bearer (inference API key; no version header) | — | docs_only · success | | `DELETE` | `/v1/collections/{collection_id}/documents/{file_id}` | Collections: remove document | `DOCUMENTED` · `LIVE_DISCOVERED` · `LIVE_VERIFIED` · `ACCOUNT_RESTRICTED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `GET` | `/v1/collections/{collection_id}/documents:batchGet` | Collections: batch get documents | `DOCUMENTED` · `FAILED_VERIFICATION` · `ACCOUNT_RESTRICTED` | Authorization: Bearer (inference API key; no version header) | — | live_api · failure · HTTP 400 | | `POST` | `/v1/documents/search` | Collections: search documents | `DOCUMENTED` · `LIVE_VERIFIED` · `FAILED_VERIFICATION` | Authorization: Bearer (inference API key; no version header) | — | live_api · failure · HTTP 404 | ## xai · `embeddings` (1) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/embeddings` | Embeddings: create | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Authorization: Bearer (inference API key; no version header) | — | live_api · restricted · HTTP 404 | ## xai · `files` (10) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/files` | Files: list | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `POST` | `/v1/files` | Files: upload | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `GET` | `/v1/files/{file_id}` | Files: retrieve metadata | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `PUT` | `/v1/files/{file_id}` | Files: update (undocumented) | `DOCUMENTED` · `UNVERIFIED` | Authorization: Bearer (inference API key; no version header) | — | docs_only · success | | `DELETE` | `/v1/files/{file_id}` | Files: delete | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `GET` | `/v1/files/{file_id}/content` | Files: download content | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `POST` | `/v1/files/{file_id}/public-url` | Files: create public URL | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `POST` | `/v1/files/{file_id}/public-url/revoke` | Files: revoke public URL | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `POST` | `/v1/files:initialize` | Files: chunked upload initialize | `DOCUMENTED` · `UNVERIFIED` | Authorization: Bearer (inference API key; no version header) | — | docs_only · success | | `POST` | `/v1/files:uploadChunks` | Files: chunked upload chunks | `DOCUMENTED` · `UNVERIFIED` | Authorization: Bearer (inference API key; no version header) | — | docs_only · success | ## xai · `images` (2) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/images/edits` | Edit image(s) | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer xAI API key | — | live_api · success · HTTP 200 | | `POST` | `/v1/images/generations` | Generate image(s) | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer xAI API key | — | live_api · success · HTTP 200 | ## xai · `legacy` (2) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/complete` | Legacy Text Completions (Anthropic-compatible) — RETIRED in practice | `DOCUMENTED` · `LEGACY` · `DEPRECATED` · `RETIRED` | Authorization: Bearer (inference API key; no version header) | — | live_api · failure · HTTP 400 | | `POST` | `/v1/completions` | Legacy Completions (OpenAI-compatible) — RETIRED in practice | `DOCUMENTED` · `LEGACY` · `RETIRED` | Authorization: Bearer (inference API key; no version header) | — | live_api · failure · HTTP 400 | ## xai · `management` (21) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/audit/teams/{teamId}/events` | List audit events | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `DELETE` | `/auth/api-keys/{apiKeyId}` | Delete API key | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `GET` | `/auth/api-keys/{apiKeyId}/propagation` | Check key propagation | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `POST` | `/auth/api-keys/{apiKeyId}/rotate` | Rotate API key secret | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `PUT` | `/auth/api-keys/{api_key_id}` | Update API key | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `GET` | `/auth/management-keys/validation` | Validate management key | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | live_api · restricted · HTTP 401 | | `GET` | `/auth/teams/{teamId}/api-keys` | List API keys | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | live_api · restricted · HTTP 401 | | `POST` | `/auth/teams/{teamId}/api-keys` | Create API key | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `GET` | `/auth/teams/{teamId}/endpoints` | List endpoint ACLs | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `GET` | `/auth/teams/{teamId}/models` | List team models | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `GET` | `/v1/billing/teams/{team_id}/billing-info` | Get billing info | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `POST` | `/v1/billing/teams/{team_id}/billing-info` | Set billing info | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `GET` | `/v1/billing/teams/{team_id}/invoices` | List invoices | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `GET` | `/v1/billing/teams/{team_id}/payment-method` | List payment methods | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `POST` | `/v1/billing/teams/{team_id}/payment-method/default` | Set default payment method | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `GET` | `/v1/billing/teams/{team_id}/postpaid/invoice/preview` | Preview postpaid invoice | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `GET` | `/v1/billing/teams/{team_id}/postpaid/spending-limits` | Get postpaid spending limits | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `POST` | `/v1/billing/teams/{team_id}/postpaid/spending-limits` | Set postpaid spending limit | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `GET` | `/v1/billing/teams/{team_id}/prepaid/balance` | Get prepaid balance | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `POST` | `/v1/billing/teams/{team_id}/prepaid/top-up` | Top up prepaid credit | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | | `POST` | `/v1/billing/teams/{team_id}/usage` | Get usage | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference ke… | — | docs_only · restricted | ## xai · `messages_compat` (1) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/messages` | Messages (Anthropic-compatible) — DEPRECATED | `DOCUMENTED` · `DEPRECATED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | ## xai · `models` (10) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/embedding-models` | List embedding models | `DOCUMENTED` · `LIVE_VERIFIED` · `ACCOUNT_RESTRICTED` | API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints … | — | live_api · restricted · HTTP 200 | | `GET` | `/v1/embedding-models/{model_id}` | Get embedding model | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints … | — | live_api · restricted · HTTP 404 | | `GET` | `/v1/image-generation-models` | List image generation models | `DOCUMENTED` · `LIVE_VERIFIED` | API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints … | — | live_api · success · HTTP 200 | | `GET` | `/v1/image-generation-models/{model_id}` | Get image generation model | `DOCUMENTED` | API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints … | — | docs_only · not_tested | | `GET` | `/v1/language-models` | List language models | `DOCUMENTED` · `LIVE_VERIFIED` | API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints … | — | live_api · success · HTTP 200 | | `GET` | `/v1/language-models/{model_id}` | Get language model | `DOCUMENTED` · `LIVE_VERIFIED` | API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints … | — | live_api · success · HTTP 200 | | `GET` | `/v1/models` | List models | `DOCUMENTED` · `LIVE_VERIFIED` | API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints … | — | live_api · success · HTTP 200 | | `GET` | `/v1/models/{model_id}` | Get model | `DOCUMENTED` · `LIVE_VERIFIED` | API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints … | — | live_api · success · HTTP 200 | | `GET` | `/v1/video-generation-models` | List video generation models | `DOCUMENTED` · `LIVE_VERIFIED` | API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints … | — | live_api · success · HTTP 200 | | `GET` | `/v1/video-generation-models/{model_id}` | Get video generation model | `DOCUMENTED` · `LIVE_VERIFIED` | API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints … | — | live_api · success · HTTP 200 | ## xai · `responses` (5) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/responses` | Responses: create | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `POST` | `/v1/responses/compact` | Responses: compact context | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `GET` | `/v1/responses/{response_id}` | Responses: retrieve | `DOCUMENTED` · `LIVE_VERIFIED` · `LIVE_DISCOVERED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1/responses/{response_id}` | Responses: delete | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | | `GET` | `/v1/responses/{response_id}/input_items` | Responses: list input items | `DOCUMENTED` · `LIVE_VERIFIED` | Authorization: Bearer (inference API key; no version header) | — | live_api · success · HTTP 200 | ## xai · `skills` (5) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/skills` | List hosted skills | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Bearer xAI API key | — | live_api · restricted · HTTP 404 | | `POST` | `/v1/skills` | Upload hosted skill | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Bearer xAI API key | — | live_api · restricted · HTTP 404 | | `GET` | `/v1/skills/{skill_id}` | Retrieve hosted skill | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Bearer xAI API key | — | live_api · restricted · HTTP 404 | | `DELETE` | `/v1/skills/{skill_id}` | Delete hosted skill | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Bearer xAI API key | — | docs_only · not_tested | | `GET` | `/v1/skills/{skill_id}/content` | Download hosted skill content | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Bearer xAI API key | — | docs_only · not_tested | ## xai · `videos` (4) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/videos/edits` | Start video edit (async) | `DOCUMENTED` | Bearer xAI API key | — | live_api · failure · HTTP 422 | | `POST` | `/v1/videos/extensions` | Start video extension (async) | `DOCUMENTED` | Bearer xAI API key | — | docs_only · not_tested | | `POST` | `/v1/videos/generations` | Start video generation (async) | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer xAI API key | — | live_api · success · HTTP 200 | | `GET` | `/v1/videos/{request_id}` | Get deferred video result | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer xAI API key | — | live_api · success · HTTP 200 | ## xai · `voice` (17) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/custom-voices` | List custom voices | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer xAI API key | — | live_api · success · HTTP 200 | | `POST` | `/v1/custom-voices` | Create custom voice (clone) | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | Bearer xAI API key | — | docs_only · not_tested | | `GET` | `/v1/custom-voices/{voice_id}` | Get custom voice | `DOCUMENTED` | Bearer xAI API key | — | docs_only · not_tested | | `PATCH` | `/v1/custom-voices/{voice_id}` | Update custom voice metadata | `DOCUMENTED` | Bearer xAI API key | — | docs_only · not_tested | | `DELETE` | `/v1/custom-voices/{voice_id}` | Delete custom voice | `DOCUMENTED` | Bearer xAI API key | — | docs_only · not_tested | | `GET` | `/v1/custom-voices/{voice_id}/audio` | Download custom voice reference audio | `DOCUMENTED` | Bearer xAI API key | — | docs_only · not_tested | | `POST` | `/v1/realtime/calls/{call_id}/hangup` | Hang up SIP call | `DOCUMENTED` | Bearer xAI API key | — | docs_only · not_tested | | `POST` | `/v1/realtime/calls/{call_id}/refer` | Transfer SIP call (REFER) | `DOCUMENTED` | Bearer xAI API key | — | docs_only · not_tested | | `POST` | `/v1/realtime/client_secrets` | Create ephemeral client secret (voice) | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer xAI API key | — | live_api · success · HTTP 200 | | `POST` | `/v1/stt` | Speech to text (batch) | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer xAI API key | — | live_api · success · HTTP 200 | | `POST` | `/v1/tts` | Text to speech (unary) | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer xAI API key | — | live_api · success · HTTP 200 | | `GET` | `/v1/tts/voices` | List built-in voices | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer xAI API key | — | live_api · success · HTTP 200 | | `GET` | `/v1/tts/voices/{voice_id}` | Get built-in voice | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer xAI API key | — | live_api · success · HTTP 200 | | `POST` | `/v2/phone-numbers` | Create SIP phone number (voice) | `DOCUMENTED` | Bearer xAI API key | — | docs_only · not_tested | | `WS` | `wss://api.x.ai/v1/realtime` | Speech to Speech realtime session (WebSocket) | `DOCUMENTED` · `LIVE_VERIFIED` | Bearer API key (server) or ephemeral client secret (header or Sec-WebSocket-Protocol xai-client-secret. (server side only) | — | live_api · success · HTTP 200 | ## gemini · `batch` (9) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1beta/batches` | List batches | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · success · HTTP 200 | | `POST` | `/v1beta/models/{model}:asyncBatchEmbedContent` | Create an embedding batch | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · restricted · HTTP 400 | | `POST` | `/v1beta/models/{model}:batchGenerateContent` | Create a generateContent batch | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · restricted · HTTP 400 | | `POST` | `/v1beta/{model=tunedModels/*}:batchGenerateContent \| :asyncBatchEmbedContent` | Batch on tuned models | `DOCUMENTED` · `LEGACY` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | | `GET` | `/v1beta/{name=batches/*}` | Get batch (poll) | `DOCUMENTED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · failure · HTTP 400 | | `DELETE` | `/v1beta/{name=batches/*}` | Delete batch | `DOCUMENTED` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | | `POST` | `/v1beta/{name=batches/*}:cancel` | Cancel batch | `DOCUMENTED` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | | `PATCH` | `/v1beta/{name=batches/*}:updateEmbedContentBatch` | Update embedding batch | `DOCUMENTED` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | | `PATCH` | `/v1beta/{name=batches/*}:updateGenerateContentBatch` | Update generateContent batch | `DOCUMENTED` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | ## gemini · `caching` (5) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1beta/cachedContents` | List cached contents | `DOCUMENTED` · `BETA` · `ACCOUNT_RESTRICTED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP 200 | | `POST` | `/v1beta/cachedContents` | Create cached content (explicit context caching) | `DOCUMENTED` · `BETA` · `ACCOUNT_RESTRICTED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · restricted · HTTP [429, 400] | | `GET` | `/v1beta/cachedContents/{id}` | Get cached content | `DOCUMENTED` · `BETA` · `ACCOUNT_RESTRICTED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP 200 | | `PATCH` | `/v1beta/cachedContents/{id}` | Update cached content (TTL / expireTime only) | `DOCUMENTED` · `BETA` · `ACCOUNT_RESTRICTED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP 200 | | `DELETE` | `/v1beta/cachedContents/{id}` | Delete cached content | `DOCUMENTED` · `BETA` · `ACCOUNT_RESTRICTED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP 200 | ## gemini · `credentials` (5) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1beta/credentials` | List credentials | `DOCUMENTED` · `BETA` · `PREVIEW` | x-goog-api-key header | — | docs_only · not_tested | | `POST` | `/v1beta/credentials` | Create credential | `DOCUMENTED` · `BETA` · `PREVIEW` | x-goog-api-key header | — | docs_only · not_tested | | `GET` | `/v1beta/credentials/{id}` | Get credential | `DOCUMENTED` · `BETA` · `PREVIEW` | x-goog-api-key header | — | docs_only · not_tested | | `PATCH` | `/v1beta/credentials/{id}` | Update (rotate) credential | `DOCUMENTED` · `BETA` · `PREVIEW` | x-goog-api-key header | — | docs_only · not_tested | | `DELETE` | `/v1beta/credentials/{id}` | Delete credential | `DOCUMENTED` · `BETA` · `PREVIEW` | x-goog-api-key header | — | docs_only · not_tested | ## gemini · `dynamic` (2) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1beta/dynamic/{dynamicId}:generateContent` | dynamic.generateContent | `DOCUMENTED` · `BETA` · `UNVERIFIED` · `DOCUMENTATION_INCOMPLETE` | x-goog-api-key header | — | docs_only · not_tested | | `POST` | `/v1beta/dynamic/{dynamicId}:streamGenerateContent` | dynamic.streamGenerateContent | `DOCUMENTED` · `BETA` · `UNVERIFIED` · `DOCUMENTATION_INCOMPLETE` | x-goog-api-key header | — | docs_only · not_tested | ## gemini · `embeddings` (2) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1beta/models/{model}:batchEmbedContents` | Batch embed contents (synchronous) | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP 200 | | `POST` | `/v1beta/models/{model}:embedContent` | Embed content | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP 200 | ## gemini · `environments` (7) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `PUT` | `/upload/v1beta/environments/{environment}/files/{path}` | Upload file / extract archive into environment | `DOCUMENTED` · `BETA` · `PREVIEW` | x-goog-api-key header | — | docs_only · not_tested | | `GET` | `/v1beta/environments` | List environments | `DOCUMENTED` · `BETA` · `PREVIEW` · `LIVE_VERIFIED` | x-goog-api-key header | — | live_api · success · HTTP 200 | | `POST` | `/v1beta/environments` | Create environment (sandbox) | `DOCUMENTED` · `BETA` · `PREVIEW` · `LIVE_VERIFIED` | x-goog-api-key header | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/environments/{environment}/files/{path}` | Get environment files (list directory / file metadata / download) | `DOCUMENTED` · `BETA` · `PREVIEW` · `LIVE_VERIFIED` | x-goog-api-key header | — | live_api · partial · HTTP 200 | | `GET` | `/v1beta/environments/{id}` | Get environment | `DOCUMENTED` · `BETA` · `PREVIEW` · `LIVE_VERIFIED` | x-goog-api-key header | — | live_api · success · HTTP 200 | | `DELETE` | `/v1beta/environments/{id}` | Delete environment | `DOCUMENTED` · `BETA` · `PREVIEW` · `LIVE_VERIFIED` | x-goog-api-key header | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/files/environment-{environment}:download` | Download environment snapshot (legacy Files API form) | `DOCUMENTED` · `LEGACY` · `PREVIEW` | x-goog-api-key header | — | docs_only · not_tested | ## gemini · `file-search` (12) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore` | media.uploadToFileSearchStore | `DOCUMENTED` · `PREVIEW` · `LIVE_VERIFIED` | x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted) | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/fileSearchStores` | fileSearchStores.list | `DOCUMENTED` · `PREVIEW` · `LIVE_VERIFIED` | x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted) | — | live_api · success · HTTP 200 | | `POST` | `/v1beta/fileSearchStores` | fileSearchStores.create | `DOCUMENTED` · `PREVIEW` · `LIVE_VERIFIED` | x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted) | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/fileSearchStores/{name}` | fileSearchStores.get | `DOCUMENTED` · `PREVIEW` · `LIVE_VERIFIED` | x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1beta/fileSearchStores/{name}` | fileSearchStores.delete | `DOCUMENTED` · `PREVIEW` · `LIVE_VERIFIED` | x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted) | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/fileSearchStores/{name}/documents` | fileSearchStores.documents.list | `DOCUMENTED` · `PREVIEW` · `LIVE_VERIFIED` | x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted) | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/fileSearchStores/{name}/documents/{document}` | fileSearchStores.documents.get | `DOCUMENTED` · `PREVIEW` · `LIVE_VERIFIED` | x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted) | — | live_api · success · HTTP 200 | | `DELETE` | `/v1beta/fileSearchStores/{name}/documents/{document}` | fileSearchStores.documents.delete | `DOCUMENTED` · `PREVIEW` · `LIVE_VERIFIED` | x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted) | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/fileSearchStores/{name}/media/{blob}` | fileSearchStores.media.download (mediaId) | `DOCUMENTED` · `PREVIEW` · `DOCUMENTATION_INCOMPLETE` · `UNVERIFIED` | x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted) | — | docs_only · not_tested | | `GET` | `/v1beta/fileSearchStores/{name}/operations/{operation}` | fileSearchStores.operations.get | `DOCUMENTED` · `PREVIEW` | x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted) | — | docs_only · not_tested | | `GET` | `/v1beta/fileSearchStores/{name}/upload/operations/{operation}` | fileSearchStores.upload.operations.get | `DOCUMENTED` · `PREVIEW` · `LIVE_VERIFIED` | x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted) | — | live_api · success · HTTP 200 | | `POST` | `/v1beta/fileSearchStores/{name}:importFile` | fileSearchStores.importFile | `DOCUMENTED` · `PREVIEW` | x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted) | — | docs_only · not_tested | ## gemini · `files` (8) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/upload/v1beta/files` | Upload a file (media.upload) | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/files` | List files | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/files/{file}:download?alt=media (via generatedSamples[].video.uri)` | Download a generated video | `DOCUMENTED` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | | `GET` | `/v1beta/files/{id}` | Get file metadata | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP [200, 403] | | `DELETE` | `/v1beta/files/{id}` | Delete file | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP 200 | | `POST` | `/v1beta/files:register` | Register Google Cloud Storage objects as Files | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/generatedFiles` | List generated files | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/generatedFiles/{id}/operations/{operation}` | Get generated-file operation | `LIVE_DISCOVERED` · `UNVERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | docs_only · success | ## gemini · `generate-content` (4) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/models/{model}:generateContent` | Generate content (stable v1) | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP 200 | | `POST` | `/v1beta/dynamic/{id}:generateContent` | Generate content on a `dynamic/*` resource | `LIVE_DISCOVERED` · `UNVERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · failure · HTTP 404 | | `POST` | `/v1beta/dynamic/{id}:streamGenerateContent` | Stream generate content on a `dynamic/*` resource | `LIVE_DISCOVERED` · `UNVERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | docs_only · success | | `POST` | `/v1beta/models/{model}:streamGenerateContent` | Stream generate content | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP 200 | ## gemini · `image-generation` (1) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1beta/models/{model}:predict` | Predict (Imagen — shut down) | `DOCUMENTED` · `RETIRED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · failure · HTTP 404 | ## gemini · `interactions` (9) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1/interactions` | Create interaction (v1) | `DOCUMENTED` · `GA` · `UNVERIFIED` | x-goog-api-key header | — | docs_only · not_tested | | `GET` | `/v1/interactions/{id}` | Get interaction (v1) | `DOCUMENTED` · `GA` · `UNVERIFIED` | x-goog-api-key header | — | docs_only · not_tested | | `DELETE` | `/v1/interactions/{id}` | Delete interaction (v1) | `DOCUMENTED` · `GA` · `UNVERIFIED` | x-goog-api-key header | — | docs_only · not_tested | | `POST` | `/v1/interactions/{id}/cancel` | Cancel interaction (v1) | `DOCUMENTED` · `GA` · `UNVERIFIED` | x-goog-api-key header | — | docs_only · not_tested | | `GET` | `/v1beta/interactions` | List interactions (probe) | `UNVERIFIED` · `FAILED_VERIFICATION` | x-goog-api-key header | — | live_api · failure · HTTP 404 | | `POST` | `/v1beta/interactions` | Create interaction | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-goog-api-key header | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/interactions/{id}` | Get interaction (poll or resume stream) | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-goog-api-key header | — | live_api · success · HTTP 200 | | `DELETE` | `/v1beta/interactions/{id}` | Delete interaction | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-goog-api-key header | — | live_api · success · HTTP 200 | | `POST` | `/v1beta/interactions/{id}/cancel` | Cancel interaction | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-goog-api-key header | — | live_api · success · HTTP 200 | ## gemini · `legacy-palm` (7) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1beta/models/{model}:batchEmbedText` | PaLM legacy: batchEmbedText | `LEGACY` · `DOCUMENTED` · `UNVERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | docs_only · success | | `POST` | `/v1beta/models/{model}:countMessageTokens` | PaLM legacy: countMessageTokens | `LEGACY` · `DOCUMENTED` · `FAILED_VERIFICATION` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · failure · HTTP 501 | | `POST` | `/v1beta/models/{model}:countTextTokens` | PaLM legacy: countTextTokens | `LEGACY` · `DOCUMENTED` · `FAILED_VERIFICATION` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · failure · HTTP 404 | | `POST` | `/v1beta/models/{model}:embedText` | PaLM legacy: embedText | `LEGACY` · `DOCUMENTED` · `FAILED_VERIFICATION` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · failure · HTTP 404 | | `POST` | `/v1beta/models/{model}:generateAnswer` | Attributed Question Answering (model `aqa`) | `LEGACY` · `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP 200 | | `POST` | `/v1beta/models/{model}:generateMessage` | PaLM legacy: generateMessage | `LEGACY` · `DOCUMENTED` · `FAILED_VERIFICATION` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · failure · HTTP 501 | | `POST` | `/v1beta/models/{model}:generateText` | PaLM legacy: generateText | `LEGACY` · `DOCUMENTED` · `FAILED_VERIFICATION` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · failure · HTTP 404 | ## gemini · `live` (3) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `WSS` | `/ws/google.ai.generativelanguage.v1alpha.GenerativeService.BidiGenerateContent` | BidiGenerateContent (v1alpha URL variant) | `DOCUMENTED` · `LIVE_VERIFIED` | ?key=API_KEY (query) | — | live_api · failure | | `WSS` | `/ws/google.ai.generativelanguage.v1beta.GenerativeService.BidiGenerateContent` | BidiGenerateContent | `DOCUMENTED` · `PREVIEW` · `LIVE_VERIFIED` | API key as URL query parameter `?key=YOUR_API_KEY` (documented raw-WebSocket form); SDKs send the key for y… | — | live_api · success · HTTP 101 | | `WSS` | `/ws/google.ai.generativelanguage.v1beta.GenerativeService.BidiGenerateContentConstrained` | BidiGenerateContentConstrained (ephemeral-token Live endpoint) | `DOCUMENTED` · `PREVIEW` · `LIVE_VERIFIED` | Ephemeral token via query `?access_token=` (documented) or header `Authorization: Token ` (re… | — | live_api · success · HTTP 101 | ## gemini · `models` (3) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/models` | models.list (v1 stable surface) | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/models` | models.list | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key \| ?key= \| OAuth Bearer | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/models/{model}` | models.get | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key \| OAuth Bearer | — | live_api · success · HTTP 200 | ## gemini · `music-generation` (1) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `WS` | `wss://generativelanguage.googleapis.com/ws/google.ai.generativelanguage.v1beta.GenerativeService.BidiGenerateMusic` | Lyria RealTime (WebSocket) | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · success · HTTP 101 | ## gemini · `openai-compat` (7) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1beta/openai/batches` | OpenAI-compatible Batch API | `DOCUMENTED` · `BETA` | Authorization: Bearer | — | docs_only · not_tested | | `POST` | `/v1beta/openai/chat/completions` | OpenAI-compatible chat completions | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Authorization: Bearer | — | live_api · success · HTTP 200 | | `POST` | `/v1beta/openai/embeddings` | OpenAI-compatible embeddings | `DOCUMENTED` · `BETA` | Authorization: Bearer | — | docs_only · not_tested | | `POST` | `/v1beta/openai/images/generations` | OpenAI-compatible image generation | `DOCUMENTED` · `BETA` | Authorization: Bearer | — | docs_only · not_tested | | `GET` | `/v1beta/openai/models` | OpenAI-compatible models list | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Authorization: Bearer (x-goog-api-key -> 404 'Requested entity was not found.') | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/openai/models/{model}` | OpenAI-compatible model retrieve | `DOCUMENTED` · `BETA` · `LIVE_VERIFIED` | Authorization: Bearer | — | live_api · success · HTTP 200 | | `POST` | `/v1beta/openai/videos` | OpenAI (Sora-style) compatible video generation | `DOCUMENTED` · `BETA` | Authorization: Bearer | — | docs_only · not_tested | ## gemini · `operations` (6) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1beta/{name=fileSearchStores/*/operations/*} \| /v1beta/{name=fileSearchStores/*/upload/operations/*} \| /v1beta/{name=corpora/*/operations/*}` | Other operation scopes (cross-reference) | `DOCUMENTED` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | | `GET` | `/v1beta/{name=generatedFiles/*/operations/*}` | Get generatedFiles operation | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · failure · HTTP 400 | | `GET` | `/v1beta/{name=models/*/operations/*}` | Get model operation (Veo polling) | `DOCUMENTED` · `ACCOUNT_RESTRICTED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · restricted · HTTP 403 | | `GET` | `/v1beta/{name=models/*}/operations` | List model operations | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · success · HTTP 200 | | `GET` | `/v1beta/{name=tunedModels/*/operations/*}` | Get tuning operation | `DOCUMENTED` · `LEGACY` · `LIVE_VERIFIED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · failure · HTTP 400 | | `GET` | `/v1beta/{name=tunedModels/*}/operations` | List tuning operations | `DOCUMENTED` · `LEGACY` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | ## gemini · `tokens` (1) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1beta/models/{model}:countTokens` | Count tokens | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never… | — | live_api · success · HTTP 200 | ## gemini · `transcription` (1) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1beta/models/{model}:generateContent` | Transcribe audio (gemini-3.5-transcribe) | `DOCUMENTED` · `LIVE_VERIFIED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · success · HTTP 200 | ## gemini · `triggers` (7) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1beta/triggers` | List triggers | `DOCUMENTED` · `BETA` · `PREVIEW` | x-goog-api-key header | — | docs_only · not_tested | | `POST` | `/v1beta/triggers` | Create trigger (cron-scheduled agent run) | `DOCUMENTED` · `BETA` · `PREVIEW` | x-goog-api-key header | — | docs_only · not_tested | | `GET` | `/v1beta/triggers/{id}` | Get trigger | `DOCUMENTED` · `BETA` · `PREVIEW` | x-goog-api-key header | — | docs_only · not_tested | | `PATCH` | `/v1beta/triggers/{id}` | Update trigger (pause / resume) | `DOCUMENTED` · `BETA` · `PREVIEW` | x-goog-api-key header | — | docs_only · not_tested | | `DELETE` | `/v1beta/triggers/{id}` | Delete trigger | `DOCUMENTED` · `BETA` · `PREVIEW` | x-goog-api-key header | — | docs_only · not_tested | | `GET` | `/v1beta/triggers/{id}/executions` | List trigger executions | `DOCUMENTED` · `BETA` · `PREVIEW` | x-goog-api-key header | — | docs_only · not_tested | | `POST` | `/v1beta/triggers/{id}/executions` | Run trigger now | `DOCUMENTED` · `BETA` · `PREVIEW` | x-goog-api-key header | — | docs_only · not_tested | ## gemini · `tuning` (12) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1beta/tunedModels` | List tuned models | `DOCUMENTED` · `LEGACY` · `RETIRED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · failure · HTTP 501 | | `POST` | `/v1beta/tunedModels` | Create tuned model | `DOCUMENTED` · `DEPRECATED` · `RETIRED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · failure · HTTP 501 | | `POST` | `/v1beta/{model=tunedModels/*}:generateContent` | Generate with a tuned model | `DOCUMENTED` · `LEGACY` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | | `GET` | `/v1beta/{name=tunedModels/*/permissions/*}` | Get permission | `DOCUMENTED` · `LEGACY` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | | `PATCH` | `/v1beta/{name=tunedModels/*/permissions/*}` | Update permission | `DOCUMENTED` · `LEGACY` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | | `DELETE` | `/v1beta/{name=tunedModels/*/permissions/*}` | Delete permission | `DOCUMENTED` · `LEGACY` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | | `GET` | `/v1beta/{name=tunedModels/*}` | Get tuned model | `DOCUMENTED` · `LEGACY` · `RETIRED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · failure · HTTP 501 | | `DELETE` | `/v1beta/{name=tunedModels/*}` | Delete tuned model | `DOCUMENTED` · `LEGACY` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | | `POST` | `/v1beta/{name=tunedModels/*}:transferOwnership` | Transfer ownership | `DOCUMENTED` · `LEGACY` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | | `GET` | `/v1beta/{parent=tunedModels/*}/permissions` | List permissions | `DOCUMENTED` · `LEGACY` · `RETIRED` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · failure · HTTP 501 | | `POST` | `/v1beta/{parent=tunedModels/*}/permissions` | Create permission | `DOCUMENTED` · `LEGACY` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | | `PATCH` | `/v1beta/{tunedModel.name=tunedModels/*}` | Update tuned model | `DOCUMENTED` · `LEGACY` | x-goog-api-key header (API key); never put the key in the URL | — | docs only | ## gemini · `video-generation` (1) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `POST` | `/v1beta/models/{model}:predictLongRunning` | Generate video (Veo, long-running) | `DOCUMENTED` · `PREVIEW` | x-goog-api-key header (API key); never put the key in the URL | — | live_api · failure · HTTP 400 | ## gemini · `webhooks` (7) | Method | Path | Name | Status | Auth | Beta header | Verification | |---|---|---|---|---|---|---| | `GET` | `/v1/webhooks` | List webhooks | `DOCUMENTED` · `BETA` | x-goog-api-key header | — | docs_only · not_tested | | `POST` | `/v1/webhooks` | Create webhook | `DOCUMENTED` · `BETA` | x-goog-api-key header | — | docs_only · not_tested | | `GET` | `/v1/webhooks/{id}` | Get webhook | `DOCUMENTED` · `BETA` | x-goog-api-key header | — | docs_only · not_tested | | `PATCH` | `/v1/webhooks/{id}` | Update webhook | `DOCUMENTED` · `BETA` | x-goog-api-key header | — | docs_only · not_tested | | `DELETE` | `/v1/webhooks/{id}` | Delete webhook | `DOCUMENTED` · `BETA` | x-goog-api-key header | — | docs_only · not_tested | | `POST` | `/v1/webhooks/{id}/rotate_secret` | Rotate webhook signing secret | `DOCUMENTED` · `BETA` | x-goog-api-key header | — | docs_only · not_tested | | `POST` | `/v1/webhooks/{id}:ping` | Ping webhook (SDK-only) | `UNVERIFIED` · `DOCUMENTATION_INCOMPLETE` | x-goog-api-key header | — | docs_only · not_tested | --- Related: [by-status view](by-status.md) · [feature matrix](../comparisons/features.md) · `generated/endpoints.csv` · `generated/parameters.json` (per-endpoint parameters, key = `endpoint` field `METHOD /path`).