[ { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/analytics/apps/chat/projects", "name": "Get Chat Project Usage", "description": "Get per-project activity for a given day, with cursor-based pagination. Returns activity metrics for each project in the organization, sorted by project ID. Use `group_by[]` to break projects out per member or per RBAC group, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "date", "ending_date", "filter", "group_by", "limit", "order", "order_by", "page", "starting_date" ] }, "response": { "type": "BetaChatProjectUsage object", "content_type": "application/json", "example": { "data": [ { "distinct_user_count": 0, "message_count": 0, "project_id": "project_id", "project_name": "project_name", "created_at": "2019-12-27T18:11:19.117Z", "created_by": { "id": "id", "email_address": "email_address", "type": "user" }, "distinct_conversation_count": 0, "product": "product", "rbac_group_id": "rbac_group_id", "rbac_group_name": "rbac_group_name", "user_id": "user_id" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/chat_projects/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/chat_projects", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/analytics/artifacts", "name": "Get Artifact Activity", "description": "Get artifact-creation activity for a given day, broken out by MIME type. Returns the full (`artifact_type`, `is_shared`) cube for the organization; `next_page` is null except for grouped queries, which paginate. The cube can be broken out per product, per member, or per RBAC group via `group_by[]`, and scoped via `filter[]`. Requires an API key with the `read:analytics` scope.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "date", "filter", "group_by", "limit", "page" ] }, "response": { "type": "BetaArtifactUsage object", "content_type": "application/json", "example": { "data": [ { "artifact_type": "artifact_type", "artifacts_created_count": 0, "distinct_user_count": 0, "is_shared": true, "published_artifacts_created_count": 0, "product": "product", "rbac_group_id": "rbac_group_id", "rbac_group_name": "rbac_group_name", "user_id": "user_id" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/artifacts/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/artifacts", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/analytics/connectors", "name": "Get Connector Usage", "description": "Get per-connector usage for a given day, with cursor-based pagination. Returns connector usage metrics for the organization, sorted by connector name. Connector names are normalized from their various sources — for example, \"Atlassian MCP server\" and \"mcp-atlassian\" both appear as \"atlassian\". Use `group_by[]` to break usage out per member, per RBAC group, or per product surface, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "date", "ending_date", "filter", "group_by", "limit", "order", "order_by", "page", "starting_date" ] }, "response": { "type": "BetaConnectorUsage object", "content_type": "application/json", "example": { "data": [ { "chat_metrics": { "distinct_conversation_connector_used_count": 0 }, "claude_code_metrics": { "distinct_session_connector_used_count": 0 }, "connector_name": "connector_name", "cowork_metrics": { "distinct_session_connector_used_count": 0 }, "distinct_user_count": 0, "office_metrics": { "excel": { "distinct_session_connector_used_count": 0 }, "outlook": { "distinct_session_connector_used_count": 0 }, "powerpoint": { "distinct_session_connector_used_count": 0 }, "word": { "distinct_session_connector_used_count": 0 } }, "connector_display_name": "connector_display_name", "individual_auth_distinct_user_count": 0, "managed_auth_distinct_user_count": 0, "product": "product", "rbac_group_id": "rbac_group_id", "rbac_group_name": "rbac_group_name", "read_call_count": 0, "unclassified_call_count": 0, "user_id": "user_id", "write_call_count": 0 } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/analytics/cost_report", "name": "Get Cost Over Time", "description": "Get cost in USD over time across a date range. Returns cost bucketed by minute, hour, or day, optionally broken down by product, model, context window, inference region, speed, cost type, or token type. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "starting_at", "bucket_width", "claude_tag_categories", "claude_tag_user_ids", "context_windows", "ending_at", "group_by", "inference_geos", "limit", "models", "page", "products", "rbac_group_ids", "slack_channel_ids", "speeds", "user_ids" ] }, "response": { "type": "BetaCostBucket object", "content_type": "application/json", "example": { "data": [ { "ending_at": "2019-12-27T18:11:19.117Z", "results": [ { "amount": "amount", "claude_tag_category": "dm", "claude_tag_user_id": "U0123ABCDEF", "context_window": "0-200k", "cost_type": "code_execution", "currency": "USD", "inference_geo": "global", "list_amount": "list_amount", "model": "claude-opus-5", "product": "chat", "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "requests": 0, "slack_channel_id": "C0123ABCDEF", "speed": "fast", "token_type": "cache_creation.ephemeral_1h_input_tokens" } ], "starting_at": "2019-12-27T18:11:19.117Z" } ], "data_refreshed_at": "2019-12-27T18:11:19.117Z", "has_more": true, "next_page": "next_page", "organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/analytics/plugins", "name": "Get Plugin Usage", "description": "Get per-plugin install + invocation usage for a given day, with pagination. Returns plugin usage metrics for the organization across Cowork and Claude Code, sorted by plugin name. The `plugin_name` value `third-party` is an aggregate bucket, not a plugin: it collects plugin activity, from either surface, for which the reporting client did not provide a plugin name — so an organization's own plugins can contribute both to their own named rows and to this bucket. Use `group_by[]` to break usage out per member, per RBAC group, or per product surface (Cowork / Claude Code), and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Requires an API key with the `read:analytics` scope. `starting_date` / `ending_date` select range-rollup mode like `/skills`.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "date", "ending_date", "filter", "group_by", "limit", "order", "order_by", "page", "starting_date" ] }, "response": { "type": "BetaPluginUsage object", "content_type": "application/json", "example": { "data": [ { "claude_code_metrics": { "distinct_session_plugin_used_count": 0 }, "cowork_metrics": { "distinct_session_plugin_used_count": 0 }, "distinct_user_count": 0, "install_count": 0, "invocation_count": 0, "plugin_name": "plugin_name", "plugin_id": "plugin_id", "product": "product", "rbac_group_id": "rbac_group_id", "rbac_group_name": "rbac_group_name", "user_id": "user_id" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/analytics/skills", "name": "Get Skill Usage", "description": "Get per-skill usage for a given day, with cursor-based pagination. Returns skill usage metrics for the organization, sorted by skill name. Use `group_by[]` to break usage out per member, per RBAC group, or per product surface, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "date", "ending_date", "filter", "group_by", "limit", "order", "order_by", "page", "starting_date" ] }, "response": { "type": "BetaSkillUsage object", "content_type": "application/json", "example": { "data": [ { "chat_metrics": { "distinct_conversation_skill_used_count": 0 }, "claude_code_metrics": { "distinct_session_skill_used_count": 0 }, "cowork_metrics": { "distinct_session_skill_used_count": 0 }, "distinct_user_count": 0, "office_metrics": { "excel": { "distinct_session_skill_used_count": 0 }, "outlook": { "distinct_session_skill_used_count": 0 }, "powerpoint": { "distinct_session_skill_used_count": 0 }, "word": { "distinct_session_skill_used_count": 0 } }, "skill_name": "skill_name", "attributed_list_price": "attributed_list_price", "currency": "USD", "enable_count": 0, "estimated_overage_spend": "estimated_overage_spend", "invocation_count": 0, "product": "product", "rbac_group_id": "rbac_group_id", "rbac_group_name": "rbac_group_name", "share_status": "organization", "skill_display_name": "skill_display_name", "user_id": "user_id" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/skills/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/skills", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/analytics/summaries", "name": "Get Activity Summaries", "description": "Get organization-wide activity summaries for a date range. Returns one entry per day from `starting_date` (inclusive) to `ending_date` (exclusive). Data is typically available with a 1-day lag and may be revised by a few percent over the following days: when `ending_date` is omitted it defaults to the most recent available day + 1, so the last entry covers the most recent available day. The series can be scoped to an RBAC group via `filter[]=rbac_group_id:{id}`. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "starting_date", "ending_date", "filter" ] }, "response": { "type": "BetaActivitySummary object", "content_type": "application/json", "example": { "summaries": [ { "assigned_seat_count": 0, "cowork_daily_active_user_count": 0, "cowork_monthly_active_user_count": 0, "cowork_weekly_active_user_count": 0, "daily_active_user_count": 0, "daily_adoption_rate": 0, "ending_at": "2019-12-27T18:11:19.117Z", "monthly_active_user_count": 0, "monthly_adoption_rate": 0, "pending_invite_count": 0, "starting_at": "2019-12-27T18:11:19.117Z", "weekly_active_user_count": 0, "weekly_adoption_rate": 0, "chat_daily_active_user_count": 0, "chat_monthly_active_user_count": 0, "chat_weekly_active_user_count": 0, "claude_code_daily_active_user_count": 0, "claude_code_monthly_active_user_count": 0, "claude_code_weekly_active_user_count": 0, "claude_design_daily_active_user_count": 0, "claude_design_monthly_active_user_count": 0, "claude_design_weekly_active_user_count": 0, "office_agent_daily_active_user_count": 0, "office_agent_monthly_active_user_count": 0, "office_agent_weekly_active_user_count": 0, "science_daily_active_user_count": 0, "science_entitled_user_count": 0, "science_monthly_active_user_count": 0, "science_weekly_active_user_count": 0 } ] } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/retrieve_summaries", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/analytics/usage_report", "name": "Get Token Usage Over Time", "description": "Get token usage over time across a date range. Returns token usage bucketed by minute, hour, or day, optionally broken down by product, model, context window, inference region, or speed. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "starting_at", "bucket_width", "claude_tag_categories", "claude_tag_user_ids", "context_windows", "ending_at", "group_by", "inference_geos", "limit", "models", "page", "products", "rbac_group_ids", "slack_channel_ids", "speeds", "user_ids" ] }, "response": { "type": "BetaUsageBucket object", "content_type": "application/json", "example": { "data": [ { "ending_at": "2019-12-27T18:11:19.117Z", "results": [ { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "claude_tag_category": "dm", "claude_tag_user_id": "U0123ABCDEF", "context_window": "0-200k", "inference_geo": "global", "model": "claude-opus-5", "output_tokens": 0, "product": "chat", "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "requests": 0, "server_tool_use": { "web_search_requests": 10 }, "slack_channel_id": "C0123ABCDEF", "speed": "fast", "uncached_input_tokens": 0 } ], "starting_at": "2019-12-27T18:11:19.117Z" } ], "data_refreshed_at": "2019-12-27T18:11:19.117Z", "has_more": true, "next_page": "next_page", "organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/analytics/user_cost_report", "name": "Get Per-User Cost", "description": "Get per-user cost in USD across a date range. Returns one row per user, ranked by spend. Use this to see which users account for the most cost. Only cost attributable to a seat user is included; for organization-wide totals including direct API-key and automation traffic, use the bucketed `/v1/organizations/analytics/cost_report` endpoint. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "starting_at", "bucket_width", "claude_tag_categories", "claude_tag_user_ids", "context_windows", "ending_at", "exclude_deleted_users", "group_by", "inference_geos", "limit", "models", "order", "order_by", "page", "products", "rbac_group_ids", "slack_channel_ids", "speeds", "user_ids" ] }, "response": { "type": "BetaUserCost object", "content_type": "application/json", "example": { "data": [ { "actor": { "deleted": true, "email": "jane@example.com", "name": "Jane Smith", "type": "user_actor", "user_id": "user_01AbCdEfGhIjKlMnOpQrSt" }, "amount": "41280.000000", "claude_tag_category": "dm", "claude_tag_user_id": "U0123ABCDEF", "context_window": "0-200k", "cost_type": "code_execution", "currency": "USD", "ending_at": "2019-12-27T18:11:19.117Z", "inference_geo": "global", "list_amount": "51600.000000", "model": "claude-opus-5", "product": "chat", "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "requests": 128, "slack_channel_id": "C0123ABCDEF", "speed": "fast", "starting_at": "2019-12-27T18:11:19.117Z", "token_type": "cache_creation.ephemeral_1h_input_tokens" } ], "data_refreshed_at": "2019-12-27T18:11:19.117Z", "has_more": true, "next_page": "next_page", "organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/analytics/user_usage_report", "name": "Get Per-User Token Usage", "description": "Get per-user token usage across a date range. Returns one row per user, ranked by the chosen token metric. Use this to see which users consume the most tokens. Only usage attributable to a seat user is included; for organization-wide totals including direct API-key and automation traffic, use the bucketed `/v1/organizations/analytics/usage_report` endpoint. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "starting_at", "bucket_width", "claude_tag_categories", "claude_tag_user_ids", "context_windows", "ending_at", "exclude_deleted_users", "group_by", "inference_geos", "limit", "models", "order", "order_by", "page", "products", "rbac_group_ids", "slack_channel_ids", "speeds", "user_ids" ] }, "response": { "type": "BetaUserUsage object", "content_type": "application/json", "example": { "data": [ { "actor": { "deleted": true, "email": "jane@example.com", "name": "Jane Smith", "type": "user_actor", "user_id": "user_01AbCdEfGhIjKlMnOpQrSt" }, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 3200000, "claude_tag_category": "dm", "claude_tag_user_id": "U0123ABCDEF", "context_window": "0-200k", "ending_at": "2019-12-27T18:11:19.117Z", "inference_geo": "global", "model": "claude-opus-5", "output_tokens": 891000, "product": "chat", "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "requests": 128, "server_tool_use": { "web_search_requests": 10 }, "slack_channel_id": "C0123ABCDEF", "speed": "fast", "starting_at": "2019-12-27T18:11:19.117Z", "total_tokens": 5377000, "uncached_input_tokens": 1284500 } ], "data_refreshed_at": "2019-12-27T18:11:19.117Z", "has_more": true, "next_page": "next_page", "organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/analytics/users", "name": "List User Activity", "description": "Get per-user activity for a given day, with cursor-based pagination. Returns activity metrics for each user in the organization, sorted by email address. Use `group_by[]` for per-RBAC-group aggregates, or `filter[]` to scope results to specific members, groups, or a chat project. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "date", "ending_date", "filter", "group_by", "limit", "order", "order_by", "page", "starting_date" ] }, "response": { "type": "BetaUserActivity object", "content_type": "application/json", "example": { "data": [ { "chat_metrics": { "connectors_used_count": 0, "distinct_artifacts_created_count": 0, "distinct_connectors_used_count": 0, "distinct_conversation_count": 0, "distinct_files_uploaded_count": 0, "distinct_projects_created_count": 0, "distinct_projects_used_count": 0, "distinct_shared_artifacts_viewed_count": 0, "distinct_skills_used_count": 0, "message_count": 0, "shared_conversations_viewed_count": 0, "thinking_message_count": 0 }, "claude_code_metrics": { "core_metrics": { "artifacts_created_count": 0, "commit_count": 0, "distinct_session_count": 0, "lines_of_code": { "added_count": 0, "removed_count": 0 }, "pull_request_count": 0 }, "tool_actions": { "edit_tool": { "accepted_count": 0, "rejected_count": 0 }, "multi_edit_tool": { "accepted_count": 0, "rejected_count": 0 }, "notebook_edit_tool": { "accepted_count": 0, "rejected_count": 0 }, "write_tool": { "accepted_count": 0, "rejected_count": 0 } } }, "cowork_metrics": { "action_count": 0, "artifacts_created_count": 0, "connectors_used_count": 0, "dispatch_turn_count": 0, "distinct_connectors_used_count": 0, "distinct_session_count": 0, "distinct_skills_used_count": 0, "message_count": 0, "skills_used_count": 0, "distinct_plugins_used_count": 0, "edit_tool_count": 0, "file_edit_count": 0, "multi_edit_tool_count": 0, "notebook_edit_tool_count": 0, "plugins_used_count": 0, "sessions_with_file_edits_count": 0, "write_tool_count": 0 }, "design_metrics": { "distinct_projects_created_count": 0, "distinct_projects_used_count": 0, "distinct_session_count": 0, "message_count": 0 }, "office_metrics": { "excel": { "connectors_used_count": 0, "distinct_connectors_used_count": 0, "distinct_session_count": 0, "distinct_skills_used_count": 0, "message_count": 0, "skills_used_count": 0 }, "outlook": { "connectors_used_count": 0, "distinct_connectors_used_count": 0, "distinct_session_count": 0, "distinct_skills_used_count": 0, "message_count": 0, "skills_used_count": 0 }, "powerpoint": { "connectors_used_count": 0, "distinct_connectors_used_count": 0, "distinct_session_count": 0, "distinct_skills_used_count": 0, "message_count": 0, "skills_used_count": 0 }, "word": { "connectors_used_count": 0, "distinct_connectors_used_count": 0, "distinct_session_count": 0, "distinct_skills_used_count": 0, "message_count": 0, "skills_used_count": 0 } }, "science_metrics": { "delegation_count": 0, "distinct_session_count": 0, "message_count": 0, "remote_compute_job_count": 0, "skills_used_count": 0 }, "web_search_count": 0, "distinct_user_count": 0, "last_activity_date": "2019-12-27", "rbac_group_id": "rbac_group_id", "rbac_group_name": "rbac_group_name", "user": { "id": "id", "email_address": "email_address", "type": "user" } } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/users/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/users", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/api_keys", "name": "List API Keys", "description": "List API Keys", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "after_id", "before_id", "created_by_user_id", "limit", "status", "workspace_id" ] }, "response": { "type": "array of BetaAPIKey", "content_type": "application/json", "example": { "data": [ { "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", "created_at": "2024-10-30T23:58:27.427722Z", "created_by": { "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "type": "user" }, "expires_at": "2024-10-30T23:58:27.427722Z", "name": "Developer Key", "partial_key_hint": "sk-ant-api03-R2D...igAA", "principal": { "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "scope": { "type": "workspace", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" }, "status": "active", "type": "api_key", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor_ids", "params": [ "after_id", "before_id", "limit" ], "response_fields": [ "data", "has_more", "first_id", "last_id" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.api_keys.list()" ], "node": [ "client.beta.organization.apiKeys.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/api_keys", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/api_keys/{api_key_id}", "name": "Retrieve API Key (Admin API)", "description": "Retrieve information about a single API key in your organization, looked up by its ID. This Admin API endpoint requires an Admin API key, is intended for programmatic key management, and never returns the key's secret value. To view or create your own API keys, go to [API keys](https://platform.claude.com/settings/keys) in the Claude Console.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "api_key_id" ], "query_params": [] }, "response": { "type": "BetaAPIKey object", "content_type": "application/json", "example": { "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", "created_at": "2024-10-30T23:58:27.427722Z", "created_by": { "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "type": "user" }, "expires_at": "2024-10-30T23:58:27.427722Z", "name": "Developer Key", "partial_key_hint": "sk-ant-api03-R2D...igAA", "principal": { "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "scope": { "type": "workspace", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" }, "status": "active", "type": "api_key", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.api_keys.retrieve()" ], "node": [ "client.beta.organization.apiKeys.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/api_keys/{api_key_id}", "name": "Update API Key", "description": "Update API Key", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/api_keys/{api_key_id}", "path_params": [ "api_key_id" ], "query_params": [] }, "response": { "type": "BetaAPIKey object", "content_type": "application/json", "example": { "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", "created_at": "2024-10-30T23:58:27.427722Z", "created_by": { "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "type": "user" }, "expires_at": "2024-10-30T23:58:27.427722Z", "name": "Developer Key", "partial_key_hint": "sk-ant-api03-R2D...igAA", "principal": { "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "scope": { "type": "workspace", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" }, "status": "active", "type": "api_key", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.api_keys.update()" ], "node": [ "client.beta.organization.apiKeys.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "resource_group": "admin/compliance_settings", "method": "GET", "path": "/v1/organizations/compliance_settings", "name": "Get Compliance Settings", "description": "Retrieve your organization's Compliance Settings. Compliance Settings is a singleton resource: there is exactly one per organization, addressed without an identifier. The `state` field reflects whether the Compliance API is enabled. An organization with a parent organization reads the state inherited from the parent's configuration.", "status": [ "DOCUMENTED", "BETA", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "admin_api_key (sk-ant-admin01-…)", "scopes": null, "note": "Admin API (beta). Reference example sends X-Api-Key; SDK surfaces address it as /v1/organizations/compliance_settings?beta=true. Not available on Claude Platform on AWS." }, "beta_header": "unknown (reference page lists no anthropic-beta header; SDK marks the resource as beta via `?beta=true`)", "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "BetaComplianceSettings object", "fields": [ "type", "state" ], "example": "{\"state\": {\"type\": \"enabled\"}, \"type\": \"compliance_settings\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": "client.beta.organization.compliance_settings.retrieve() / .update(state=…)", "node": "client.beta.organization.complianceSettings.retrieve() / .update({state})" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. Admin API (beta) requires an Admin API key with org-admin role; not available to this account. Update is a state-changing org setting and was not exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/compliance_settings/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-api-access", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "admin", "resource_group": "admin/compliance_settings", "method": "POST", "path": "/v1/organizations/compliance_settings", "name": "Update Compliance Settings", "description": "Update your organization's Compliance Settings. Setting `state` to `enabled` turns on the Compliance API and begins capturing organization activity events. Setting it to `disabled` turns both off. `state` reflects whether the Compliance API is enabled. A request that sets `state` to its current value succeeds and leaves the resource unchanged. A `disabled` request stays in effect until a later `enabled` request or the organization's next provisioning action that enables Access Transparency: enabling Access Transparency also enables the Compliance API, which serves its activity events, so such provisioning (including re-runs) re-enables the Compliance API even after a `disabled` request. Automated provisioning never disables compliance settings.", "status": [ "DOCUMENTED", "BETA", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "admin_api_key (sk-ant-admin01-…)", "scopes": null, "note": "Admin API (beta). Reference example sends X-Api-Key; SDK surfaces address it as /v1/organizations/compliance_settings?beta=true. Not available on Claude Platform on AWS." }, "beta_header": "unknown (reference page lists no anthropic-beta header; SDK marks the resource as beta via `?beta=true`)", "request": { "content_type": "application/json", "body_ref": "state: BetaComplianceSettingsStateParam", "path_params": [], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "BetaComplianceSettings object", "fields": [ "type", "state" ], "example": "{\"state\": {\"type\": \"enabled\"}, \"type\": \"compliance_settings\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "idempotent (setting state to its current value succeeds unchanged)", "destructive": false, "sdk": { "python": "client.beta.organization.compliance_settings.retrieve() / .update(state=…)", "node": "client.beta.organization.complianceSettings.retrieve() / .update({state})" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. Admin API (beta) requires an Admin API key with org-admin role; not available to this account. Update is a state-changing org setting and was not exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/compliance_settings/update", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-api-access", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/cost_report", "name": "Get Cost Report", "description": "Get Cost Report", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "starting_at", "bucket_width", "ending_at", "group_by", "limit", "page" ] }, "response": { "type": "BetaCostReport object", "content_type": "application/json", "example": { "data": [ { "ending_at": "2025-08-02T00:00:00Z", "results": [ { "amount": "123.78912", "context_window": "0-200k", "cost_type": "tokens", "currency": "USD", "description": "Claude Opus 5 Usage - Input Tokens", "inference_geo": "global", "model": "claude-opus-5", "service_tier": "standard", "token_type": "uncached_input_tokens", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ], "starting_at": "2025-08-01T00:00:00Z" } ], "has_more": true, "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/cost_report/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/cost_report", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/external_keys", "name": "List External Keys", "description": "List external key configs in the caller's organization. Results are ordered by creation time (newest first). Use the `next_page` cursor from the response to fetch subsequent pages.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "limit", "page" ] }, "response": { "type": "array of BetaExternalKey", "content_type": "application/json", "example": { "data": [ { "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "attachment": { "type": "attached" }, "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "prod-us-key", "geo": "us", "provider_config": { "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", "type": "aws", "region": "us-east-1", "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" }, "type": "external_key", "updated_at": "2024-10-30T23:58:27.427722Z" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.external_keys.list()" ], "node": [ "client.beta.organization.externalKeys.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/external_keys", "name": "Create External Key", "description": "Create an external key config owned by the caller's organization.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/external_keys", "path_params": [], "query_params": [] }, "response": { "type": "BetaExternalKey object", "content_type": "application/json", "example": { "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "attachment": { "type": "attached" }, "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "prod-us-key", "geo": "us", "provider_config": { "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", "type": "aws", "region": "us-east-1", "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" }, "type": "external_key", "updated_at": "2024-10-30T23:58:27.427722Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.external_keys.create()" ], "node": [ "client.beta.organization.externalKeys.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "DELETE", "path": "/v1/organizations/external_keys/{external_key_id}", "name": "Delete External Key", "description": "Delete an external key config. The request is rejected if any workspace still references this config.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "external_key_id" ], "query_params": [] }, "response": { "type": "\"external_key_deleted\"", "content_type": "application/json", "example": { "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", "type": "external_key_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.external_keys.delete()" ], "node": [ "client.beta.organization.externalKeys.delete()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/external_keys/{external_key_id}", "name": "Get External Key", "description": "Retrieve a single external key config in the caller's organization by ID.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "external_key_id" ], "query_params": [] }, "response": { "type": "BetaExternalKey object", "content_type": "application/json", "example": { "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "attachment": { "type": "attached" }, "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "prod-us-key", "geo": "us", "provider_config": { "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", "type": "aws", "region": "us-east-1", "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" }, "type": "external_key", "updated_at": "2024-10-30T23:58:27.427722Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.external_keys.retrieve()" ], "node": [ "client.beta.organization.externalKeys.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/external_keys/{external_key_id}", "name": "Update External Key", "description": "Partially update an external key config. Omitted fields are left unchanged. `display_name` is always editable. `geo` and `provider_config` cannot be changed once any workspace references this config, because previously encrypted data requires the original key identity to decrypt.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/external_keys/{external_key_id}", "path_params": [ "external_key_id" ], "query_params": [] }, "response": { "type": "BetaExternalKey object", "content_type": "application/json", "example": { "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "attachment": { "type": "attached" }, "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "prod-us-key", "geo": "us", "provider_config": { "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", "type": "aws", "region": "us-east-1", "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" }, "type": "external_key", "updated_at": "2024-10-30T23:58:27.427722Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.external_keys.update()" ], "node": [ "client.beta.organization.externalKeys.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/external_keys/{external_key_id}/validate", "name": "Validate External Key", "description": "Validate an external key config against the customer's KMS. Anthropic performs an encrypt/decrypt roundtrip against the configured KMS key and waits up to 30 seconds for the result. The response status is `success` if the roundtrip succeeded, or `failure` with an error message if it failed or timed out.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "external_key_id" ], "query_params": [] }, "response": { "type": "\"external_key_validation\"", "content_type": "application/json", "example": { "error": "error", "status": "failure", "type": "external_key_validation" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.external_keys.validate()" ], "node": [ "client.beta.organization.externalKeys.validate()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/validate", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/federation_issuers", "name": "List Federation Issuers", "description": "List federation issuers in your organization. Archived issuers are excluded unless `include_archived=true`.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "include_archived", "limit", "page" ] }, "response": { "type": "array of BetaFederationIssuer", "content_type": "application/json", "example": { "data": [ { "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "check_jti": true, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "issuer_url": "https://token.actions.githubusercontent.com", "jwks": { "type": "discovery", "ca_cert_pem": "ca_cert_pem", "discovery_base": "discovery_base" }, "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", "max_jwt_lifetime_seconds": 0, "name": "github-actions", "poll_status": { "consecutive_failures": 0, "last_fetched_at": "2019-12-27T18:11:19.117Z", "next_poll_at": "2019-12-27T18:11:19.117Z" }, "type": "federation_issuer", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.federation.issuers.list()" ], "node": [ "client.beta.organization.federation.issuers.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/federation_issuers", "name": "Create Federation Issuer", "description": "Register an OIDC issuer that Anthropic will trust for workload identity federation in your organization. The `jwks` field controls how the issuer's signing keys are obtained and takes one of three shapes selected by `type`: `discovery` (resolve keys through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS URL), or `inline` (provide a static key set). When `jwks.type` is `discovery` and no `discovery_base` is set, the issuer URL must be publicly reachable over HTTPS so Anthropic can fetch the discovery document; for `explicit_url` and `inline` modes the issuer URL is only matched as the JWT's `iss` claim and is not fetched.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/federation_issuers", "path_params": [], "query_params": [] }, "response": { "type": "BetaFederationIssuer object", "content_type": "application/json", "example": { "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "check_jti": true, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "issuer_url": "https://token.actions.githubusercontent.com", "jwks": { "type": "discovery", "ca_cert_pem": "ca_cert_pem", "discovery_base": "discovery_base" }, "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", "max_jwt_lifetime_seconds": 0, "name": "github-actions", "poll_status": { "consecutive_failures": 0, "last_fetched_at": "2019-12-27T18:11:19.117Z", "next_poll_at": "2019-12-27T18:11:19.117Z" }, "type": "federation_issuer", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.federation.issuers.create()" ], "node": [ "client.beta.organization.federation.issuers.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/federation_issuers/{federation_issuer_id}", "name": "Get Federation Issuer", "description": "Retrieve a federation issuer by its ID (`fdis_...`).", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "federation_issuer_id" ], "query_params": [] }, "response": { "type": "BetaFederationIssuer object", "content_type": "application/json", "example": { "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "check_jti": true, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "issuer_url": "https://token.actions.githubusercontent.com", "jwks": { "type": "discovery", "ca_cert_pem": "ca_cert_pem", "discovery_base": "discovery_base" }, "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", "max_jwt_lifetime_seconds": 0, "name": "github-actions", "poll_status": { "consecutive_failures": 0, "last_fetched_at": "2019-12-27T18:11:19.117Z", "next_poll_at": "2019-12-27T18:11:19.117Z" }, "type": "federation_issuer", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.federation.issuers.retrieve()" ], "node": [ "client.beta.organization.federation.issuers.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/federation_issuers/{federation_issuer_id}", "name": "Update Federation Issuer", "description": "Partially update a federation issuer. Setting `jwks` replaces the full JWKS shape at once. Archived issuers cannot be updated; this returns 400. Create a new issuer instead. Updating an issuer that backs a rule with a scope outside `workspace:developer` or `workspace:inference` requires a Console session.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/federation_issuers/{federation_issuer_id}", "path_params": [ "federation_issuer_id" ], "query_params": [] }, "response": { "type": "BetaFederationIssuer object", "content_type": "application/json", "example": { "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "check_jti": true, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "issuer_url": "https://token.actions.githubusercontent.com", "jwks": { "type": "discovery", "ca_cert_pem": "ca_cert_pem", "discovery_base": "discovery_base" }, "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", "max_jwt_lifetime_seconds": 0, "name": "github-actions", "poll_status": { "consecutive_failures": 0, "last_fetched_at": "2019-12-27T18:11:19.117Z", "next_poll_at": "2019-12-27T18:11:19.117Z" }, "type": "federation_issuer", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.federation.issuers.update()" ], "node": [ "client.beta.organization.federation.issuers.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/federation_issuers/{federation_issuer_id}/archive", "name": "Archive Federation Issuer", "description": "Archive a federation issuer. Idempotent; re-archiving returns the issuer with its original `archived_at`. Rejected with 400 if any live (non-archived) federation rule still references the issuer; archive those rules first (a rule's issuer cannot be changed), or recreate them against another issuer.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "federation_issuer_id" ], "query_params": [] }, "response": { "type": "BetaFederationIssuer object", "content_type": "application/json", "example": { "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "check_jti": true, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "issuer_url": "https://token.actions.githubusercontent.com", "jwks": { "type": "discovery", "ca_cert_pem": "ca_cert_pem", "discovery_base": "discovery_base" }, "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", "max_jwt_lifetime_seconds": 0, "name": "github-actions", "poll_status": { "consecutive_failures": 0, "last_fetched_at": "2019-12-27T18:11:19.117Z", "next_poll_at": "2019-12-27T18:11:19.117Z" }, "type": "federation_issuer", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.federation.issuers.archive()" ], "node": [ "client.beta.organization.federation.issuers.archive()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/federation_rules", "name": "List Federation Rules", "description": "List federation rules in your organization. Optionally filter by issuer with `issuer_id`. Archived rules are excluded unless `include_archived=true`.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "include_archived", "issuer_id", "limit", "page" ] }, "response": { "type": "array of BetaFederationRule", "content_type": "application/json", "example": { "data": [ { "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", "applies_to_all_workspaces": true, "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "attributes": { "foo": "string" }, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "issuer_id": "issuer_id", "issuer_name": "issuer_name", "match": { "audience": "audience", "claims": { "foo": "string" }, "condition": "condition", "subject_prefix": "subject_prefix" }, "name": "prod-deploy-pipeline", "oauth_scope": "oauth_scope", "target": { "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "type": "service_account", "service_account_name": "service_account_name" }, "token_lifetime_seconds": 0, "type": "federation_rule", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id", "workspace_id": "workspace_id", "workspace_ids": [ "string" ] } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.federation.rules.list()" ], "node": [ "client.beta.organization.federation.rules.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/federation_rules", "name": "Create Federation Rule", "description": "Create a federation rule owned by your organization. The referenced issuer and the target service account must already exist in the same organization; invalid references are rejected with a 400 error. The workspace reference is validated. Membership is not checked at rule creation: token exchange resolves a single enabled workspace per call and is rejected unless the target service account is a member of that workspace (it is implicitly a member of the default workspace). Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, Terraform Cloud, Google) must constrain tenant identity via an identity-bearing claim, a tenant-pinning subject prefix (such as `repo:YOUR_ORG/...`), or a CEL condition referencing one of those identity claims (e.g. `claims.repository_owner`). OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/federation_rules", "path_params": [], "query_params": [] }, "response": { "type": "BetaFederationRule object", "content_type": "application/json", "example": { "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", "applies_to_all_workspaces": true, "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "attributes": { "foo": "string" }, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "issuer_id": "issuer_id", "issuer_name": "issuer_name", "match": { "audience": "audience", "claims": { "foo": "string" }, "condition": "condition", "subject_prefix": "subject_prefix" }, "name": "prod-deploy-pipeline", "oauth_scope": "oauth_scope", "target": { "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "type": "service_account", "service_account_name": "service_account_name" }, "token_lifetime_seconds": 0, "type": "federation_rule", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id", "workspace_id": "workspace_id", "workspace_ids": [ "string" ] } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.federation.rules.create()" ], "node": [ "client.beta.organization.federation.rules.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/federation_rules/{federation_rule_id}", "name": "Get Federation Rule", "description": "Retrieve a federation rule by its ID (`fdrl_...`).", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "federation_rule_id" ], "query_params": [] }, "response": { "type": "BetaFederationRule object", "content_type": "application/json", "example": { "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", "applies_to_all_workspaces": true, "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "attributes": { "foo": "string" }, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "issuer_id": "issuer_id", "issuer_name": "issuer_name", "match": { "audience": "audience", "claims": { "foo": "string" }, "condition": "condition", "subject_prefix": "subject_prefix" }, "name": "prod-deploy-pipeline", "oauth_scope": "oauth_scope", "target": { "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "type": "service_account", "service_account_name": "service_account_name" }, "token_lifetime_seconds": 0, "type": "federation_rule", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id", "workspace_id": "workspace_id", "workspace_ids": [ "string" ] } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.federation.rules.retrieve()" ], "node": [ "client.beta.organization.federation.rules.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/federation_rules/{federation_rule_id}", "name": "Update Federation Rule", "description": "Partially update a federation rule. `issuer_id` is immutable. `match` and `target` are replaced as whole objects when set. Referenced service accounts and workspaces must exist in your organization; invalid references are rejected with a 400 error. Archived rules cannot be updated; this returns 400. Create a new rule instead. Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, Terraform Cloud, Google) must constrain tenant identity via an identity-bearing claim, a tenant-pinning subject prefix (such as `repo:YOUR_ORG/...`), or a CEL condition referencing one of those identity claims (e.g. `claims.repository_owner`). On these issuers the requirement is re-checked on every update; if an existing rule's stored match does not yet constrain tenant identity, any update (even a rename or description change) must also supply a conforming `match` in the same request. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/federation_rules/{federation_rule_id}", "path_params": [ "federation_rule_id" ], "query_params": [] }, "response": { "type": "BetaFederationRule object", "content_type": "application/json", "example": { "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", "applies_to_all_workspaces": true, "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "attributes": { "foo": "string" }, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "issuer_id": "issuer_id", "issuer_name": "issuer_name", "match": { "audience": "audience", "claims": { "foo": "string" }, "condition": "condition", "subject_prefix": "subject_prefix" }, "name": "prod-deploy-pipeline", "oauth_scope": "oauth_scope", "target": { "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "type": "service_account", "service_account_name": "service_account_name" }, "token_lifetime_seconds": 0, "type": "federation_rule", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id", "workspace_id": "workspace_id", "workspace_ids": [ "string" ] } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.federation.rules.update()" ], "node": [ "client.beta.organization.federation.rules.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/federation_rules/{federation_rule_id}/archive", "name": "Archive Federation Rule", "description": "Archive a federation rule. Token exchange through this rule stops immediately. Idempotent; re-archiving returns the rule with its original `archived_at`. Archiving clears the rule's workspace targeting (`workspace_id` and `workspace_ids` are emptied). Tokens already minted before archive remain valid until they expire. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "federation_rule_id" ], "query_params": [] }, "response": { "type": "BetaFederationRule object", "content_type": "application/json", "example": { "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", "applies_to_all_workspaces": true, "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "attributes": { "foo": "string" }, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "issuer_id": "issuer_id", "issuer_name": "issuer_name", "match": { "audience": "audience", "claims": { "foo": "string" }, "condition": "condition", "subject_prefix": "subject_prefix" }, "name": "prod-deploy-pipeline", "oauth_scope": "oauth_scope", "target": { "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "type": "service_account", "service_account_name": "service_account_name" }, "token_lifetime_seconds": 0, "type": "federation_rule", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id", "workspace_id": "workspace_id", "workspace_ids": [ "string" ] } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.federation.rules.archive()" ], "node": [ "client.beta.organization.federation.rules.archive()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/federation_rules/{federation_rule_id}/workspaces", "name": "List Federation Rule Workspaces", "description": "List workspaces where this federation rule is enabled. Returns all workspace enablements in a single response; the `limit` and `page` parameters are accepted but have no effect, and `next_page` is always `null`. Returns explicit per-workspace enablements only; for rules with `applies_to_all_workspaces` or a legacy single `workspace_id`, check those fields on the rule itself.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "federation_rule_id" ], "query_params": [ "limit", "page" ] }, "response": { "type": "array of BetaFederationRuleWorkspace", "content_type": "application/json", "example": { "data": [ { "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "federation_rule_id": "federation_rule_id", "type": "federation_rule_workspace", "workspace_id": "workspace_id", "workspace_name": "workspace_name" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.federation.rules.workspaces.list()" ], "node": [ "client.beta.organization.federation.rules.workspaces.list()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/federation_rules/{federation_rule_id}/workspaces", "name": "Add Federation Rule Workspace", "description": "Enable a federation rule for a workspace. Idempotent; re-enabling returns the existing enablement. The rule and workspace must both belong to your organization. Membership of the rule's target service account in this workspace is not checked at enablement: token exchange into this workspace is rejected unless the target is a member (it is implicitly a member of the default workspace). Archived rules are rejected with 400. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/federation_rules/{federation_rule_id}/workspaces", "path_params": [ "federation_rule_id" ], "query_params": [] }, "response": { "type": "BetaFederationRuleWorkspace object", "content_type": "application/json", "example": { "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "federation_rule_id": "federation_rule_id", "type": "federation_rule_workspace", "workspace_id": "workspace_id", "workspace_name": "workspace_name" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.federation.rules.workspaces.add()" ], "node": [ "client.beta.organization.federation.rules.workspaces.add()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/add", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "DELETE", "path": "/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}", "name": "Remove Federation Rule Workspace", "description": "Disable a federation rule for a workspace. Idempotent; succeeds even if the enablement was already removed. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "federation_rule_id", "workspace_id" ], "query_params": [] }, "response": { "type": "\"federation_rule_workspace_deleted\"", "content_type": "application/json", "example": { "federation_rule_id": "federation_rule_id", "type": "federation_rule_workspace_deleted", "workspace_id": "workspace_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.federation.rules.workspaces.remove()" ], "node": [ "client.beta.organization.federation.rules.workspaces.remove()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/remove", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/invites", "name": "List Invites", "description": "List the organization's invites.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "after_id", "before_id", "email", "limit", "roles", "statuses" ] }, "response": { "type": "array of BetaOrganizationInvite", "content_type": "application/json", "example": { "data": [ { "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", "accepted_at": "2019-12-27T18:11:19.117Z", "email": "user@emaildomain.com", "expires_at": "2024-11-20T23:58:27.427722Z", "invited_at": "2024-10-30T23:58:27.427722Z", "rbac_group_ids": [ "string" ], "role": "admin", "status": "pending", "type": "invite" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor_ids", "params": [ "after_id", "before_id", "limit" ], "response_fields": [ "data", "has_more", "first_id", "last_id" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.invites.list()" ], "node": [ "client.beta.organization.invites.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/invites/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/invites", "name": "Create Invite", "description": "Invite a user to join the organization by email. On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/invites", "path_params": [], "query_params": [] }, "response": { "type": "BetaOrganizationInvite object", "content_type": "application/json", "example": { "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", "accepted_at": "2019-12-27T18:11:19.117Z", "email": "user@emaildomain.com", "expires_at": "2024-11-20T23:58:27.427722Z", "invited_at": "2024-10-30T23:58:27.427722Z", "rbac_group_ids": [ "string" ], "role": "admin", "status": "pending", "type": "invite" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.invites.create()" ], "node": [ "client.beta.organization.invites.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/invites/create", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/invites", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "DELETE", "path": "/v1/organizations/invites/{invite_id}", "name": "Delete Invite", "description": "Delete a pending invite.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "invite_id" ], "query_params": [] }, "response": { "type": "\"invite_deleted\"", "content_type": "application/json", "example": { "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", "type": "invite_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.invites.delete()" ], "node": [ "client.beta.organization.invites.delete()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/invites/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/invites/{invite_id}", "name": "Get Invite", "description": "Retrieve an invite by ID.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "invite_id" ], "query_params": [] }, "response": { "type": "BetaOrganizationInvite object", "content_type": "application/json", "example": { "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", "accepted_at": "2019-12-27T18:11:19.117Z", "email": "user@emaildomain.com", "expires_at": "2024-11-20T23:58:27.427722Z", "invited_at": "2024-10-30T23:58:27.427722Z", "rbac_group_ids": [ "string" ], "role": "admin", "status": "pending", "type": "invite" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.invites.retrieve()" ], "node": [ "client.beta.organization.invites.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/invites/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/me", "name": "Get Current Organization", "description": "Retrieve information about the organization associated with the authenticated API key.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Admin API key (sk-ant-admin…) or org:admin OAuth bearer or non-workspace-scoped personal/service-account key in x-api-key; GET /v1/organizations/me also accepts a regular workspace API key (LIVE_VERIFIED)", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [] }, "response": { "type": "BetaOrganization object", "content_type": "application/json", "example": { "id": "12345678-1234-5678-1234-567812345678", "name": "Organization Name", "type": "organization" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.retrieve()" ], "node": [ "client.beta.organization.retrieve()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "regular API key (x-api-key) -> {id, type: organization, name}" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/rate_limits", "name": "List Organization Rate Limits", "description": "List Messages API rate limits for your organization. Each entry corresponds to one rate-limit group (either a model family or an API-surface category such as the Files API or Message Batches) and contains the set of limiter values that apply to it. When `limit` is omitted, every matching entry is returned in a single page; when `limit` truncates the result, follow `next_page` to fetch the remaining entries.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "group_type", "limit", "model", "page" ] }, "response": { "type": "array of BetaOrganizationRateLimit", "content_type": "application/json", "example": { "data": [ { "id": "id", "group_type": "batch", "limits": [ { "type": "type", "value": 0 } ], "models": [ "string" ], "type": "rate_limit" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.rate_limits.list()" ], "node": [ "client.beta.organization.rateLimits.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/rate_limits/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/rate_limits", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/rbac_groups", "name": "List RBAC Groups", "description": "List RBAC Groups in the Claude Enterprise tenant. The RBAC Groups API is available to Claude Enterprise organizations only.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "limit", "page" ] }, "response": { "type": "array of BetaRBACGroup", "content_type": "application/json", "example": { "data": [ { "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "created_at": "2024-10-30T23:58:27.427722Z", "name": "Engineering", "roles": [ "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s" ], "source_type": "direct", "type": "rbac_group", "updated_at": "2024-10-30T23:58:27.427722Z" } ], "has_more": false, "next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/rbac_groups", "name": "Create RBAC Group", "description": "Create an RBAC Group in the Claude Enterprise tenant. Groups created via the API have source type `\"direct\"`. The RBAC Groups API is available to Claude Enterprise organizations only.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/rbac_groups", "path_params": [], "query_params": [] }, "response": { "type": "BetaRBACGroup object", "content_type": "application/json", "example": { "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "created_at": "2024-10-30T23:58:27.427722Z", "name": "Engineering", "roles": [ "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s" ], "source_type": "direct", "type": "rbac_group", "updated_at": "2024-10-30T23:58:27.427722Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "DELETE", "path": "/v1/organizations/rbac_groups/{group_id}", "name": "Delete RBAC Group", "description": "Delete an RBAC Group. Groups provisioned by an identity provider (source type `\"scim\"`) cannot be deleted via the API while an organization in the tenant uses SCIM provisioning. The RBAC Groups API is available to Claude Enterprise organizations only.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "group_id" ], "query_params": [] }, "response": { "type": "BetaRBACGroupDeleted object", "content_type": "application/json", "example": { "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "type": "rbac_group_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/rbac_groups/{group_id}", "name": "Get RBAC Group", "description": "Retrieve an RBAC Group by ID. The RBAC Groups API is available to Claude Enterprise organizations only.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "group_id" ], "query_params": [] }, "response": { "type": "BetaRBACGroup object", "content_type": "application/json", "example": { "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "created_at": "2024-10-30T23:58:27.427722Z", "name": "Engineering", "roles": [ "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s" ], "source_type": "direct", "type": "rbac_group", "updated_at": "2024-10-30T23:58:27.427722Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/rbac_groups/{group_id}", "name": "Update RBAC Group", "description": "Update an RBAC Group's name. Groups provisioned by an identity provider (source type `\"scim\"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning. The RBAC Groups API is available to Claude Enterprise organizations only.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/rbac_groups/{group_id}", "path_params": [ "group_id" ], "query_params": [] }, "response": { "type": "BetaRBACGroup object", "content_type": "application/json", "example": { "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "created_at": "2024-10-30T23:58:27.427722Z", "name": "Engineering", "roles": [ "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s" ], "source_type": "direct", "type": "rbac_group", "updated_at": "2024-10-30T23:58:27.427722Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/rbac_groups/{group_id}/members", "name": "List RBAC Group Members", "description": "List members of an RBAC Group. The RBAC Groups API is available to Claude Enterprise organizations only.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "group_id" ], "query_params": [ "limit", "page" ] }, "response": { "type": "array of BetaRBACGroupMember", "content_type": "application/json", "example": { "data": [ { "created_at": "2024-10-30T23:58:27.427722Z", "email": "user@emaildomain.com", "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "type": "rbac_group_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" } ], "has_more": false, "next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/rbac_groups/{group_id}/members", "name": "Add RBAC Group Member", "description": "Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type `\"scim\"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning. The RBAC Groups API is available to Claude Enterprise organizations only.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/rbac_groups/{group_id}/members", "path_params": [ "group_id" ], "query_params": [] }, "response": { "type": "BetaRBACGroupMember object", "content_type": "application/json", "example": { "created_at": "2024-10-30T23:58:27.427722Z", "email": "user@emaildomain.com", "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "type": "rbac_group_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "DELETE", "path": "/v1/organizations/rbac_groups/{group_id}/members/{user_id}", "name": "Remove RBAC Group Member", "description": "Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type `\"scim\"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning. The RBAC Groups API is available to Claude Enterprise organizations only.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "group_id", "user_id" ], "query_params": [] }, "response": { "type": "BetaRBACGroupMemberDeleted object", "content_type": "application/json", "example": { "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "type": "rbac_group_member_deleted", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/rbac_roles", "name": "List RBAC Roles", "description": "List RBAC Roles in the organization. The RBAC Roles API is available to Claude Enterprise organizations only.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "limit", "page" ] }, "response": { "type": "array of BetaRBACRole", "content_type": "application/json", "example": { "data": [ { "id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s", "created_at": "2024-10-30T23:58:27.427722Z", "name": "Project Editor", "type": "rbac_role", "updated_at": "2024-10-30T23:58:27.427722Z" } ], "has_more": true, "next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_roles", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/rbac_roles/{role_id}", "name": "Get RBAC Role", "description": "Retrieve an RBAC Role by ID. The RBAC Roles API is available to Claude Enterprise organizations only.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "role_id" ], "query_params": [] }, "response": { "type": "BetaRBACRole object", "content_type": "application/json", "example": { "id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s", "created_at": "2024-10-30T23:58:27.427722Z", "name": "Project Editor", "type": "rbac_role", "updated_at": "2024-10-30T23:58:27.427722Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/rbac_roles/{role_id}/permissions", "name": "List RBAC Role Permissions", "description": "List the permissions an RBAC Role grants. The RBAC Roles API is available to Claude Enterprise organizations only.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "role_id" ], "query_params": [ "limit", "page" ] }, "response": { "type": "array of BetaRBACRolePermission", "content_type": "application/json", "example": { "data": [ { "action": "use", "resource": { "organization_id": "3c4f5e6d-7a8b-49c0-9d1e-2f3a4b5c6d7e", "type": "organization" }, "type": "rbac_role_permission" } ], "has_more": true, "next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/permissions/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/permissions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/service_accounts", "name": "List Service Accounts", "description": "List service accounts in the caller's organization. Results are ordered by creation time, newest first. Use `limit` and the `next_page` cursor to paginate; set `include_archived=true` to include archived service accounts.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "include_archived", "limit", "page" ] }, "response": { "type": "array of BetaServiceAccount", "content_type": "application/json", "example": { "data": [ { "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "name": "ci-deploy-bot", "organization_role": "admin", "type": "service_account", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.service_accounts.list()" ], "node": [ "client.beta.organization.serviceAccounts.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/service_accounts", "name": "Create Service Account", "description": "Create a service account. A service account is a named workload identity that federation rules target. `organization_role` is `developer` (default) or `admin`; a rule may only be created or retargeted to grant `org:admin` scope when the target's `organization_role` is `admin`. Creating an `admin`-role service account requires an interactive credential (a user OAuth token or a Console session) — a workload may only create `developer`-role service accounts.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/service_accounts", "path_params": [], "query_params": [] }, "response": { "type": "BetaServiceAccount object", "content_type": "application/json", "example": { "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "name": "ci-deploy-bot", "organization_role": "admin", "type": "service_account", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.service_accounts.create()" ], "node": [ "client.beta.organization.serviceAccounts.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/create", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/service_accounts/{service_account_id}", "name": "Get Service Account", "description": "Retrieve a service account by its ID (`svac_...`).", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "service_account_id" ], "query_params": [] }, "response": { "type": "BetaServiceAccount object", "content_type": "application/json", "example": { "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "name": "ci-deploy-bot", "organization_role": "admin", "type": "service_account", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.service_accounts.retrieve()" ], "node": [ "client.beta.organization.serviceAccounts.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/service_accounts/{service_account_id}", "name": "Update Service Account", "description": "Update a service account. Only `description` and `organization_role` are mutable; `name` cannot be changed. Archived service accounts cannot be updated; this returns 400. Setting `organization_role` to `admin` (even when unchanged) requires an interactive credential (a user OAuth token or a Console session).", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/service_accounts/{service_account_id}", "path_params": [ "service_account_id" ], "query_params": [] }, "response": { "type": "BetaServiceAccount object", "content_type": "application/json", "example": { "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "name": "ci-deploy-bot", "organization_role": "admin", "type": "service_account", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.service_accounts.update()" ], "node": [ "client.beta.organization.serviceAccounts.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/service_accounts/{service_account_id}/archive", "name": "Archive Service Account", "description": "Archive a service account. Idempotent; re-archiving returns the service account with its original `archived_at`. Rejected with 400 if any live (non-archived) federation rule still targets this service account, same as issuer archival; archive those rules first or change their target to another service account.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "service_account_id" ], "query_params": [] }, "response": { "type": "BetaServiceAccount object", "content_type": "application/json", "example": { "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "name": "ci-deploy-bot", "organization_role": "admin", "type": "service_account", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.service_accounts.archive()" ], "node": [ "client.beta.organization.serviceAccounts.archive()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/service_accounts/{service_account_id}/workspaces", "name": "List Workspaces For Service Account", "description": "List the workspaces a service account is a member of. Each entry includes the service account's `workspace_role` in that workspace. Use `limit` and the `next_page` cursor to paginate. When the service account has no explicit default-workspace membership, the implicit (`implicit: true`) membership is returned as the first entry on the first page; with `limit=1` the first page may return up to 2 entries (the implicit entry plus one explicit membership) so a pagination cursor can be derived. Memberships are returned only while the service account is active. Without a `page` cursor, an archived service account returns an empty list. A `page` cursor that does not match an active membership returns a 400 invalid-request error. A cursor stops matching when the membership is removed, the workspace is deleted, or the service account is archived. Restart pagination from the first page to recover.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "service_account_id" ], "query_params": [ "limit", "page" ] }, "response": { "type": "array of BetaServiceAccountWorkspaceMember", "content_type": "application/json", "example": { "data": [ { "created_by_actor_id": "created_by_actor_id", "implicit": true, "service_account_id": "service_account_id", "type": "service_account_workspace_member", "workspace_id": "workspace_id", "workspace_role": "workspace_admin" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.service_accounts.workspaces.list()" ], "node": [ "client.beta.organization.serviceAccounts.workspaces.list()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/service_accounts/{service_account_id}/workspaces", "name": "Add Workspace To Service Account", "description": "Add a service account to a workspace with the given `workspace_role`. Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed from the service-account side; both create the same membership. If the service account is already an explicit member of the workspace, its `workspace_role` is replaced with the value supplied here. Archived workspaces return 400. Archived service accounts cannot be added and are rejected.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/service_accounts/{service_account_id}/workspaces", "path_params": [ "service_account_id" ], "query_params": [] }, "response": { "type": "BetaServiceAccountWorkspaceMember object", "content_type": "application/json", "example": { "created_by_actor_id": "created_by_actor_id", "implicit": true, "service_account_id": "service_account_id", "type": "service_account_workspace_member", "workspace_id": "workspace_id", "workspace_role": "workspace_admin" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.service_accounts.workspaces.add()" ], "node": [ "client.beta.organization.serviceAccounts.workspaces.add()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/add", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "DELETE", "path": "/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}", "name": "Remove Workspace From Service Account", "description": "Remove a service account from a workspace. Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, addressed from the service-account side. Removal is idempotent (returns 200 even if the membership was already removed). A DELETE against the implicit default-workspace membership returns 200 but is a no-op and the membership persists; deleting an explicit default-workspace row reverts to the implicit `workspace_user` membership. Archived workspaces return 400.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "service_account_id", "workspace_id" ], "query_params": [] }, "response": { "type": "\"service_account_workspace_member_deleted\"", "content_type": "application/json", "example": { "service_account_id": "service_account_id", "type": "service_account_workspace_member_deleted", "workspace_id": "workspace_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.service_accounts.workspaces.remove()" ], "node": [ "client.beta.organization.serviceAccounts.workspaces.remove()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/remove", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/spend_limit_increase_requests", "name": "List Spend Limit Increase Requests", "description": "List spend limit increase requests, most recent first. Pending requests include a live `spend_summary` for the requester. Requests whose requester is no longer a member are excluded.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "actor_ids", "limit", "page", "status" ] }, "response": { "type": "array of BetaSpendLimitIncreaseRequest", "content_type": "application/json", "example": { "data": [ { "id": "id", "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "monthly", "resolved_at": "2019-12-27T18:11:19.117Z", "resolved_by": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_summary": { "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD", "period": "monthly", "period_to_date_spend": "12050.5", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "source": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit_id": "spend_limit_id" }, "status": "approved", "type": "spend_limit_increase_request" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}", "name": "Get Spend Limit Increase Request", "description": "Retrieve a spend limit increase request. While `pending`, the response includes a live `spend_summary` for the requester at the request's period.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "spend_limit_increase_request_id" ], "query_params": [] }, "response": { "type": "BetaSpendLimitIncreaseRequest object", "content_type": "application/json", "example": { "id": "id", "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "monthly", "resolved_at": "2019-12-27T18:11:19.117Z", "resolved_by": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_summary": { "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD", "period": "monthly", "period_to_date_spend": "12050.5", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "source": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit_id": "spend_limit_id" }, "status": "approved", "type": "spend_limit_increase_request" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve", "name": "Approve Spend Limit Increase Request", "description": "Approve a pending spend limit increase request. Writes a per-user spend limit at `amount` for the requester and transitions the request to `approved`. `period` defaults to the period the member was blocked on. Anthropic emails the requester unless `suppress_notification` is set.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve", "path_params": [ "spend_limit_increase_request_id" ], "query_params": [] }, "response": { "type": "\"spend_limit_increase_request\"", "content_type": "application/json", "example": { "id": "id", "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "monthly", "resolved_at": "2019-12-27T18:11:19.117Z", "resolved_by": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit": { "id": "id", "amount": "50000", "created_at": "2019-12-27T18:11:19.117Z", "currency": "USD", "period": "monthly", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "type": "spend_limit", "updated_at": "2019-12-27T18:11:19.117Z" }, "spend_summary": { "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD", "period": "monthly", "period_to_date_spend": "12050.5", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "source": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit_id": "spend_limit_id" }, "status": "approved", "type": "spend_limit_increase_request" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/approve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny", "name": "Deny Spend Limit Increase Request", "description": "Deny a pending spend limit increase request. Idempotent on `denied`; denying an already-`approved` request returns 400. Anthropic emails the requester unless `suppress_notification` is set.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny", "path_params": [ "spend_limit_increase_request_id" ], "query_params": [] }, "response": { "type": "BetaSpendLimitIncreaseRequest object", "content_type": "application/json", "example": { "id": "id", "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "monthly", "resolved_at": "2019-12-27T18:11:19.117Z", "resolved_by": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_summary": { "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD", "period": "monthly", "period_to_date_spend": "12050.5", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "source": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit_id": "spend_limit_id" }, "status": "approved", "type": "spend_limit_increase_request" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/deny", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/spend_limits", "name": "Set Spend Limit", "description": "Set a spend limit. Upsert keyed on (scope, period): setting a limit that already exists overwrites it in place. A Claude Enterprise organization sets `user` limits. Its seat-tier, group, and organization-level defaults are configured in claude.ai. A Claude Console organization sets `organization` and `workspace` limits, which are monthly and always carry an amount. Setting those limits is in an early access preview. To request access, contact your Anthropic account team.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/spend_limits", "path_params": [], "query_params": [] }, "response": { "type": "BetaSpendLimit object", "content_type": "application/json", "example": { "id": "id", "amount": "50000", "created_at": "2019-12-27T18:11:19.117Z", "currency": "USD", "period": "monthly", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "type": "spend_limit", "updated_at": "2019-12-27T18:11:19.117Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/create", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/spend_limits/effective", "name": "List Effective Spend Limits", "description": "List each member's effective spend limit and period-to-date spend. Returns one row per (member, period) the member resolves a spend limit for, with the `source` scope the spend limit was inherited from. Paginates by member, so a member's periods never split across pages.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "limit", "page", "period", "user_ids" ] }, "response": { "type": "array of BetaSpendSummary", "content_type": "application/json", "example": { "data": [ { "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD", "period": "monthly", "period_to_date_spend": "12050.5", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "source": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit_id": "spend_limit_id" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/list_effective", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "DELETE", "path": "/v1/organizations/spend_limits/{spend_limit_id}", "name": "Delete Spend Limit", "description": "Delete a spend limit. For a Claude Enterprise organization, this deletes a per-user override, and the member falls back to any inherited spend limit at that period. Its seat-tier, group, and organization-level rows cannot be deleted via this endpoint. A Claude Console organization deletes its organization and workspace limits. Deleting them through the API is in an early access preview.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "spend_limit_id" ], "query_params": [] }, "response": { "type": "\"spend_limit_deleted\"", "content_type": "application/json", "example": { "id": "id", "type": "spend_limit_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/spend_limits/{spend_limit_id}", "name": "Get Spend Limit", "description": "Retrieve a spend limit by ID.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "spend_limit_id" ], "query_params": [] }, "response": { "type": "BetaSpendLimit object", "content_type": "application/json", "example": { "id": "id", "amount": "50000", "created_at": "2019-12-27T18:11:19.117Z", "currency": "USD", "period": "monthly", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "type": "spend_limit", "updated_at": "2019-12-27T18:11:19.117Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/tunnels", "name": "List Tunnels", "description": "List the organization's tunnels. Results span the caller's organization, ordered by creation time (newest first). Use `workspace_id` to filter to a single workspace; archived tunnels are excluded unless `include_archived` is set.", "status": [ "DOCUMENTED", "BETA", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": "mcp-tunnels-2026-05-19", "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "include_archived", "limit", "page", "workspace_id" ] }, "response": { "type": "array of BetaOrganizationTunnel", "content_type": "application/json", "example": { "data": [ { "id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8", "archived_at": "2024-11-01T23:59:27.427722Z", "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "Production", "domain": "a1b2c3d4.tunnel.anthropic.com", "type": "tunnel", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/tunnels/{tunnel_id}", "name": "Get Tunnel", "description": "Retrieve a single tunnel in the caller's organization by ID.", "status": [ "DOCUMENTED", "BETA" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": "mcp-tunnels-2026-05-19", "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "tunnel_id" ], "query_params": [] }, "response": { "type": "BetaOrganizationTunnel object", "content_type": "application/json", "example": { "id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8", "archived_at": "2024-11-01T23:59:27.427722Z", "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "Production", "domain": "a1b2c3d4.tunnel.anthropic.com", "type": "tunnel", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/tunnels/{tunnel_id}/archive", "name": "Archive Tunnel", "description": "Archive a tunnel. Archival is irreversible. Every non-archived certificate on the tunnel is archived in the same operation, the hostname is retired and never re-allocated, and the tunnel token is invalidated. Retrying against an already-archived tunnel returns the existing record unchanged.", "status": [ "DOCUMENTED", "BETA" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": "mcp-tunnels-2026-05-19", "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "tunnel_id" ], "query_params": [] }, "response": { "type": "BetaOrganizationTunnel object", "content_type": "application/json", "example": { "id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8", "archived_at": "2024-11-01T23:59:27.427722Z", "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "Production", "domain": "a1b2c3d4.tunnel.anthropic.com", "type": "tunnel", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/tunnels/{tunnel_id}/certificates", "name": "List Tunnel Certificates", "description": "List the certificates registered on a tunnel. Archived certificates are excluded unless `include_archived` is set.", "status": [ "DOCUMENTED", "BETA" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": "mcp-tunnels-2026-05-19", "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "tunnel_id" ], "query_params": [ "include_archived", "limit", "page" ] }, "response": { "type": "array of BetaOrganizationTunnelCertificate", "content_type": "application/json", "example": { "data": [ { "id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9", "archived_at": "2024-11-01T23:59:27.427722Z", "created_at": "2024-10-30T23:58:27.427722Z", "expires_at": "2024-10-30T23:58:27.427722Z", "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08", "tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8", "type": "tunnel_certificate" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/tunnels/{tunnel_id}/certificates", "name": "Create Tunnel Certificate", "description": "Register a public CA certificate for the tunnel. Anthropic verifies the gateway's server certificate against this CA when it terminates the inner TLS session. The PEM body must contain exactly one X.509 certificate and no private-key material. A tunnel holds at most two non-archived certificates.", "status": [ "DOCUMENTED", "BETA" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": "mcp-tunnels-2026-05-19", "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/tunnels/{tunnel_id}/certificates", "path_params": [ "tunnel_id" ], "query_params": [] }, "response": { "type": "BetaOrganizationTunnelCertificate object", "content_type": "application/json", "example": { "id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9", "archived_at": "2024-11-01T23:59:27.427722Z", "created_at": "2024-10-30T23:58:27.427722Z", "expires_at": "2024-10-30T23:58:27.427722Z", "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08", "tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8", "type": "tunnel_certificate" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/create", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}", "name": "Get Tunnel Certificate", "description": "Retrieve a single certificate registered on a tunnel by ID.", "status": [ "DOCUMENTED", "BETA" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": "mcp-tunnels-2026-05-19", "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "tunnel_id", "certificate_id" ], "query_params": [] }, "response": { "type": "BetaOrganizationTunnelCertificate object", "content_type": "application/json", "example": { "id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9", "archived_at": "2024-11-01T23:59:27.427722Z", "created_at": "2024-10-30T23:58:27.427722Z", "expires_at": "2024-10-30T23:58:27.427722Z", "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08", "tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8", "type": "tunnel_certificate" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive", "name": "Archive Tunnel Certificate", "description": "Archive a certificate, removing it from the set Anthropic trusts for this tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added.", "status": [ "DOCUMENTED", "BETA" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": "mcp-tunnels-2026-05-19", "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "tunnel_id", "certificate_id" ], "query_params": [] }, "response": { "type": "BetaOrganizationTunnelCertificate object", "content_type": "application/json", "example": { "id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9", "archived_at": "2024-11-01T23:59:27.427722Z", "created_at": "2024-10-30T23:58:27.427722Z", "expires_at": "2024-10-30T23:58:27.427722Z", "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08", "tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8", "type": "tunnel_certificate" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/tunnels/{tunnel_id}/reveal_token", "name": "Reveal Tunnel Token", "description": "Return the tunnel's current connection token. The value is fetched live on each call; Anthropic does not store it. Repeated calls return the same value until the token is rotated. Exposed as `POST` so the token does not appear in intermediary access logs.", "status": [ "DOCUMENTED", "BETA" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": "mcp-tunnels-2026-05-19", "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "tunnel_id" ], "query_params": [] }, "response": { "type": "BetaOrganizationTunnelToken object", "content_type": "application/json", "example": { "id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0", "tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==", "type": "tunnel_token" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/reveal_token", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/tunnels/{tunnel_id}/rotate_token", "name": "Rotate Tunnel Token", "description": "Invalidate the tunnel's current token for new connections and return a fresh value. Established connections are not severed by rotation; a connector restarted after rotation must use the new value. An optional `reason` is captured for operational context.", "status": [ "DOCUMENTED", "BETA" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": "mcp-tunnels-2026-05-19", "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/tunnels/{tunnel_id}/rotate_token", "path_params": [ "tunnel_id" ], "query_params": [] }, "response": { "type": "BetaOrganizationTunnelToken object", "content_type": "application/json", "example": { "id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0", "tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==", "type": "tunnel_token" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/rotate_token", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/usage_report/claude_code", "name": "Get Claude Code Usage Report", "description": "Retrieve daily aggregated usage metrics for Claude Code users. Enables organizations to analyze developer productivity and build custom dashboards.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "starting_at", "limit", "page" ] }, "response": { "type": "BetaClaudeCodeUsageReport object", "content_type": "application/json", "example": { "data": [ { "actor": { "email_address": "user@emaildomain.com", "type": "user_actor" }, "core_metrics": { "commits_by_claude_code": 8, "lines_of_code": { "added": 342, "removed": 128 }, "num_sessions": 15, "pull_requests_by_claude_code": 2 }, "customer_type": "api", "date": "2025-08-08T00:00:00Z", "is_remote": false, "model_breakdown": [ { "estimated_cost": { "amount": 186, "currency": "USD" }, "model": "claude-opus-5", "tokens": { "cache_creation": 2340, "cache_read": 8790, "input": 45230, "output": 12450 } }, { "estimated_cost": { "amount": 42, "currency": "USD" }, "model": "claude-sonnet-5", "tokens": { "cache_creation": 890, "cache_read": 3420, "input": 23100, "output": 5680 } } ], "organization_id": "12345678-1234-5678-1234-567812345678", "terminal_type": "iTerm.app", "tool_actions": { "edit_tool": { "accepted": 25, "rejected": 3 }, "multi_edit_tool": { "accepted": 12, "rejected": 1 }, "notebook_edit_tool": { "accepted": 5, "rejected": 2 }, "write_tool": { "accepted": 8, "rejected": 0 } }, "subscription_type": "enterprise" } ], "has_more": true, "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_claude_code", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/usage_report/messages", "name": "Get Messages Usage Report", "description": "Get Messages Usage Report", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "starting_at", "account_ids", "api_key_ids", "bucket_width", "context_window", "ending_at", "group_by", "inference_geos", "limit", "models", "page", "service_account_ids", "service_tiers", "speeds", "workspace_ids" ] }, "response": { "type": "BetaMessagesUsageReport object", "content_type": "application/json", "example": { "data": [ { "ending_at": "2025-08-02T00:00:00Z", "results": [ { "account_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "api_key_id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 200, "context_window": "0-200k", "inference_geo": "global", "model": "claude-opus-5", "output_tokens": 500, "server_tool_use": { "web_search_requests": 10 }, "service_account_id": "svac_01Hk3R9TWxq7CfQak00OiVw4", "service_tier": "standard", "uncached_input_tokens": 1500, "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ], "starting_at": "2025-08-01T00:00:00Z" } ], "has_more": true, "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/usage_report", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/users", "name": "List Users", "description": "List the organization's members.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "after_id", "before_id", "email", "limit", "roles" ] }, "response": { "type": "array of BetaOrganizationUser", "content_type": "application/json", "example": { "data": [ { "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "added_at": "2024-10-30T23:58:27.427722Z", "email": "user@emaildomain.com", "name": "Jane Doe", "role": "admin", "type": "user" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor_ids", "params": [ "after_id", "before_id", "limit" ], "response_fields": [ "data", "has_more", "first_id", "last_id" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.users.list()" ], "node": [ "client.beta.organization.users.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/users/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/users", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "DELETE", "path": "/v1/organizations/users/{user_id}", "name": "Remove User", "description": "Remove a member from the organization.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "user_id" ], "query_params": [] }, "response": { "type": "\"user_deleted\"", "content_type": "application/json", "example": { "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "type": "user_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.users.remove()" ], "node": [ "client.beta.organization.users.remove()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/users/remove", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/users/{user_id}", "name": "Get User", "description": "Retrieve a member of the organization by user ID.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "user_id" ], "query_params": [] }, "response": { "type": "BetaOrganizationUser object", "content_type": "application/json", "example": { "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "added_at": "2024-10-30T23:58:27.427722Z", "email": "user@emaildomain.com", "name": "Jane Doe", "role": "admin", "type": "user" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.users.retrieve()" ], "node": [ "client.beta.organization.users.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/users/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/users/{user_id}", "name": "Update User", "description": "Update a member's organization role.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/users/{user_id}", "path_params": [ "user_id" ], "query_params": [] }, "response": { "type": "BetaOrganizationUser object", "content_type": "application/json", "example": { "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "added_at": "2024-10-30T23:58:27.427722Z", "email": "user@emaildomain.com", "name": "Jane Doe", "role": "admin", "type": "user" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.users.update()" ], "node": [ "client.beta.organization.users.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/users/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/workspaces", "name": "List Workspaces", "description": "List Workspaces", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "after_id", "before_id", "include_archived", "limit" ] }, "response": { "type": "array of BetaWorkspace", "content_type": "application/json", "example": { "data": [ { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor_ids", "params": [ "after_id", "before_id", "limit" ], "response_fields": [ "data", "has_more", "first_id", "last_id" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.workspaces.list()" ], "node": [ "client.beta.organization.workspaces.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "regular key -> 401 authentication_error 'The Admin API requires an Admin API key or an organization-scoped API key.'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/workspaces", "name": "Create Workspace", "description": "Create Workspace", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/workspaces", "path_params": [], "query_params": [] }, "response": { "type": "BetaWorkspace object", "content_type": "application/json", "example": { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.workspaces.create()" ], "node": [ "client.beta.organization.workspaces.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/workspaces/{workspace_id}", "name": "Get Workspace", "description": "Get Workspace", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "workspace_id" ], "query_params": [] }, "response": { "type": "BetaWorkspace object", "content_type": "application/json", "example": { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.workspaces.retrieve()" ], "node": [ "client.beta.organization.workspaces.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/workspaces/{workspace_id}", "name": "Update Workspace", "description": "Update Workspace", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/workspaces/{workspace_id}", "path_params": [ "workspace_id" ], "query_params": [] }, "response": { "type": "BetaWorkspace object", "content_type": "application/json", "example": { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.workspaces.update()" ], "node": [ "client.beta.organization.workspaces.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/workspaces/{workspace_id}/archive", "name": "Archive Workspace", "description": "Archive Workspace", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "workspace_id" ], "query_params": [] }, "response": { "type": "BetaWorkspace object", "content_type": "application/json", "example": { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.workspaces.archive()" ], "node": [ "client.beta.organization.workspaces.archive()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/workspaces/{workspace_id}/members", "name": "List Workspace Members", "description": "List Workspace Members", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "workspace_id" ], "query_params": [ "after_id", "before_id", "limit" ] }, "response": { "type": "array of BetaWorkspaceMember", "content_type": "application/json", "example": { "data": [ { "type": "workspace_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "workspace_role": "workspace_admin" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor_ids", "params": [ "after_id", "before_id", "limit" ], "response_fields": [ "data", "has_more", "first_id", "last_id" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.workspaces.members.list()" ], "node": [ "client.beta.organization.workspaces.members.list()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/workspaces/{workspace_id}/members", "name": "Create Workspace Member", "description": "Create Workspace Member", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/workspaces/{workspace_id}/members", "path_params": [ "workspace_id" ], "query_params": [] }, "response": { "type": "BetaWorkspaceMember object", "content_type": "application/json", "example": { "type": "workspace_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "workspace_role": "workspace_admin" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.workspaces.members.add()" ], "node": [ "client.beta.organization.workspaces.members.add()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/add", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "DELETE", "path": "/v1/organizations/workspaces/{workspace_id}/members/{user_id}", "name": "Delete Workspace Member", "description": "Delete Workspace Member", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "workspace_id", "user_id" ], "query_params": [] }, "response": { "type": "\"workspace_member_deleted\"", "content_type": "application/json", "example": { "type": "workspace_member_deleted", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.workspaces.members.remove()" ], "node": [ "client.beta.organization.workspaces.members.remove()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/remove", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/workspaces/{workspace_id}/members/{user_id}", "name": "Get Workspace Member", "description": "Get Workspace Member", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "workspace_id", "user_id" ], "query_params": [] }, "response": { "type": "BetaWorkspaceMember object", "content_type": "application/json", "example": { "type": "workspace_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "workspace_role": "workspace_admin" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.workspaces.members.retrieve()" ], "node": [ "client.beta.organization.workspaces.members.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/workspaces/{workspace_id}/members/{user_id}", "name": "Update Workspace Member", "description": "Update Workspace Member", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/workspaces/{workspace_id}/members/{user_id}", "path_params": [ "workspace_id", "user_id" ], "query_params": [] }, "response": { "type": "BetaWorkspaceMember object", "content_type": "application/json", "example": { "type": "workspace_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "workspace_role": "workspace_admin" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.workspaces.members.update()" ], "node": [ "client.beta.organization.workspaces.members.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/workspaces/{workspace_id}/rate_limits", "name": "List Workspace Rate Limits", "description": "List rate-limit overrides configured for a workspace. Returns only the groups and limiter types that have a workspace-level override. Groups without overrides inherit the organization limits and are not listed; use `GET /v1/organizations/rate_limits` to see those. When `limit` is omitted, every matching entry is returned in a single page; when `limit` truncates the result, follow `next_page` to fetch the remaining entries.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "workspace_id" ], "query_params": [ "group_type", "limit", "page" ] }, "response": { "type": "array of BetaWorkspaceRateLimit", "content_type": "application/json", "example": { "data": [ { "group_type": "batch", "limits": [ { "org_limit": 0, "type": "type", "value": 0 } ], "models": [ "string" ], "rate_limit_id": "rate_limit_id", "type": "workspace_rate_limit", "workspace_id": "workspace_id" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.workspaces.rate_limits.list()" ], "node": [ "client.beta.organization.workspaces.rateLimits.list()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/rate_limits/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/rate_limits", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/workspaces/{workspace_id}/service_accounts", "name": "List Service Account Workspace Members", "description": "List the service accounts that are members of a workspace. Each entry includes the service account's `workspace_role`. Use `limit` and the `next_page` cursor to paginate. Archived workspaces return 400; use `GET /service_accounts/{id}/workspaces` to audit memberships of an archived workspace. The implicit default-workspace membership is not included in this list. Memberships of archived service accounts are omitted from the results.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "workspace_id" ], "query_params": [ "limit", "page" ] }, "response": { "type": "array of BetaServiceAccountWorkspaceMember", "content_type": "application/json", "example": { "data": [ { "created_by_actor_id": "created_by_actor_id", "implicit": true, "service_account_id": "service_account_id", "type": "service_account_workspace_member", "workspace_id": "workspace_id", "workspace_role": "workspace_admin" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.workspaces.service_accounts.list()" ], "node": [ "client.beta.organization.workspaces.serviceAccounts.list()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/workspaces/{workspace_id}/service_accounts", "name": "Create Service Account Workspace Member", "description": "Add a service account to a workspace with the given `workspace_role`. The role determines what the service account can do in the workspace and which workspace-scoped permissions it can be granted when authenticating through federation. Every service account is already an implicit `workspace_user` member of the default workspace; adding it explicitly assigns a chosen role. If the service account is already an explicit member of the workspace, its `workspace_role` is replaced with the value supplied here. Archived workspaces return 400. Archived service accounts cannot be added and are rejected.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/workspaces/{workspace_id}/service_accounts", "path_params": [ "workspace_id" ], "query_params": [] }, "response": { "type": "BetaServiceAccountWorkspaceMember object", "content_type": "application/json", "example": { "created_by_actor_id": "created_by_actor_id", "implicit": true, "service_account_id": "service_account_id", "type": "service_account_workspace_member", "workspace_id": "workspace_id", "workspace_role": "workspace_admin" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.workspaces.service_accounts.add()" ], "node": [ "client.beta.organization.workspaces.serviceAccounts.add()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/add", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "DELETE", "path": "/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}", "name": "Delete Service Account Workspace Member", "description": "Remove a service account from a workspace. Removal is idempotent (returns 200 even if the membership was already removed). A DELETE against the implicit default-workspace membership returns 200 but is a no-op and the membership persists; deleting an explicit default-workspace row reverts to the implicit `workspace_user` membership. Archived workspaces return 400.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "workspace_id", "service_account_id" ], "query_params": [] }, "response": { "type": "\"service_account_workspace_member_deleted\"", "content_type": "application/json", "example": { "service_account_id": "service_account_id", "type": "service_account_workspace_member_deleted", "workspace_id": "workspace_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.workspaces.service_accounts.remove()" ], "node": [ "client.beta.organization.workspaces.serviceAccounts.remove()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/remove", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "GET", "path": "/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}", "name": "Get Service Account Workspace Member", "description": "Retrieve a service account's membership in a workspace. Returns the membership record, including the service account's `workspace_role` in this workspace. Archived workspaces return 400. For the default workspace, returns the implicit (`implicit: true`) membership when no explicit membership exists; an explicitly added membership is returned with its assigned role. An archived service account returns 404.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "workspace_id", "service_account_id" ], "query_params": [] }, "response": { "type": "BetaServiceAccountWorkspaceMember object", "content_type": "application/json", "example": { "created_by_actor_id": "created_by_actor_id", "implicit": true, "service_account_id": "service_account_id", "type": "service_account_workspace_member", "workspace_id": "workspace_id", "workspace_role": "workspace_admin" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.organization.workspaces.service_accounts.retrieve()" ], "node": [ "client.beta.organization.workspaces.serviceAccounts.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "admin", "method": "POST", "path": "/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}", "name": "Update Service Account Workspace Member", "description": "Change a service account's role in a workspace. The new `workspace_role` replaces the current one. Only explicit memberships can be updated; to set a role on the implicit default-workspace membership, add the service account explicitly with `POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces return 400. Archived service accounts cannot be updated and are rejected.", "status": [ "DOCUMENTED" ], "auth": "Admin API key (sk-ant-admin…) in x-api-key, or OAuth bearer with org:admin scope (service_accounts / federation_* accept OAuth only); regular API key -> 401", "beta_header": null, "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-admin.json#POST /v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}", "path_params": [ "workspace_id", "service_account_id" ], "query_params": [] }, "response": { "type": "BetaServiceAccountWorkspaceMember object", "content_type": "application/json", "example": { "created_by_actor_id": "created_by_actor_id", "implicit": true, "service_account_id": "service_account_id", "type": "service_account_workspace_member", "workspace_id": "workspace_id", "workspace_role": "workspace_admin" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.organization.workspaces.service_accounts.update()" ], "node": [ "client.beta.organization.workspaces.serviceAccounts.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-admin.json" }, { "provider": "anthropic", "api_family": "messages-batches", "method": "GET", "path": "/v1/messages/batches", "name": "List Message Batches", "description": "List all Message Batches within a Workspace. Most recently created batches are returned first. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key)", "beta_header": "message-batches-2024-09-24", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "after_id", "before_id", "limit" ] }, "response": { "type": "array of BetaMessageBatch", "content_type": "application/json", "example": { "data": [ { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor_ids", "params": [ "after_id", "before_id", "limit" ], "response_fields": [ "data", "has_more", "first_id", "last_id" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.messages.batches.list()", "client.beta.messages.batches.list()" ], "node": [ "client.messages.batches.list()", "client.beta.messages.batches.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "limit=1 and after_id cursor; response {data, has_more, first_id, last_id}" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/messages/batches/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-batches.json" }, { "provider": "anthropic", "api_family": "messages-batches", "method": "POST", "path": "/v1/messages/batches", "name": "Create a Message Batch", "description": "Send a batch of Message creation requests. The Message Batches API can be used to process multiple Messages API requests at once. Once a Message Batch is created, it begins processing immediately. Batches can take up to 24 hours to complete. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key)", "beta_header": "message-batches-2024-09-24", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-user-profile-id", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-batches.json#POST /v1/messages/batches", "path_params": [], "query_params": [] }, "response": { "type": "BetaMessageBatch object", "content_type": "application/json", "example": { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.messages.batches.create()", "client.beta.messages.batches.create()" ], "node": [ "client.messages.batches.create()", "client.beta.messages.batches.create()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "2 requests (1 valid haiku, 1 invalid model) -> in_progress; validation 400 on empty requests / duplicate custom_id" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/create", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/messages/batches/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-batches.json" }, { "provider": "anthropic", "api_family": "messages-batches", "method": "DELETE", "path": "/v1/messages/batches/{message_batch_id}", "name": "Delete a Message Batch", "description": "Delete a Message Batch. Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key)", "beta_header": "message-batches-2024-09-24", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "message_batch_id" ], "query_params": [] }, "response": { "type": "BetaDeletedMessageBatch object", "content_type": "application/json", "example": { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "type": "message_batch_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.messages.batches.delete()", "client.beta.messages.batches.delete()" ], "node": [ "client.messages.batches.delete()", "client.beta.messages.batches.delete()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "200 {type: message_batch_deleted} only once processing_status=ended; 400 invalid_request_error while in_progress ('In progress batches cannot be deleted. Consider canceling the batch instead.') and while canceling" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/delete", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/messages/batches/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-batches.json" }, { "provider": "anthropic", "api_family": "messages-batches", "method": "GET", "path": "/v1/messages/batches/{message_batch_id}", "name": "Retrieve a Message Batch", "description": "This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key)", "beta_header": "message-batches-2024-09-24", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "message_batch_id" ], "query_params": [] }, "response": { "type": "BetaMessageBatch object", "content_type": "application/json", "example": { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.messages.batches.retrieve()", "client.beta.messages.batches.retrieve()" ], "node": [ "client.messages.batches.retrieve()", "client.beta.messages.batches.retrieve()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "polled every 20s; ended after ~102s (2 requests); 404 after delete / unknown id" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/messages/batches/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-batches.json" }, { "provider": "anthropic", "api_family": "messages-batches", "method": "POST", "path": "/v1/messages/batches/{message_batch_id}/cancel", "name": "Cancel a Message Batch", "description": "Batches may be canceled any time before processing ends. Once cancellation is initiated, the batch enters a `canceling` state, at which time the system may complete any in-progress, non-interruptible requests before finalizing cancellation. The number of canceled requests is specified in `request_counts`. To determine which requests were canceled, check the individual results within the batch. Note that cancellation may not result in any canceled requests if they were non-interruptible. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key)", "beta_header": "message-batches-2024-09-24", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "message_batch_id" ], "query_params": [] }, "response": { "type": "BetaMessageBatch object", "content_type": "application/json", "example": { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (observed: repeated cancel -> 200 same state)", "sdk": { "python": [ "client.messages.batches.cancel()", "client.beta.messages.batches.cancel()" ], "node": [ "client.messages.batches.cancel()", "client.beta.messages.batches.cancel()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "immediately after create -> processing_status=canceling, cancel_initiated_at set; idempotent (2nd call 200); ended ~30s later with request_counts.canceled=1" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/cancel", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/messages/batches/cancel", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-batches.json" }, { "provider": "anthropic", "api_family": "messages-batches", "method": "GET", "path": "/v1/messages/batches/{message_batch_id}/results", "name": "Retrieve Message Batch results", "description": "Streams the results of a Message Batch as a `.jsonl` file. Each line in the file is a JSON object containing the result of a single request in the Message Batch. Results are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key)", "beta_header": "message-batches-2024-09-24", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "message_batch_id" ], "query_params": [] }, "response": { "type": "BetaMessageBatchIndividualResponse object", "content_type": "application/x-jsonl", "example": null }, "streaming": { "supported": true, "events_ref": null, "note": "application/x-jsonl body streamed line by line (not SSE)" }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.messages.batches.results()", "client.beta.messages.batches.results()" ], "node": [ "client.messages.batches.results()", "client.beta.messages.batches.results()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": ".jsonl body, one line per request, unordered; result.type succeeded|errored|canceled observed; 404 not_found_error 'has no available results' while in_progress" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/results", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/messages/batches/results", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-batches.json" }, { "provider": "anthropic", "api_family": "cloud:bedrock", "method": "POST", "path": "https://bedrock-mantle.{region}.api.aws/anthropic/v1/messages", "name": "Claude in Amazon Bedrock: Messages", "description": "Messages API on AWS-managed Bedrock infrastructure (Opus 4.7 and later + Haiku 4.5). Same body as Claude API; model in body with 'anthropic.' prefix; anthropic-version header 2023-06-01.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": { "scheme": "AWS SigV4", "service": "bedrock-mantle", "alternatives": [ "Bedrock service role (iam:PassRole)", "IAM assumed role (12h)", "short-term bearer token via aws-bedrock-token-generator in x-api-key (12h)" ], "env": [ "AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY", "AWS_SESSION_TOKEN", "AWS_REGION" ] }, "beta_header": "anthropic-beta header not supported per comparison table", "request": { "content_type": "application/json", "body_ref": "MessagesRequest (Claude API shape; model e.g. anthropic.claude-haiku-4-5)" }, "response": { "body_ref": "Message (Claude API shape)", "headers": [ "request-id" ] }, "streaming": { "supported": true, "events_ref": "Claude API SSE events", "transport": "SSE" }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicBedrockMantle(aws_region=...).messages.create(...) # pip install 'anthropic[bedrock]'", "node": "new AnthropicBedrockMantle({ awsRegion }).messages.create(...) // @anthropic-ai/bedrock-sdk" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon-bedrock", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "retrieved_at": "2026-09-18" } ], "quotas": "Default 2M input TPM; up to 5M input / 500k output TPM without Anthropic approval; RPM enforced by AWS", "regions_doc": "27 AWS regions; Global endpoint (no premium) vs Regional (+10%)", "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:bedrock", "method": "POST", "path": "https://bedrock-mantle.{region}.api.aws/anthropic/v1/messages/count_tokens", "name": "Claude in Amazon Bedrock: count tokens", "description": "Token counting is listed as available on Bedrock in the Features overview; this path is inferred from the Messages API shape and is not shown on the Bedrock page.", "status": [ "DOCUMENTED", "UNVERIFIED", "DOCUMENTATION_INCOMPLETE" ], "auth": { "scheme": "AWS SigV4", "service": "bedrock-mantle", "alternatives": [ "Bedrock service role (iam:PassRole)", "IAM assumed role (12h)", "short-term bearer token via aws-bedrock-token-generator in x-api-key (12h)" ], "env": [ "AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY", "AWS_SESSION_TOKEN", "AWS_REGION" ] }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CountTokensRequest" }, "response": { "body_ref": "{input_tokens}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "AnthropicBedrockMantle().messages.count_tokens(...) (unverified)", "node": "client.messages.countTokens(...) (unverified)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/overview", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon-bedrock", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:bedrock", "method": "POST", "path": "https://bedrock-runtime.{region}.amazonaws.com/model/{modelId}/invoke", "name": "Amazon Bedrock (legacy): InvokeModel", "description": "Legacy integration (Opus 4.6 and earlier, ARN-versioned ids). modelId is an inference-profile id (e.g. us.anthropic.claude-haiku-4-5-20251001-v1:0) or ARN; body carries anthropic_version 'bedrock-2023-05-31' and no model field. REST path per AWS API; Anthropic docs reference the operation by name.", "status": [ "DOCUMENTED", "UNVERIFIED", "LEGACY" ], "auth": { "scheme": "AWS SigV4", "service": "bedrock", "alternatives": [ "bearer token AWS_BEARER_TOKEN_BEDROCK (SDKs) / api_key" ], "env": [ "AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY", "AWS_SESSION_TOKEN", "AWS_REGION", "AWS_BEARER_TOKEN_BEDROCK" ] }, "beta_header": "anthropic-beta header not supported; no body-level beta mechanism documented in this snapshot", "request": { "content_type": "application/json", "body_ref": "MessagesRequest minus model, plus anthropic_version" }, "response": { "body_ref": "Message (Claude API shape)" }, "streaming": { "supported": false, "events_ref": null, "note": "use /invoke-with-response-stream" }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicBedrock(aws_region=...).messages.create(model='global.anthropic.claude-opus-4-6-v1', ...) or boto3 bedrock-runtime invoke_model", "node": "new AnthropicBedrock({ awsRegion }).messages.create(...)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-on-amazon-bedrock-legacy", "retrieved_at": "2026-09-18" } ], "payload_limit": "20 MB", "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:bedrock", "method": "POST", "path": "https://bedrock-runtime.{region}.amazonaws.com/model/{modelId}/invoke-with-response-stream", "name": "Amazon Bedrock (legacy): InvokeModelWithResponseStream", "description": "Streaming variant of InvokeModel; AWS EventStream encoding (not SSE).", "status": [ "DOCUMENTED", "UNVERIFIED", "LEGACY" ], "auth": { "scheme": "AWS SigV4", "service": "bedrock", "alternatives": [ "bearer token AWS_BEARER_TOKEN_BEDROCK (SDKs) / api_key" ], "env": [ "AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY", "AWS_SESSION_TOKEN", "AWS_REGION", "AWS_BEARER_TOKEN_BEDROCK" ] }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "as InvokeModel" }, "response": { "body_ref": "AWS EventStream of Claude stream events" }, "streaming": { "supported": true, "events_ref": "Claude API stream events wrapped in AWS EventStream", "transport": "AWS EventStream" }, "pagination": null, "idempotency": null, "sdk": { "python": "AnthropicBedrock().messages.stream(...)", "node": "client.messages.stream(...)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-on-amazon-bedrock-legacy", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:bedrock", "method": "POST", "path": "https://bedrock-runtime.{region}.amazonaws.com/model/{modelId}/converse", "name": "Amazon Bedrock (legacy): Converse", "description": "Bedrock-native Converse API (and /converse-stream). Supports PDFs (visual analysis requires citations); no tool search; mid-conversation system messages not supported (top-level system only).", "status": [ "DOCUMENTED", "UNVERIFIED", "LEGACY" ], "auth": { "scheme": "AWS SigV4", "service": "bedrock", "alternatives": [ "bearer token AWS_BEARER_TOKEN_BEDROCK (SDKs) / api_key" ], "env": [ "AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY", "AWS_SESSION_TOKEN", "AWS_REGION", "AWS_BEARER_TOKEN_BEDROCK" ] }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "Bedrock Converse request (AWS schema)" }, "response": { "body_ref": "Bedrock Converse response" }, "streaming": { "supported": true, "events_ref": "ConverseStream (AWS EventStream)" }, "pagination": null, "idempotency": null, "sdk": { "python": "boto3 bedrock-runtime converse()", "node": "@aws-sdk/client-bedrock-runtime ConverseCommand" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-on-amazon-bedrock-legacy", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/build-with-claude/pdf-support", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:bedrock", "method": "GET", "path": "https://bedrock.{region}.amazonaws.com/foundation-models?byProvider=anthropic", "name": "Amazon Bedrock: ListFoundationModels", "description": "Control-plane listing of Anthropic models (aws bedrock list-foundation-models --by-provider anthropic). Replaces the Models API, which is not available on Bedrock.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": { "scheme": "AWS SigV4", "service": "bedrock", "alternatives": [ "bearer token AWS_BEARER_TOKEN_BEDROCK (SDKs) / api_key" ], "env": [ "AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY", "AWS_SESSION_TOKEN", "AWS_REGION", "AWS_BEARER_TOKEN_BEDROCK" ] }, "beta_header": null, "request": null, "response": { "body_ref": "modelSummaries[].modelId" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "boto3.client('bedrock').list_foundation_models(byProvider='anthropic')", "node": "ListFoundationModelsCommand({ byProvider: 'anthropic' })" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-on-amazon-bedrock-legacy", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:vertex_ai", "method": "POST", "path": "https://{region}-aiplatform.googleapis.com/v1/projects/{project}/locations/{region}/publishers/anthropic/models/{model}:rawPredict", "name": "Google Cloud (Vertex AI / Agent Platform): rawPredict", "description": "Messages API on Google Cloud. model in the URL (e.g. claude-haiku-4-5@20251001), not the body; body carries anthropic_version 'vertex-2023-10-16'. Hosts: regional {region}-aiplatform.googleapis.com (Sonnet 4.6 and earlier), global aiplatform.googleapis.com with locations/global, multi-region aiplatform.{us|eu}.rep.googleapis.com with locations/{us|eu}.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": { "scheme": "Google OAuth2 bearer (Application Default Credentials)", "header": "Authorization: Bearer $(gcloud auth print-access-token)", "env": [ "ANTHROPIC_VERTEX_PROJECT_ID", "CLOUD_ML_REGION", "GOOGLE_APPLICATION_CREDENTIALS" ] }, "beta_header": "unknown — docs say 'pass the beta value as described in Beta headers' but describe only the anthropic-beta header", "request": { "content_type": "application/json", "body_ref": "MessagesRequest minus model, plus anthropic_version" }, "response": { "body_ref": "Message (Claude API shape)" }, "streaming": { "supported": false, "events_ref": null, "note": "use :streamRawPredict" }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicVertex(project_id=..., region=...).messages.create(model='claude-haiku-4-5@20251001', ...) # pip install 'anthropic[vertex]'", "node": "new AnthropicVertex({ projectId, region }).messages.create(...) // @anthropic-ai/vertex-sdk" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai", "retrieved_at": "2026-09-18" } ], "payload_limit": "30 MB", "regions_doc": "global (recommended), multi-region us/eu (+10%), regional e.g. us-east5, europe-west1 (+10%, provisioned throughput)", "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:vertex_ai", "method": "POST", "path": "https://{region}-aiplatform.googleapis.com/v1/projects/{project}/locations/{region}/publishers/anthropic/models/{model}:streamRawPredict", "name": "Google Cloud: streamRawPredict", "description": "Streaming variant used by the SDKs (stream: true). The Anthropic snapshot shows only :rawPredict; :streamRawPredict is the Google-documented streaming method.", "status": [ "DOCUMENTED", "UNVERIFIED", "DOCUMENTATION_INCOMPLETE" ], "auth": { "scheme": "Google OAuth2 bearer (Application Default Credentials)", "header": "Authorization: Bearer $(gcloud auth print-access-token)", "env": [ "ANTHROPIC_VERTEX_PROJECT_ID", "CLOUD_ML_REGION", "GOOGLE_APPLICATION_CREDENTIALS" ] }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "as rawPredict" }, "response": { "body_ref": "SSE stream" }, "streaming": { "supported": true, "events_ref": "Claude API SSE events", "transport": "SSE" }, "pagination": null, "idempotency": null, "sdk": { "python": "AnthropicVertex().messages.stream(...)", "node": "client.messages.stream(...)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:vertex_ai", "method": "POST", "path": "https://{region}-aiplatform.googleapis.com/v1/projects/{project}/locations/{region}/publishers/anthropic/models/count-tokens:rawPredict", "name": "Google Cloud: count tokens", "description": "Token counting is listed as available on Google Cloud in the Features overview. The REST path is the one used by the SDKs and is not shown in Anthropic's docs (unverified).", "status": [ "DOCUMENTED", "UNVERIFIED", "DOCUMENTATION_INCOMPLETE" ], "auth": { "scheme": "Google OAuth2 bearer (Application Default Credentials)", "header": "Authorization: Bearer $(gcloud auth print-access-token)", "env": [ "ANTHROPIC_VERTEX_PROJECT_ID", "CLOUD_ML_REGION", "GOOGLE_APPLICATION_CREDENTIALS" ] }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CountTokensRequest + model in body" }, "response": { "body_ref": "{input_tokens}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "AnthropicVertex().messages.count_tokens(...) (unverified)", "node": "client.messages.countTokens(...) (unverified)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/overview", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:microsoft_foundry", "method": "POST", "path": "https://{resource}.services.ai.azure.com/anthropic/v1/messages", "name": "Claude in Microsoft Foundry: Messages", "description": "Messages API on Azure-hosted endpoints. model = deployment name (defaults to Claude API id, e.g. claude-haiku-4-5). Two hosting options: Hosted on Azure (Global Standard, US Data Zone Standard) and Hosted on Anthropic (Global Standard). Responses include request-id and apim-request-id; no anthropic-ratelimit-* headers.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": { "scheme": "Azure api-key or Microsoft Entra ID bearer", "headers": [ "api-key: ", "x-api-key: ", "Authorization: Bearer " ], "env": [ "ANTHROPIC_FOUNDRY_API_KEY", "ANTHROPIC_FOUNDRY_RESOURCE", "ANTHROPIC_FOUNDRY_BASE_URL" ], "rbac": [ "Foundry User", "Cognitive Services User" ] }, "beta_header": "unknown — beta features exist on Foundry but header mechanics are not described", "request": { "content_type": "application/json", "body_ref": "MessagesRequest (Claude API shape)" }, "response": { "body_ref": "Message (Claude API shape)", "headers": [ "request-id", "apim-request-id" ] }, "streaming": { "supported": true, "events_ref": "Claude API SSE events", "transport": "SSE" }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicFoundry(api_key=..., resource=...).messages.create(model='claude-haiku-4-5', ...) # base package", "node": "new AnthropicFoundry({ apiKey, resource }).messages.create(...) // @anthropic-ai/foundry-sdk" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry", "retrieved_at": "2026-09-18" } ], "billing": "Azure Marketplace, Claude Consumption Units ($0.01/CCU)", "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:microsoft_foundry", "method": "POST", "path": "https://{resource}.services.ai.azure.com/anthropic/v1/messages/count_tokens", "name": "Claude in Microsoft Foundry: count tokens", "description": "Token counting listed as available on Foundry; path follows the Claude API under the /anthropic prefix (not shown explicitly).", "status": [ "DOCUMENTED", "UNVERIFIED", "DOCUMENTATION_INCOMPLETE" ], "auth": { "scheme": "Azure api-key or Microsoft Entra ID bearer", "headers": [ "api-key: ", "x-api-key: ", "Authorization: Bearer " ], "env": [ "ANTHROPIC_FOUNDRY_API_KEY", "ANTHROPIC_FOUNDRY_RESOURCE", "ANTHROPIC_FOUNDRY_BASE_URL" ], "rbac": [ "Foundry User", "Cognitive Services User" ] }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CountTokensRequest" }, "response": { "body_ref": "{input_tokens}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "AnthropicFoundry().messages.count_tokens(...) (unverified)", "node": "client.messages.countTokens(...) (unverified)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/overview", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:microsoft_foundry", "method": "POST", "path": "https://{resource}.services.ai.azure.com/anthropic/v1/files", "name": "Claude in Microsoft Foundry: Files (beta, Hosted on Anthropic only)", "description": "Files API available in beta for Hosted-on-Anthropic deployments; 400 on Hosted-on-Azure deployments.", "status": [ "DOCUMENTED", "UNVERIFIED", "BETA" ], "auth": { "scheme": "Azure api-key or Microsoft Entra ID bearer", "headers": [ "api-key: ", "x-api-key: ", "Authorization: Bearer " ], "env": [ "ANTHROPIC_FOUNDRY_API_KEY", "ANTHROPIC_FOUNDRY_RESOURCE", "ANTHROPIC_FOUNDRY_BASE_URL" ], "rbac": [ "Foundry User", "Cognitive Services User" ] }, "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "file" }, "response": { "body_ref": "File" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "AnthropicFoundry().files.upload(...)", "node": "client.files.upload(...)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/build-with-claude/files", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:claude_platform_on_aws", "method": "POST", "path": "https://aws-external-anthropic.{region}.api.aws/v1/messages", "name": "Claude Platform on AWS: Messages", "description": "Claude API served by Anthropic-operated infrastructure through AWS (billing via AWS Marketplace in CCUs). Supports inference_geo (us/global, 1.1x for us on 4.6+), anthropic-beta header pass-through, all Claude API features except fast mode, HIPAA program, computer/browser toolsets, OAuth, OpenAI-compatible endpoints, MCP tunnels.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": { "scheme": "AWS SigV4 (service aws-external-anthropic) or API key", "sigv4": "curl --aws-sigv4 'aws:amz:{region}:aws-external-anthropic'", "api_key": "x-api-key (keys generated in AWS Console; short-term tokens via token-generator-for-aws-external-anthropic, 12h max)", "required_headers": [ "anthropic-version: 2023-06-01", "anthropic-workspace-id: wrkspc_..." ], "iam_actions": [ "aws-external-anthropic:CreateInference", "aws-external-anthropic:CallWithBearerToken (API key auth)" ], "env": [ "AWS_REGION", "ANTHROPIC_AWS_WORKSPACE_ID", "ANTHROPIC_AWS_API_KEY" ], "prereq": "aws iam enable-outbound-web-identity-federation (once per account)" }, "beta_header": "anthropic-beta header (pass-through, same as Claude API)", "request": { "content_type": "application/json", "body_ref": "Claude API shape (identical to first-party)" }, "response": { "body_ref": "Claude API shape", "headers": [ "x-amzn-requestid", "request-id" ] }, "streaming": { "supported": true, "events_ref": "Claude API SSE events" }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicAWS(). # pip install 'anthropic[aws]' (beta)", "node": "new AnthropicAws(). // @anthropic-ai/aws-sdk (beta)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/claude-platform-on-aws-iam-actions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:claude_platform_on_aws", "method": "POST", "path": "https://aws-external-anthropic.{region}.api.aws/v1/messages/count_tokens", "name": "Claude Platform on AWS: count tokens", "description": "Token counting.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": { "scheme": "AWS SigV4 (service aws-external-anthropic) or API key", "sigv4": "curl --aws-sigv4 'aws:amz:{region}:aws-external-anthropic'", "api_key": "x-api-key (keys generated in AWS Console; short-term tokens via token-generator-for-aws-external-anthropic, 12h max)", "required_headers": [ "anthropic-version: 2023-06-01", "anthropic-workspace-id: wrkspc_..." ], "iam_actions": [ "aws-external-anthropic:CountTokens", "aws-external-anthropic:CallWithBearerToken (API key auth)" ], "env": [ "AWS_REGION", "ANTHROPIC_AWS_WORKSPACE_ID", "ANTHROPIC_AWS_API_KEY" ], "prereq": "aws iam enable-outbound-web-identity-federation (once per account)" }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "Claude API shape (identical to first-party)" }, "response": { "body_ref": "Claude API shape", "headers": [ "x-amzn-requestid", "request-id" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicAWS(). # pip install 'anthropic[aws]' (beta)", "node": "new AnthropicAws(). // @anthropic-ai/aws-sdk (beta)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/claude-platform-on-aws-iam-actions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:claude_platform_on_aws", "method": "POST", "path": "https://aws-external-anthropic.{region}.api.aws/v1/messages/batches", "name": "Claude Platform on AWS: create Message Batch", "description": "Batch processing (50% discount; output-300k-2026-03-24 beta supported).", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": { "scheme": "AWS SigV4 (service aws-external-anthropic) or API key", "sigv4": "curl --aws-sigv4 'aws:amz:{region}:aws-external-anthropic'", "api_key": "x-api-key (keys generated in AWS Console; short-term tokens via token-generator-for-aws-external-anthropic, 12h max)", "required_headers": [ "anthropic-version: 2023-06-01", "anthropic-workspace-id: wrkspc_..." ], "iam_actions": [ "aws-external-anthropic:CreateBatchInference", "aws-external-anthropic:CallWithBearerToken (API key auth)" ], "env": [ "AWS_REGION", "ANTHROPIC_AWS_WORKSPACE_ID", "ANTHROPIC_AWS_API_KEY" ], "prereq": "aws iam enable-outbound-web-identity-federation (once per account)" }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "Claude API shape (identical to first-party)" }, "response": { "body_ref": "Claude API shape", "headers": [ "x-amzn-requestid", "request-id" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicAWS(). # pip install 'anthropic[aws]' (beta)", "node": "new AnthropicAws(). // @anthropic-ai/aws-sdk (beta)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/claude-platform-on-aws-iam-actions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:claude_platform_on_aws", "method": "GET", "path": "https://aws-external-anthropic.{region}.api.aws/v1/messages/batches/{id}", "name": "Claude Platform on AWS: get batch / results", "description": "GetBatchInference authorizes both /v1/messages/batches/{id} and /{id}/results.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": { "scheme": "AWS SigV4 (service aws-external-anthropic) or API key", "sigv4": "curl --aws-sigv4 'aws:amz:{region}:aws-external-anthropic'", "api_key": "x-api-key (keys generated in AWS Console; short-term tokens via token-generator-for-aws-external-anthropic, 12h max)", "required_headers": [ "anthropic-version: 2023-06-01", "anthropic-workspace-id: wrkspc_..." ], "iam_actions": [ "aws-external-anthropic:GetBatchInference", "aws-external-anthropic:CallWithBearerToken (API key auth)" ], "env": [ "AWS_REGION", "ANTHROPIC_AWS_WORKSPACE_ID", "ANTHROPIC_AWS_API_KEY" ], "prereq": "aws iam enable-outbound-web-identity-federation (once per account)" }, "beta_header": null, "request": { "content_type": null, "body_ref": "Claude API shape (identical to first-party)" }, "response": { "body_ref": "Claude API shape", "headers": [ "x-amzn-requestid", "request-id" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicAWS(). # pip install 'anthropic[aws]' (beta)", "node": "new AnthropicAws(). // @anthropic-ai/aws-sdk (beta)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/claude-platform-on-aws-iam-actions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:claude_platform_on_aws", "method": "GET", "path": "https://aws-external-anthropic.{region}.api.aws/v1/messages/batches", "name": "Claude Platform on AWS: list batches", "description": "", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": { "scheme": "AWS SigV4 (service aws-external-anthropic) or API key", "sigv4": "curl --aws-sigv4 'aws:amz:{region}:aws-external-anthropic'", "api_key": "x-api-key (keys generated in AWS Console; short-term tokens via token-generator-for-aws-external-anthropic, 12h max)", "required_headers": [ "anthropic-version: 2023-06-01", "anthropic-workspace-id: wrkspc_..." ], "iam_actions": [ "aws-external-anthropic:ListBatchInferences", "aws-external-anthropic:CallWithBearerToken (API key auth)" ], "env": [ "AWS_REGION", "ANTHROPIC_AWS_WORKSPACE_ID", "ANTHROPIC_AWS_API_KEY" ], "prereq": "aws iam enable-outbound-web-identity-federation (once per account)" }, "beta_header": null, "request": { "content_type": null, "body_ref": "Claude API shape (identical to first-party)" }, "response": { "body_ref": "Claude API shape", "headers": [ "x-amzn-requestid", "request-id" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicAWS(). # pip install 'anthropic[aws]' (beta)", "node": "new AnthropicAws(). // @anthropic-ai/aws-sdk (beta)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/claude-platform-on-aws-iam-actions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:claude_platform_on_aws", "method": "POST", "path": "https://aws-external-anthropic.{region}.api.aws/v1/messages/batches/{id}/cancel", "name": "Claude Platform on AWS: cancel batch", "description": "", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": { "scheme": "AWS SigV4 (service aws-external-anthropic) or API key", "sigv4": "curl --aws-sigv4 'aws:amz:{region}:aws-external-anthropic'", "api_key": "x-api-key (keys generated in AWS Console; short-term tokens via token-generator-for-aws-external-anthropic, 12h max)", "required_headers": [ "anthropic-version: 2023-06-01", "anthropic-workspace-id: wrkspc_..." ], "iam_actions": [ "aws-external-anthropic:CancelBatchInference", "aws-external-anthropic:CallWithBearerToken (API key auth)" ], "env": [ "AWS_REGION", "ANTHROPIC_AWS_WORKSPACE_ID", "ANTHROPIC_AWS_API_KEY" ], "prereq": "aws iam enable-outbound-web-identity-federation (once per account)" }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "Claude API shape (identical to first-party)" }, "response": { "body_ref": "Claude API shape", "headers": [ "x-amzn-requestid", "request-id" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicAWS(). # pip install 'anthropic[aws]' (beta)", "node": "new AnthropicAws(). // @anthropic-ai/aws-sdk (beta)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/claude-platform-on-aws-iam-actions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:claude_platform_on_aws", "method": "DELETE", "path": "https://aws-external-anthropic.{region}.api.aws/v1/messages/batches/{id}", "name": "Claude Platform on AWS: delete batch", "description": "", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": { "scheme": "AWS SigV4 (service aws-external-anthropic) or API key", "sigv4": "curl --aws-sigv4 'aws:amz:{region}:aws-external-anthropic'", "api_key": "x-api-key (keys generated in AWS Console; short-term tokens via token-generator-for-aws-external-anthropic, 12h max)", "required_headers": [ "anthropic-version: 2023-06-01", "anthropic-workspace-id: wrkspc_..." ], "iam_actions": [ "aws-external-anthropic:DeleteBatchInference", "aws-external-anthropic:CallWithBearerToken (API key auth)" ], "env": [ "AWS_REGION", "ANTHROPIC_AWS_WORKSPACE_ID", "ANTHROPIC_AWS_API_KEY" ], "prereq": "aws iam enable-outbound-web-identity-federation (once per account)" }, "beta_header": null, "request": { "content_type": null, "body_ref": "Claude API shape (identical to first-party)" }, "response": { "body_ref": "Claude API shape", "headers": [ "x-amzn-requestid", "request-id" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicAWS(). # pip install 'anthropic[aws]' (beta)", "node": "new AnthropicAws(). // @anthropic-ai/aws-sdk (beta)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/claude-platform-on-aws-iam-actions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:claude_platform_on_aws", "method": "GET", "path": "https://aws-external-anthropic.{region}.api.aws/v1/models", "name": "Claude Platform on AWS: list models", "description": "Models API (also GET /v1/models/{id} via GetModel).", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": { "scheme": "AWS SigV4 (service aws-external-anthropic) or API key", "sigv4": "curl --aws-sigv4 'aws:amz:{region}:aws-external-anthropic'", "api_key": "x-api-key (keys generated in AWS Console; short-term tokens via token-generator-for-aws-external-anthropic, 12h max)", "required_headers": [ "anthropic-version: 2023-06-01", "anthropic-workspace-id: wrkspc_..." ], "iam_actions": [ "aws-external-anthropic:ListModels", "aws-external-anthropic:GetModel", "aws-external-anthropic:CallWithBearerToken (API key auth)" ], "env": [ "AWS_REGION", "ANTHROPIC_AWS_WORKSPACE_ID", "ANTHROPIC_AWS_API_KEY" ], "prereq": "aws iam enable-outbound-web-identity-federation (once per account)" }, "beta_header": null, "request": { "content_type": null, "body_ref": "Claude API shape (identical to first-party)" }, "response": { "body_ref": "Claude API shape", "headers": [ "x-amzn-requestid", "request-id" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicAWS(). # pip install 'anthropic[aws]' (beta)", "node": "new AnthropicAws(). // @anthropic-ai/aws-sdk (beta)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/claude-platform-on-aws-iam-actions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:claude_platform_on_aws", "method": "POST", "path": "https://aws-external-anthropic.{region}.api.aws/v1/files", "name": "Claude Platform on AWS: Files (beta)", "description": "Files API (CreateFile / GetFile / ListFiles / DeleteFile).", "status": [ "DOCUMENTED", "UNVERIFIED", "BETA" ], "auth": { "scheme": "AWS SigV4 (service aws-external-anthropic) or API key", "sigv4": "curl --aws-sigv4 'aws:amz:{region}:aws-external-anthropic'", "api_key": "x-api-key (keys generated in AWS Console; short-term tokens via token-generator-for-aws-external-anthropic, 12h max)", "required_headers": [ "anthropic-version: 2023-06-01", "anthropic-workspace-id: wrkspc_..." ], "iam_actions": [ "aws-external-anthropic:CreateFile", "aws-external-anthropic:GetFile", "aws-external-anthropic:ListFiles", "aws-external-anthropic:DeleteFile", "aws-external-anthropic:CallWithBearerToken (API key auth)" ], "env": [ "AWS_REGION", "ANTHROPIC_AWS_WORKSPACE_ID", "ANTHROPIC_AWS_API_KEY" ], "prereq": "aws iam enable-outbound-web-identity-federation (once per account)" }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "Claude API shape (identical to first-party)" }, "response": { "body_ref": "Claude API shape", "headers": [ "x-amzn-requestid", "request-id" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicAWS(). # pip install 'anthropic[aws]' (beta)", "node": "new AnthropicAws(). // @anthropic-ai/aws-sdk (beta)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/claude-platform-on-aws-iam-actions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:claude_platform_on_aws", "method": "POST", "path": "https://aws-external-anthropic.{region}.api.aws/v1/organizations/workspaces", "name": "Claude Platform on AWS: Admin API workspaces", "description": "Only Admin API surface available: workspaces (create/get/list/update/archive) and external_keys (CMEK). No anthropic-workspace-id header required. ListWorkspaces is account-scoped (Resource '*').", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": { "scheme": "AWS SigV4 (service aws-external-anthropic) or API key", "sigv4": "curl --aws-sigv4 'aws:amz:{region}:aws-external-anthropic'", "api_key": "x-api-key (keys generated in AWS Console; short-term tokens via token-generator-for-aws-external-anthropic, 12h max)", "required_headers": [ "anthropic-version: 2023-06-01", "anthropic-workspace-id: wrkspc_..." ], "iam_actions": [ "aws-external-anthropic:CreateWorkspace", "aws-external-anthropic:GetWorkspace", "aws-external-anthropic:ListWorkspaces", "aws-external-anthropic:UpdateWorkspace", "aws-external-anthropic:ArchiveWorkspace", "aws-external-anthropic:CallWithBearerToken (API key auth)" ], "env": [ "AWS_REGION", "ANTHROPIC_AWS_WORKSPACE_ID", "ANTHROPIC_AWS_API_KEY" ], "prereq": "aws iam enable-outbound-web-identity-federation (once per account)" }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "Claude API shape (identical to first-party)" }, "response": { "body_ref": "Claude API shape", "headers": [ "x-amzn-requestid", "request-id" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicAWS(). # pip install 'anthropic[aws]' (beta)", "node": "new AnthropicAws(). // @anthropic-ai/aws-sdk (beta)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/claude-platform-on-aws-iam-actions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:claude_platform_on_aws", "method": "GET", "path": "https://aws-external-anthropic.{region}.api.aws/v1/compliance/activities", "name": "Claude Platform on AWS: Compliance API activity feed", "description": "Compliance API available; authorized via ListComplianceActivities.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": { "scheme": "AWS SigV4 (service aws-external-anthropic) or API key", "sigv4": "curl --aws-sigv4 'aws:amz:{region}:aws-external-anthropic'", "api_key": "x-api-key (keys generated in AWS Console; short-term tokens via token-generator-for-aws-external-anthropic, 12h max)", "required_headers": [ "anthropic-version: 2023-06-01", "anthropic-workspace-id: wrkspc_..." ], "iam_actions": [ "aws-external-anthropic:ListComplianceActivities", "aws-external-anthropic:CallWithBearerToken (API key auth)" ], "env": [ "AWS_REGION", "ANTHROPIC_AWS_WORKSPACE_ID", "ANTHROPIC_AWS_API_KEY" ], "prereq": "aws iam enable-outbound-web-identity-federation (once per account)" }, "beta_header": null, "request": { "content_type": null, "body_ref": "Claude API shape (identical to first-party)" }, "response": { "body_ref": "Claude API shape", "headers": [ "x-amzn-requestid", "request-id" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicAWS(). # pip install 'anthropic[aws]' (beta)", "node": "new AnthropicAws(). // @anthropic-ai/aws-sdk (beta)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/claude-platform-on-aws-iam-actions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "cloud:claude_platform_on_aws", "method": "POST", "path": "https://aws-external-anthropic.{region}.api.aws/v1/agents", "name": "Claude Platform on AWS: Claude Managed Agents", "description": "Managed Agents (agents, environments, sessions, vaults, memory stores, webhooks, self-hosted sandboxes) available; 6-hour autonomous-session reauthentication; no memory stores on self-hosted environments. Individual IAM actions listed on the IAM actions page (71 actions total).", "status": [ "DOCUMENTED", "UNVERIFIED", "BETA" ], "auth": { "scheme": "AWS SigV4 (service aws-external-anthropic) or API key", "sigv4": "curl --aws-sigv4 'aws:amz:{region}:aws-external-anthropic'", "api_key": "x-api-key (keys generated in AWS Console; short-term tokens via token-generator-for-aws-external-anthropic, 12h max)", "required_headers": [ "anthropic-version: 2023-06-01", "anthropic-workspace-id: wrkspc_..." ], "iam_actions": [ "aws-external-anthropic:(see IAM actions reference)", "aws-external-anthropic:CallWithBearerToken (API key auth)" ], "env": [ "AWS_REGION", "ANTHROPIC_AWS_WORKSPACE_ID", "ANTHROPIC_AWS_API_KEY" ], "prereq": "aws iam enable-outbound-web-identity-federation (once per account)" }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "Claude API shape (identical to first-party)" }, "response": { "body_ref": "Claude API shape", "headers": [ "x-amzn-requestid", "request-id" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "anthropic.AnthropicAWS(). # pip install 'anthropic[aws]' (beta)", "node": "new AnthropicAws(). // @anthropic-ai/aws-sdk (beta)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no cloud credentials" }, "sources": [ { "url": "https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/claude-platform-on-aws-iam-actions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-cloud-endpoints.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "activities", "method": "GET", "path": "/v1/compliance/activities", "name": "Query compliance activities", "description": "List compliance activities for the authenticated tenant. The tenant is the caller's parent organization, or — for an organization with no parent — the organization itself. Returns a paginated list of compliance activities that can be filtered by various criteria.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…) OR admin_api_key (sk-ant-admin01-…)", "scopes": [ "read:compliance_activities", "read:org_audit" ], "note": "Only Compliance endpoint an Admin API key can call (key must have been created while the Compliance API was enabled). On Claude Platform on AWS: IAM action aws-external-anthropic:ListComplianceActivities (SigV4)." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "activity_types[]", "actor_ids[]", "after_id", "before_id", "created_at", "exclude_activity_types[]", "limit", "order", "organization_ids[]", "user_ids[]" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "first_id", "has_more", "last_id" ], "example": "{\"data\": [{\"actor\": {\"api_key_id\": \"api_key_id\", \"ip_address\": \"ip_address\", \"user_agent\": \"user_agent\", \"type\": \"api_actor\"}, \"decision\": \"blocked\", \"id\": \"id\", \"abuse_session_id\": \"abuse_session_id\", \"created_at\": \"2019-12-27T18:11:19.117Z\", \"organization_id\": \"organization_id\", \"organization_uuid\": \"organization_uuid\", \"type\": \"abuse_decision_received\"}], \"first_id\": \"first_id\", \"has_more\": true, \"last_id\": \"last_id\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after_id", "before_id" ], "response_fields": [ "data", "has_more", "first_id", "last_id" ], "note": "Opaque cursors; only one of after_id/before_id per request." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/activities/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-activity-feed", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/artifacts", "method": "GET", "path": "/v1/compliance/apps/artifacts/{artifact_version_id}/content", "name": "Download artifact content", "description": "Download the content of an artifact version for compliance purposes. Returns the full text content of the artifact version.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "artifact_version_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json ({content, title, artifact_type, …})", "schema_ref": null, "fields": [], "example": null }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/artifacts/download", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/artifacts", "method": "GET", "path": "/v1/compliance/apps/artifacts/{artifact_version_id}", "name": "Get artifact metadata", "description": "Returns metadata for an artifact version, without the content body. Use the sibling `/content` endpoint to fetch the artifact text. The `md5` and `size_bytes` fields here are computed over the UTF-8 encoding of that text, so a DLP consumer can dedupe or match hashes without downloading every artifact.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "artifact_version_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "id", "artifact_type", "claude_chat_id", "created_at", "md5", "size_bytes", "title", "version_id" ], "example": "{\"id\": \"id\", \"artifact_type\": \"artifact_type\", \"claude_chat_id\": \"claude_chat_id\", \"created_at\": \"2019-12-27T18:11:19.117Z\", \"md5\": \"md5\", \"size_bytes\": 0, \"title\": \"title\", \"version_id\": \"version_id\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/artifacts/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/chats", "method": "DELETE", "path": "/v1/compliance/apps/chats/{claude_chat_id}", "name": "Delete chat", "description": "Permanently deletes a chat and all associated messages and files. This is a destructive operation that cannot be undone.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "delete:compliance_user_data" ], "note": "Compliance Access Key only; scope 'Needed' (not 'one of'). Destructive, permanent, immediate." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "claude_chat_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "type", "id" ], "example": "{\"id\": \"claude_chat_abc123\", \"type\": \"claude_chat_deleted\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "not idempotent in effect: first call deletes, repeat returns 404", "destructive": true, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/chats/delete", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/chats/files", "method": "DELETE", "path": "/v1/compliance/apps/chats/files/{claude_file_id}", "name": "Delete file", "description": "Permanently deletes a specific file. This is a destructive operation that cannot be undone.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "delete:compliance_user_data" ], "note": "Compliance Access Key only; scope 'Needed' (not 'one of'). Destructive, permanent, immediate." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "claude_file_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "type", "id" ], "example": "{\"id\": \"claude_file_xyz789\", \"type\": \"claude_file_deleted\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "not idempotent in effect: first call deletes, repeat returns 404", "destructive": true, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/chats/files/delete", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/chats/files", "method": "GET", "path": "/v1/compliance/apps/chats/files/{claude_file_id}/content", "name": "Download file content", "description": "Downloads the binary content of a file referenced in chat messages.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "claude_file_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/octet-stream (chunked; Content-Disposition, Content-Type, Content-MD5)", "schema_ref": null, "fields": [], "example": null }, "streaming": { "supported": false, "events_ref": null, "note": "Content endpoints stream a chunked HTTP body (not SSE)." }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/chats/files/download", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/chats/files", "method": "GET", "path": "/v1/compliance/apps/chats/files/{claude_file_id}", "name": "Get file metadata", "description": "Retrieves metadata for a file referenced in chat messages, without downloading the file content. Use the sibling `/content` endpoint to download the bytes.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "claude_file_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "id", "claude_chat_ids", "created_at", "filename", "md5", "message_ids", "mime_type", "size_bytes" ], "example": "{\"id\": \"claude_file_xyz789\", \"filename\": \"quarterly_report.pdf\", \"mime_type\": \"application/pdf\", \"size_bytes\": 1048576, \"md5\": \"5d41402abc4b2a76b9719d911017c592\", \"created_at\": \"2024-01-15T10:30:00Z\", \"message_ids\": [\"claude_chat_msg_abc123\"], \"claude_chat_ids\": [\"claude_chat_def456\"]}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/chats/files/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/chats/generated_files", "method": "GET", "path": "/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content", "name": "Download a Claude-generated file", "description": "Downloads the binary content of a file the assistant created via tool use.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "claude_gen_file_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/octet-stream (chunked; Content-Disposition, Content-Type, Content-MD5)", "schema_ref": null, "fields": [], "example": null }, "streaming": { "supported": false, "events_ref": null, "note": "Content endpoints stream a chunked HTTP body (not SSE)." }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/chats/generated_files/download", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/chats/generated_files", "method": "GET", "path": "/v1/compliance/apps/chats/generated-files/{claude_gen_file_id}", "name": "Get Claude-generated file metadata", "description": "Returns metadata for a file the assistant created via tool use. Use the sibling `/content` endpoint to download the bytes.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "claude_gen_file_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "id", "claude_chat_id", "created_at", "filename", "md5", "mime_type", "size_bytes" ], "example": "{\"id\": \"id\", \"claude_chat_id\": \"claude_chat_id\", \"created_at\": \"2019-12-27T18:11:19.117Z\", \"filename\": \"filename\", \"md5\": \"md5\", \"mime_type\": \"mime_type\", \"size_bytes\": 0}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/chats/generated_files/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/chats", "method": "GET", "path": "/v1/compliance/apps/chats", "name": "List chats", "description": "Lists chat metadata with filtering capabilities for targeted compliance review. Results are sorted chronologically (time ascending) by the `order_by` key, with ties broken by id. filter is deprecated and will be rejected with HTTP 400 after 2026-09-22. For incremental polling by update time, omit `user_ids[]` and set `order_by=updated_at` with `after_id` cursor pagination — this returns the same chats across the whole organization in a single request stream. For per-user listing, use `created_at.*` filters (or no time filter) with the default `order_by`. `user_ids[]` with `order_by=updated_at` is already rejected.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "after_id", "before_id", "created_at", "limit", "order_by", "organization_ids[]", "project_ids[]", "updated_at", "user_ids[]" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "first_id", "has_more", "last_id" ], "example": "{\"data\": [{\"id\": \"claude_chat_abc123\", \"name\": \"Product Requirements Discussion\", \"created_at\": \"2025-06-07T08:09:10Z\", \"updated_at\": \"2025-06-07T09:10:11Z\", \"organization_id\": \"org_abc123\", \"organization_uuid\": \"abcdef01-2345-6789-abcd-ef0123456789\", \"project_id\": \"claude_proj_xyz789\", \"model\": \"claude-opus-5\", \"user\": {\"id\": \"user_xyz456\", \"email_address\": \"user@example.com\"}, \"href\": \"https://claude.ai/chat/abcdef01-2345-6789-abcd-ef0123456789\"}], \"has_more\": false, \"first_id\": \"eyJrIjogImNyZWF0ZWRfYXQiLCAidCI6ICIyMDI1LTA2LTA3VDA4OjA5OjEwKzAwOjAwIiwgImlkIjogImFiY2RlZjAxLTIzNDUtNjc4OS1hYmNkLWVmMDEyMzQ1Njc4OSJ9\", \"last_id\": \"eyJrIjogImNyZWF0ZWRfYXQiLCAidCI6ICIyMDI1LTA2LTA3VDA4OjA5OjEwKzAwOjAwIiwgImlkIjogImFiY2RlZjAxLTIzNDUtNjc4OS1hYmNkLWVmMDEyMzQ1Njc4OSJ9\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after_id", "before_id" ], "response_fields": [ "data", "has_more", "first_id", "last_id" ], "note": "Opaque cursors; only one of after_id/before_id per request." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/chats/messages", "method": "GET", "path": "/v1/compliance/apps/chats/{claude_chat_id}/messages", "name": "Get chat messages", "description": "Retrieves message history and file metadata for a specific chat.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "claude_chat_id" ], "query_params": [ "after_id", "before_id", "created_at", "limit", "order", "tool_result_max_chars", "tool_use_input_max_chars", "updated_at" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "id", "chat_messages", "created_at", "deleted_at", "first_id", "has_more", "href", "last_id", "model", "name", "organization_uuid", "project_id", "updated_at", "user", "organization_id" ], "example": "{\"id\": \"claude_chat_abc123\", \"name\": \"Product Requirements Discussion\", \"created_at\": \"2025-06-07T08:09:10Z\", \"updated_at\": \"2025-06-07T08:09:11Z\", \"organization_id\": \"org_abc123\", \"organization_uuid\": \"abcdef01-2345-6789-abcd-ef0123456789\", \"project_id\": \"claude_proj_xyz789\", \"model\": \"claude-opus-5\", \"user\": {\"id\": \"user_xyz456\", \"email_address\": \"user@example.com\"}, \"href\": \"https://claude.ai/chat/abcdef01-2345-6789-abcd-ef0123456789\", \"chat_messages\": [{\"id\": \"claude_chat_msg_abc123\", \"role\": \"user\", \"created_at\": \"2025-06-07T08:09:10Z\", \"content\": [{\"type\": \"text\", \"text\": \"Can you help me draft requirements for our new dashboard feature?\"}], \"files\": [{\"id\": \"claude_file_xyz789\", \"filename\": \"dashboard_mockup_v1.pdf\", \"mime_type\": \"application/pdf\", \"size_bytes\": 12345, \"md5\": \"5d41402abc4b2a76b9719d911017c592\", \"created_at\": \"2025-06-07T08:09:10Z\"}]}, {\"id\": \"claude_chat_msg_def456\", \"role\": \"assistant\", \"created_at\": \"2025-06-07T08:09:11Z\", \"content\": [{\"type\": \"text\", \"text\": \"I'd be happy to help you draft requirements for your dashboard feature...\"}], \"artifacts\": [{\"id\": \"claude_artifact_abc123\", \"version_id\": \"claude_artifact_version_xyz789\", \"title\": \"Dashboard Requirements Draft\", \"artifact_type\": \"text/markdown\"}]}], \"has_more\": false, \"first_id\": \"eyJtc2dfdXVpZCI6ICIwZjcwYjA2Ni0uLi4ifQ==\", \"last_id\": \"eyJtc2dfdXVpZCI6ICJhNGUwYjE3Mi0uLi4ifQ==\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after_id", "before_id" ], "response_fields": [ "data", "has_more", "first_id", "last_id" ], "note": "Opaque cursors; only one of after_id/before_id per request." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/projects/attachments", "method": "GET", "path": "/v1/compliance/apps/projects/{project_id}/attachments", "name": "List project attachments", "description": "List files and documents attached to a project. List files and project documents attached to the project referenced by project_id. This includes the IDs of attached files, and attached project documents. The raw binary content of attached files can be downloaded using the GET /v1/compliance/apps/chats/files/{claude_file_id}/content endpoint. The text content of attached project documents can be fetched using the GET /v1/compliance/apps/projects/documents/{claude_proj_doc_id} endpoint.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "project_id" ], "query_params": [ "limit", "page" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "has_more", "next_page" ], "example": "{\"data\": [{\"id\": \"id\", \"created_at\": \"2019-12-27T18:11:19.117Z\", \"filename\": \"filename\", \"md5\": \"md5\", \"mime_type\": \"mime_type\", \"size_bytes\": 0, \"type\": \"project_file\"}], \"has_more\": true, \"next_page\": \"next_page\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request_params": [ "limit", "page" ], "response_fields": [ "data", "next_page", "has_more" ], "note": "Pass next_page back as page; stop when next_page is null / has_more is false." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/projects/attachments/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/projects/collaborators", "method": "GET", "path": "/v1/compliance/apps/projects/{project_id}/collaborators", "name": "List project collaborators", "description": "List the users, groups, and organization-wide grants on a project. Each entry represents one active role assignment on the project. Principals are returned as a discriminated union on `type` — an individual user, an RBAC group, the whole organization, or all holders of an organization-level role.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403. Scope inferred from resource family (reference page does not state it explicitly)." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "project_id" ], "query_params": [ "limit", "page" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "has_more", "next_page" ], "example": "{\"data\": [{\"granted_at\": \"2019-12-27T18:11:19.117Z\", \"role\": \"admin\", \"type\": \"user\", \"user_id\": \"user_id\"}], \"has_more\": true, \"next_page\": \"next_page\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request_params": [ "limit", "page" ], "response_fields": [ "data", "next_page", "has_more" ], "note": "Pass next_page back as page; stop when next_page is null / has_more is false." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/projects/collaborators/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/projects", "method": "DELETE", "path": "/v1/compliance/apps/projects/{project_id}", "name": "Delete project", "description": "Delete a project for compliance purposes. Hard-deletes the project and all its associated data including: - All project documents and files - All role assignments - Knowledge base (if RAG is enabled) - Sync sources Project must have no attached chats - returns 409 if chats exist.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "delete:compliance_user_data" ], "note": "Compliance Access Key only; scope 'Needed' (not 'one of'). Destructive, permanent, immediate." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "project_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "type", "id" ], "example": "{\"id\": \"id\", \"type\": \"claude_project_deleted\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "not idempotent in effect: first call deletes, repeat returns 404", "destructive": true, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/projects/delete", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/projects/documents", "method": "DELETE", "path": "/v1/compliance/apps/projects/documents/{document_id}", "name": "Delete project document", "description": "Delete a project document for compliance purposes. Hard-deletes the project document permanently.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "delete:compliance_user_data" ], "note": "Compliance Access Key only; scope 'Needed' (not 'one of'). Destructive, permanent, immediate." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "document_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "type", "id" ], "example": "{\"id\": \"id\", \"type\": \"claude_project_document_deleted\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "not idempotent in effect: first call deletes, repeat returns 404", "destructive": true, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/delete", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/projects/documents", "method": "GET", "path": "/v1/compliance/apps/projects/documents/{document_id}/metadata", "name": "Get project document metadata", "description": "Returns metadata for a project document, without the content body. Use the sibling `GET /v1/compliance/apps/projects/documents/{document_id}` endpoint to fetch the document text. The `md5` and `size_bytes` fields here are computed over the UTF-8 encoding of that text, so a DLP consumer can dedupe or match hashes without downloading every document.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "document_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "id", "claude_project_id", "created_at", "filename", "md5", "mime_type", "size_bytes", "user" ], "example": "{\"id\": \"id\", \"claude_project_id\": \"claude_project_id\", \"created_at\": \"2019-12-27T18:11:19.117Z\", \"filename\": \"filename\", \"md5\": \"md5\", \"mime_type\": \"text/plain\", \"size_bytes\": 0, \"user\": {\"id\": \"user_01WCz1FkmYMm4gnmykNKUu3Q\", \"email_address\": \"jane.doe@example.com\"}}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/metadata", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/projects/documents", "method": "GET", "path": "/v1/compliance/apps/projects/documents/{document_id}", "name": "Get project document content", "description": "Get detailed information for a specific project document.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "document_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "id", "content", "created_at", "filename", "user" ], "example": "{\"id\": \"claude_proj_doc_01Qr8StUvWxYzAbCdEfGhJjK\", \"content\": \"# Design notes\\n\\n- Item one\\n- Item two\\n\", \"created_at\": \"2025-03-12T18:22:41.123456Z\", \"filename\": \"design-notes.txt\", \"user\": {\"id\": \"user_01WCz1FkmYMm4gnmykNKUu3Q\", \"email_address\": \"jane.doe@example.com\"}}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/projects", "method": "GET", "path": "/v1/compliance/apps/projects", "name": "List projects", "description": "Lists project metadata with filtering capabilities. Results are sorted chronologically (time ascending) by created_at.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "created_at", "limit", "organization_ids[]", "page", "updated_at", "user_ids[]" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "has_more", "next_page" ], "example": "{\"data\": [{\"id\": \"claude_proj_abc123\", \"name\": \"Q4 Product Planning\", \"created_at\": \"2025-06-01T10:00:00Z\", \"updated_at\": \"2025-06-15T14:30:00Z\", \"is_private\": true, \"organization_id\": \"org_abc123\", \"organization_uuid\": \"abc12345-6789-0abc-def0-123456789abc\", \"user\": {\"id\": \"user_xyz456\", \"email_address\": \"user@example.com\"}}], \"has_more\": true, \"next_page\": \"page_eyJjcmVhdGVkX2F0IjoiMjAyNS0wNi0wMVQxMDowMDowMFoiLCJ1dWlkIjoiYWJjMTIzIn0=\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request_params": [ "limit", "page" ], "response_fields": [ "data", "next_page", "has_more" ], "note": "Pass next_page back as page; stop when next_page is null / has_more is false." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/projects", "method": "GET", "path": "/v1/compliance/apps/projects/{project_id}", "name": "Get project details", "description": "Get detailed information for a specific project.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "project_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "id", "attachments_count", "chats_count", "created_at", "deleted_at", "description", "instructions", "is_private", "name", "organization_uuid", "updated_at", "user", "organization_id" ], "example": "{\"id\": \"claude_proj_01Nm7PqRsTuVwXyZaBcDeFgH\", \"attachments_count\": 3, \"chats_count\": 14, \"created_at\": \"2025-03-12T18:22:41.123456Z\", \"deleted_at\": \"2019-12-27T18:11:19.117Z\", \"description\": \"Planning and research for the Q3 launch\", \"instructions\": \"Focus on concise, actionable answers.\", \"is_private\": true, \"name\": \"Q3 Product Launch\", \"organization_id\": \"org_015eofRkKpogX7uDKUyvBTph\", \"organization_uuid\": \"a1b2c3d4-e5f6-4789-a012-3456789abcde\", \"updated_at\": \"2025-03-14T09:05:17.456789Z\", \"user\": {\"id\": \"user_01WCz1FkmYMm4gnmykNKUu3Q\", \"email_address\": \"jane.doe@example.com\"}}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/projects/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/sessions/local", "method": "GET", "path": "/v1/compliance/apps/sessions/local", "name": "List local sessions", "description": "List local sessions across the organizations the key may read. Results are ordered by `created_at` descending. Pagination is forward-only via `next_page`; there is no reverse cursor.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "created_at", "limit", "page", "updated_at" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "next_page" ], "example": "{\"data\": [{\"type\": \"compliance_local_session\", \"id\": \"clls_eyJ2IjoxLCJvIjoiOWEx\\u2026\", \"organization_uuid\": \"9a1e0000-0000-0000-0000-000000000000\", \"workspace_id\": \"wrkspc_01SvYKoWVRVHoEbwESNvzYdR\", \"user\": {\"id\": \"user_01GpKpLmNoPqRsTuVwXyZaBc\", \"email_address\": \"engineer@example.com\"}, \"product_surface\": \"cowork\", \"created_at\": \"2026-07-09T14:02:11Z\", \"updated_at\": \"2026-07-09T15:47:33Z\"}]}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request_params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ], "note": "Pass next_page back as page; stop when next_page is null (session endpoints return no has_more; local-session page tokens expire 24 h after the walk starts)." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-sessions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/sessions/local", "method": "GET", "path": "/v1/compliance/apps/sessions/local/{local_session_id}/messages", "name": "Retrieve local session messages", "description": "Read one local session's transcript, oldest-first by default. Retention is enforced read-side: turns at or before the child organization's retention boundary are never returned; a session that straddles the boundary carries one leading `content_unavailable` placeholder (`reason: \"retention_elapsed\"`) in their place. The boundary is pinned on the walk's first page and honored for 24 hours: a cursor older than that is rejected with an explicit 400; restart the walk to read under the current boundary.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "local_session_id" ], "query_params": [ "limit", "order", "page", "tool_result_max_bytes", "tool_use_input_max_bytes" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "next_page", "session" ], "example": "{\"data\": [{\"id\": \"clsm_eyJ2IjoxLCJsIjoi\\u2026\", \"content\": [{\"text\": \"text\", \"truncated\": true, \"type\": \"text\"}], \"created_at\": \"2025-03-12T18:22:41.123456Z\", \"model\": \"claude-opus-5\", \"provenance\": {\"reason\": \"not_captured\", \"type\": \"content_unavailable\"}, \"role\": \"assistant\", \"type\": \"compliance_local_session_message\"}], \"next_page\": \"page_eyJ2IjoxLCJmIjoibSIs\\u2026\", \"session\": {\"id\": \"clls_eyJ2IjoxLCJvIjoiOWEx\\u2026\", \"created_at\": \"2025-03-12T18:22:41.123456Z\", \"organization_uuid\": \"a1b2c3d4-e5f6-4789-a012-3456789abcde\", \"product_surface\": \"cowork\", \"truncated\": true, \"type\": \"compliance_local_session\", \"updated_at\": \"2025-03-12T18:22:41.123456Z\", \"user\": {\"id\": \"user_01WCz1FkmYMm4gnmykNKUu3Q\", \"email_address\": \"jane.doe@example.com\"}, \"workspace_id\": \"wrkspc_01SvYKoWVRVHoEbwESNvzYdR\"}}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request_params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ], "note": "Pass next_page back as page; stop when next_page is null (session endpoints return no has_more; local-session page tokens expire 24 h after the walk starts)." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/messages/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-sessions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/sessions/local", "method": "GET", "path": "/v1/compliance/apps/sessions/local/{local_session_id}", "name": "Retrieve a local session", "description": "Retrieve one local session. The response is the same session object the list endpoint returns, with `user.email_address` resolved the same way. Retention is enforced when the response is served: a session whose every inference call has aged out returns 404.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "local_session_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "type", "id", "created_at", "organization_uuid", "product_surface", "truncated", "updated_at", "user", "workspace_id" ], "example": "{\"type\": \"compliance_local_session\", \"id\": \"clls_eyJ2IjoxLCJvIjoiOWEx\\u2026\", \"organization_uuid\": \"9a1e0000-0000-0000-0000-000000000000\", \"workspace_id\": \"wrkspc_01SvYKoWVRVHoEbwESNvzYdR\", \"user\": {\"id\": \"user_01GpKpLmNoPqRsTuVwXyZaBc\", \"email_address\": \"engineer@example.com\"}, \"product_surface\": \"cowork\", \"created_at\": \"2026-07-09T14:02:11Z\", \"updated_at\": \"2026-07-09T15:47:33Z\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-sessions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/sessions/remote", "method": "GET", "path": "/v1/compliance/apps/sessions/remote", "name": "List remote sessions", "description": "List remote sessions (Cowork sessions that run in Anthropic-managed cloud environments) across the organizations the key may read. Each entry carries session metadata only; retrieve a session's transcript from the messages endpoint. By default the list spans every such organization; pass up to 500 `organization_ids[]` values to narrow it. Pass 1 to 10 `user_ids[]` values to scope the list to specific users: that filter matches the session's owning user, so agent-owned sessions are excluded whenever it is set. Bound results in time with the `created_at` range parameters (`created_at.gte`, `created_at.gt`, `created_at.lt`, `created_at.lte`; RFC 3339). There is no `updated_at` filter. Results are sorted newest first by `created_at`, with at most `limit` sessions per page (default 100, maximum 500). Pagination is forward-only: pass the response's `next_page` value back as `page` to retrieve the next page, and stop when `next_page` is null.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "created_at", "limit", "organization_ids[]", "page", "user_ids[]" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "next_page" ], "example": "{\"data\": [{\"id\": \"cse_01A0000000000000000000000\", \"organization_uuid\": \"00000000-0000-0000-0000-000000000000\", \"user\": {\"id\": \"user_01A0000000000000000000000\", \"email_address\": \"user@example.com\"}, \"status\": \"active\", \"created_at\": \"2026-01-02T03:04:05.000000Z\", \"updated_at\": \"2026-01-02T03:04:05.000000Z\", \"product_surface\": \"cowork_remote\", \"claude_project_id\": \"claude_proj_01Nm7PqRsTuVwXyZaBcDeFgH\"}], \"next_page\": \"page_AAE...\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request_params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ], "note": "Pass next_page back as page; stop when next_page is null (session endpoints return no has_more; local-session page tokens expire 24 h after the walk starts)." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-sessions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "apps/sessions/remote", "method": "GET", "path": "/v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages", "name": "Retrieve remote session messages", "description": "Retrieve one remote session's transcript: user prompts, assistant responses, and tool calls and results. Thinking blocks and images are not included. Messages are returned oldest first by default; pass `order=desc` to reverse. Pagination uses the same `page`/`next_page` scheme as the list endpoint, with at most `limit` messages per page (default 100, maximum 1000); keep paginating until `next_page` is null. `tool_use_input_max_bytes` and `tool_result_max_bytes` cap how many bytes of each tool-use input and each tool-result text item are returned; a block shortened by either cap carries `truncated: true`. The response embeds the session's metadata under `session` alongside the paginated `data` array. On this endpoint `session.user.email_address` and `session.started_by_user` are always null; read them from the list endpoint instead. Returns 404 while the session is still `pending`, for deleted sessions, and for sessions outside the organizations the key may read. A malformed session identifier returns 400.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "claude_remote_session_id" ], "query_params": [ "limit", "order", "page", "tool_result_max_bytes", "tool_use_input_max_bytes" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "next_page", "session" ], "example": "{\"data\": [{\"id\": \"id\", \"content\": [{\"text\": \"text\", \"truncated\": true, \"type\": \"text\"}], \"content_unavailable\": true, \"created_at\": \"2019-12-27T18:11:19.117Z\", \"role\": \"assistant\", \"sent_by_user_id\": \"sent_by_user_id\"}], \"next_page\": \"next_page\", \"session\": {\"id\": \"id\", \"agent_id\": \"agent_id\", \"claude_project_id\": \"claude_project_id\", \"created_at\": \"2019-12-27T18:11:19.117Z\", \"organization_uuid\": \"organization_uuid\", \"product_surface\": \"product_surface\", \"started_by_user\": {\"id\": \"id\", \"email_address\": \"email_address\"}, \"status\": \"status\", \"updated_at\": \"2019-12-27T18:11:19.117Z\", \"user\": {\"id\": \"id\", \"email_address\": \"email_address\"}}}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request_params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ], "note": "Pass next_page back as page; stop when next_page is null (session endpoints return no has_more; local-session page tokens expire 24 h after the walk starts)." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/messages/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-sessions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "code/artifacts", "method": "DELETE", "path": "/v1/compliance/apps/code/artifacts/{artifact_id}", "name": "Delete Code Artifact", "description": "Permanently deletes a Code Artifact and all its versions. This is a destructive operation that cannot be undone. A 200 response means the deletion is initiated and the Artifact is claimed; content removal completes asynchronously. Returns 404 for Artifacts that don't exist or belong to another parent organization. Returns 404 on a repeated delete of an already-deleted Artifact.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "delete:compliance_user_data" ], "note": "Compliance Access Key only; scope 'Needed' (not 'one of'). Destructive, permanent, immediate." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "artifact_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "type", "id" ], "example": "{\"id\": \"cart_xyz789\", \"type\": \"code_artifact_deleted\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "not idempotent in effect: first call deletes, repeat returns 404", "destructive": true, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/delete", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "code/artifacts", "method": "GET", "path": "/v1/compliance/apps/code/artifacts", "name": "List Code Artifacts", "description": "List Claude Code Artifacts owned by organizations under the parent organization. Results are sorted by Artifact identifier. Pages may be short or empty while `next_page` is still set — continue until `next_page` is absent. Artifacts are sorted by identifier (not creation time): an Artifact published during an export may land before the cursor and be omitted, so for a point-in-time-complete export re-enumerate after publishing quiesces. Artifacts owned by a since-deleted child organization are not returned.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403. Scope inferred from resource family (reference page does not state it explicitly)." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "limit", "organization_ids[]", "page", "updated_at", "user_ids[]" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "has_more", "next_page" ], "example": "{\"data\": [{\"id\": \"cart_01Tu9VwXyZaBcDeFgHiJkLmN\", \"organization_uuid\": \"a1b2c3d4-e5f6-4789-a012-3456789abcde\", \"owner_user_id\": \"user_01WCz1FkmYMm4gnmykNKUu3Q\", \"published_version_id\": \"1741803761-9f3a\", \"read_mode\": \"org\", \"updated_at\": \"2025-03-14T09:05:17.456789Z\", \"user\": {\"id\": \"user_01WCz1FkmYMm4gnmykNKUu3Q\", \"email_address\": \"jane.doe@example.com\"}, \"versions\": [{\"id\": \"1741803761-9f3a\", \"created_at\": \"2025-03-12T18:22:41.123456Z\", \"name\": \"Team dashboard\"}]}], \"has_more\": true, \"next_page\": \"cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA=\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request_params": [ "limit", "page" ], "response_fields": [ "data", "next_page", "has_more" ], "note": "Pass next_page back as page; stop when next_page is null / has_more is false." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "code/artifacts", "method": "GET", "path": "/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}", "name": "Download Code Artifact Version Content", "description": "Streams the content of one version of a Claude Code Artifact as the response body. Returns 404 for Artifacts that don't exist or belong to another parent organization. A listed version id can start returning 404 if subsequent publishes rotated it out of retained history — re-list on 404. Returns 503 while the version's content upload is still in flight or was abandoned — retry with backoff. Oversized encoded content aborts mid-stream: headers and initial bytes arrive but the body terminates early — an aborted chunked transfer is the only truncation signal for encoded content. `Content-MD5` is emitted only for identity-stored content; validate against it when present.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403. Scope inferred from resource family (reference page does not state it explicitly)." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "artifact_id", "version_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/octet-stream (chunked; Content-Disposition, Content-Type, Content-MD5)", "schema_ref": null, "fields": [], "example": null }, "streaming": { "supported": false, "events_ref": null, "note": "Content endpoints stream a chunked HTTP body (not SSE)." }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/retrieve_version", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-content-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "groups", "method": "GET", "path": "/v1/compliance/groups", "name": "List Compliance Groups", "description": "List Compliance Groups", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_org_data", "read:org_audit" ], "note": "Compliance Access Key only (Enterprise). read:compliance_org_settings retired 2026-06-30." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "limit", "name_prefix", "page" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "has_more", "next_page" ], "example": "{\"data\": [{\"id\": \"rbac_group_012rppKaSVsmTo6NqRDXQXNF\", \"created_at\": \"2025-03-12T18:22:41.123456Z\", \"description\": \"All members of the engineering organization\", \"name\": \"Engineering Team\", \"roles\": [\"rbac_role_01SGBg3kEnZrdsVR2QmyJbvD\", \"rbac_role_01HtCd4mFoAseWS3RnzKcwE7\"], \"source_type\": \"scim\", \"updated_at\": \"2025-03-14T09:05:17.456789Z\"}], \"has_more\": true, \"next_page\": \"cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA=\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request_params": [ "limit", "page" ], "response_fields": [ "data", "next_page", "has_more" ], "note": "Pass next_page back as page; stop when next_page is null / has_more is false." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/groups/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-org-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "groups/members", "method": "GET", "path": "/v1/compliance/groups/{group_id}/members", "name": "List Compliance Group Members", "description": "List Compliance Group Members", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "group_id" ], "query_params": [ "limit", "page" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "has_more", "next_page" ], "example": "{\"data\": [{\"created_at\": \"2025-03-12T18:22:41.123456Z\", \"email\": \"jane.doe@example.com\", \"updated_at\": \"2025-03-14T09:05:17.456789Z\", \"user_id\": \"user_01WCz1FkmYMm4gnmykNKUu3Q\"}], \"has_more\": true, \"next_page\": \"cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA=\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request_params": [ "limit", "page" ], "response_fields": [ "data", "next_page", "has_more" ], "note": "Pass next_page back as page; stop when next_page is null / has_more is false." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/groups/members/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-org-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "groups", "method": "GET", "path": "/v1/compliance/groups/{group_id}", "name": "Get Compliance Group", "description": "Get Compliance Group", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_org_data", "read:org_audit" ], "note": "Compliance Access Key only (Enterprise). read:compliance_org_settings retired 2026-06-30." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "group_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "id", "created_at", "description", "name", "roles", "source_type", "updated_at" ], "example": "{\"id\": \"rbac_group_012rppKaSVsmTo6NqRDXQXNF\", \"created_at\": \"2025-03-12T18:22:41.123456Z\", \"description\": \"All members of the engineering organization\", \"name\": \"Engineering Team\", \"roles\": [\"rbac_role_01SGBg3kEnZrdsVR2QmyJbvD\", \"rbac_role_01HtCd4mFoAseWS3RnzKcwE7\"], \"source_type\": \"scim\", \"updated_at\": \"2025-03-14T09:05:17.456789Z\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/groups/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-org-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "organizations", "method": "GET", "path": "/v1/compliance/organizations", "name": "List organizations", "description": "List organizations under the parent organization. Returns organizations sorted by creation date in ascending order. Use `limit` and `page` to paginate: each response includes `has_more` and a `next_page` token to pass on the next request.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_org_data", "read:org_audit" ], "note": "Compliance Access Key only (Enterprise). read:compliance_org_settings retired 2026-06-30." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "limit", "page" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "has_more", "next_page" ], "example": "{\"data\": [{\"created_at\": \"2025-03-12T18:22:41.123456+00:00\", \"name\": \"Acme Corp\", \"uuid\": \"a1b2c3d4-e5f6-4789-a012-3456789abcde\"}], \"has_more\": true, \"next_page\": \"cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA=\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request_params": [ "limit", "page" ], "response_fields": [ "data", "next_page", "has_more" ], "note": "Pass next_page back as page; stop when next_page is null / has_more is false." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/organizations/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-org-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "organizations/roles", "method": "GET", "path": "/v1/compliance/organizations/{org_uuid}/roles", "name": "List Compliance Roles", "description": "List Compliance Roles", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_org_data", "read:org_audit" ], "note": "Compliance Access Key only (Enterprise). read:compliance_org_settings retired 2026-06-30." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "org_uuid" ], "query_params": [ "limit", "page" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "has_more", "next_page" ], "example": "{\"data\": [{\"id\": \"rbac_role_01SGBg3kEnZrdsVR2QmyJbvD\", \"created_at\": \"2025-03-12T18:22:41.123456Z\", \"description\": \"Full administrative access to organization settings and members\", \"name\": \"Organization Admin\", \"updated_at\": \"2025-03-14T09:05:17.456789Z\"}], \"has_more\": true, \"next_page\": \"cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA=\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request_params": [ "limit", "page" ], "response_fields": [ "data", "next_page", "has_more" ], "note": "Pass next_page back as page; stop when next_page is null / has_more is false." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/organizations/roles/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-org-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "organizations/roles/permissions", "method": "GET", "path": "/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions", "name": "List Compliance Role Permissions", "description": "List Compliance Role Permissions", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_org_data", "read:org_audit" ], "note": "Compliance Access Key only (Enterprise). read:compliance_org_settings retired 2026-06-30." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "org_uuid", "role_id" ], "query_params": [ "limit", "page" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "has_more", "next_page" ], "example": "{\"data\": [{\"action\": \"claude_code\", \"resource_id\": \"a1b2c3d4-e5f6-4789-a012-3456789abcde\", \"resource_type\": \"organization\"}], \"has_more\": true, \"next_page\": \"cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA=\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request_params": [ "limit", "page" ], "response_fields": [ "data", "next_page", "has_more" ], "note": "Pass next_page back as page; stop when next_page is null / has_more is false." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/organizations/roles/permissions/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-org-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "organizations/roles", "method": "GET", "path": "/v1/compliance/organizations/{org_uuid}/roles/{role_id}", "name": "Get Compliance Role", "description": "Get Compliance Role", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_org_data", "read:org_audit" ], "note": "Compliance Access Key only (Enterprise). read:compliance_org_settings retired 2026-06-30." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "org_uuid", "role_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "id", "created_at", "description", "name", "updated_at" ], "example": "{\"id\": \"rbac_role_01SGBg3kEnZrdsVR2QmyJbvD\", \"created_at\": \"2025-03-12T18:22:41.123456Z\", \"description\": \"Full administrative access to organization settings and members\", \"name\": \"Organization Admin\", \"updated_at\": \"2025-03-14T09:05:17.456789Z\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/organizations/roles/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-org-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "organizations/settings", "method": "GET", "path": "/v1/compliance/organizations/{organization_id}/settings", "name": "Get effective organization settings", "description": "Retrieve the effective settings for an organization. Returns the settings currently in force for the given organization — the enforced state after all policies are applied, which may differ from what is configured in the admin console. Settings an organization's administrators cannot change (for example, ones controlled by Anthropic policy or not available to the organization) are omitted from the list. Settings that report a compliance arrangement with Anthropic are the exception: the HIPAA and Access Transparency settings are always included; the API zero data retention setting is reported for Claude Console organizations, and the Claude Code zero data retention and customer-managed encryption keys (CMEK) settings for Claude Enterprise organizations. Each reports whether the arrangement is in place at the organization level; a retention setting on an individual workspace is not reflected. The organization must belong to the API key's organization hierarchy; unknown organizations and organizations outside the hierarchy return 404.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_org_data", "read:org_audit" ], "note": "Compliance Access Key only (Enterprise). read:compliance_org_settings retired 2026-06-30." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "organization_id" ], "query_params": [] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "type", "api_keys", "organization_id", "settings" ], "example": "{\"api_keys\": [{\"id\": \"id\", \"created_at\": \"2019-12-27T18:11:19.117Z\", \"created_by_id\": \"created_by_id\", \"is_active\": true, \"name\": \"name\", \"scopes\": [\"string\"], \"expires_at\": \"2019-12-27T18:11:19.117Z\", \"type\": \"compliance_api_key\"}], \"organization_id\": \"organization_id\", \"settings\": [{\"name\": \"access_transparency_enabled\", \"value\": true, \"type\": \"boolean\"}], \"type\": \"effective_organization_settings\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/organizations/settings/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-org-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "compliance", "resource_group": "organizations/users", "method": "GET", "path": "/v1/compliance/organizations/{org_uuid}/users", "name": "List organization users", "description": "List current user members of an organization.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "api_key", "header": "x-api-key", "base_url": "https://api.anthropic.com", "version_header": "anthropic-version: 2023-06-01", "key_type": "compliance_access_key (sk-ant-api01-…)", "scopes": [ "read:compliance_user_data", "read:org_audit" ], "note": "Compliance Access Key only (Claude Enterprise tenant); Admin API keys get 403." }, "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "org_uuid" ], "query_params": [ "limit", "page" ] }, "response": { "status": 200, "content_type": "application/json", "schema_ref": "object", "fields": [ "data", "has_more", "next_page" ], "example": "{\"data\": [{\"id\": \"user_01WCz1FkmYMm4gnmykNKUu3Q\", \"created_at\": \"2025-03-12T18:22:41.123456Z\", \"email\": \"jane.doe@example.com\", \"full_name\": \"Jane Doe\", \"organization_role\": \"admin\"}], \"has_more\": true, \"next_page\": \"cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA=\"}" }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request_params": [ "limit", "page" ], "response_fields": [ "data", "next_page", "has_more" ], "note": "Pass next_page back as page; stop when next_page is null / has_more is false." }, "idempotency": "safe (read-only)", "destructive": false, "sdk": { "python": null, "node": null, "note": "No compliance methods in sources/anthropic/openapi/{python,node}-sdk-api.md (grep 'compliance' → only beta.organization.compliance_settings)." }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Not called. The Compliance API requires a Claude Enterprise tenant with the Compliance API enabled and a Compliance Access Key (sk-ant-api01-) or entitled Admin API key; this account has neither. Delete endpoints must never be exercised." }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/compliance/organizations/users/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/manage-claude/compliance-org-data", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-compliance.json" }, { "provider": "anthropic", "api_family": "messages", "method": "POST", "path": "/v1/messages", "name": "Create a Message", "description": "Generate the next assistant message from a list of user/assistant turns (stateless multi-turn). Optional SSE streaming with stream=true.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key: (or Authorization: Bearer ) + anthropic-version: 2023-06-01 + content-type: application/json", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-messages.json", "size_limit": "32 MB" }, "response": { "content_type": "application/json", "object": "Message", "object_ref": "generated/fragments/objects/anthropic-messages-objects.json#Message" }, "streaming": { "supported": true, "param": "stream: true", "content_type": "text/event-stream", "events_ref": "generated/fragments/streaming-events/anthropic-messages.json", "observed_sequence_2026_09_18": [ "message_start", "content_block_start", "ping", "content_block_delta*", "content_block_stop", "message_delta", "message_stop" ] }, "pagination": null, "idempotency": "none (no idempotency key header documented)", "sdk": { "python": "client.messages.create(**params) / client.messages.stream(**params) / client.messages.parse(**params); client.beta.messages.create(betas=[...])", "node": "client.messages.create(params) / client.messages.stream(params) / client.beta.messages.create(params)", "cli": "ant messages create --model … --max-tokens … --message '{role: user, content: \"…\"}' [--stream --format jsonl]" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "46-call probe on claude-haiku-4-5-20251001: minimal, stream, system+sampling, stop_sequences, max_tokens=1, metadata, prefill, service_tier, tool_use, thinking stream, max_tokens=0; est. total $0.0023 (tmp-live/anthropic-core/)" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/messages", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/build-with-claude/streaming", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/overview", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-core.json" }, { "provider": "anthropic", "api_family": "messages", "method": "POST", "path": "/v1/messages (beta surface)", "name": "Create a Message (beta parameters)", "description": "Same endpoint with anthropic-beta header(s); unlocks context_management, compaction, mcp_servers, speed, diagnostics, fallbacks, fallback_credit_token, output_format (legacy), thinking.block_binding, thinking.display=updates, output_config.task_budget. SDKs expose it as client.beta.messages.", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key: (or Authorization: Bearer ) + anthropic-version: 2023-06-01 + content-type: application/json", "beta_header": "feature-specific (see anthropic-beta list in the models/beta fragment)", "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-messages.json (records with beta_header)" }, "response": { "content_type": "application/json", "object": "BetaMessage (adds context_management, diagnostics, input_transformations, usage.iterations/speed/fallback_credit, stop_reason compaction, blocks mcp_tool_use/mcp_tool_result/compaction/fallback/advisor_tool_result)" }, "streaming": { "supported": true, "events_ref": "generated/fragments/streaming-events/anthropic-messages.json" }, "pagination": null, "idempotency": "none", "sdk": { "python": "client.beta.messages.create(betas=[...]) / .stream / .parse / .tool_runner", "node": "client.beta.messages.create({betas}) / .stream / .toolRunner" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "context-management-2025-06-27 accepted on Haiku 4.5 → context_management.applied_edits []; fast-mode speed=fast → 400 on Haiku" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/messages", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta-headers", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-core.json" }, { "provider": "anthropic", "api_family": "messages", "method": "POST", "path": "/v1/messages/count_tokens", "name": "Count tokens in a Message", "description": "Estimate input tokens of a Messages request (messages, system, tools, thinking, output_config, base64 images/PDFs) without sampling. Free; separate RPM limit (Start 5,000 / Build 10,000 / Scale 20,000 documented).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key: (or Authorization: Bearer ) + anthropic-version: 2023-06-01 + content-type: application/json", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-count-tokens.json", "size_limit": "32 MB" }, "response": { "content_type": "application/json", "object": "MessageTokensCount", "shape": { "input_tokens": "integer" } }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none", "sdk": { "python": "client.messages.count_tokens(**params); client.beta.messages.count_tokens", "node": "client.messages.countTokens(params); client.beta.messages.countTokens" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "8 calls: simple 11, +system 17, +tool 561, +1x1 PNG 16, +text document 562, +thinking(enabled 1024) 40, +output_config.format 151; server tool → 400" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/messages/count_tokens", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/build-with-claude/token-counting", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-core.json" }, { "provider": "anthropic", "api_family": "models", "method": "GET", "path": "/v1/models", "name": "List Models", "description": "Paginated list of available models (ModelInfo: id, display_name, created_at, max_input_tokens, max_tokens, capabilities{…}).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key: (or Authorization: Bearer ) + anthropic-version: 2023-06-01 + content-type: application/json", "beta_header": null, "request": { "content_type": null, "query": { "limit": "1..1000 (default 20)", "after_id": "cursor", "before_id": "cursor" } }, "response": { "content_type": "application/json", "shape": { "data": "ModelInfo[]", "has_more": "boolean", "first_id": "string|null", "last_id": "string|null" } }, "streaming": { "supported": false }, "pagination": { "style": "cursor", "params": [ "after_id", "before_id", "limit" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET", "sdk": { "python": "client.models.list(**params) -> SyncPage[ModelInfo] (auto-paginating)", "node": "client.models.list(params) -> ModelInfosPage (for await)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "GET /v1/models?limit=3 → 3 ids, has_more true" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/models/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-core.json" }, { "provider": "anthropic", "api_family": "models", "method": "GET", "path": "/v1/models/{model_id}", "name": "Get a Model", "description": "Retrieve one model by id or alias; aliases resolve to the snapshot (live: claude-haiku-4-5 → id claude-haiku-4-5-20251001).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key: (or Authorization: Bearer ) + anthropic-version: 2023-06-01 + content-type: application/json", "beta_header": null, "request": { "content_type": null, "path_params": { "model_id": "string" } }, "response": { "content_type": "application/json", "object": "ModelInfo" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "GET", "sdk": { "python": "client.models.retrieve(model_id)", "node": "client.models.retrieve(modelID)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "GET /v1/models/claude-haiku-4-5 → 200, capabilities: thinking.enabled true / adaptive false, effort unsupported, structured_outputs true" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/models/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-core.json" }, { "provider": "anthropic", "api_family": "completions", "method": "POST", "path": "/v1/complete", "name": "Create a Text Completion (LEGACY)", "description": "Legacy Text Completions API (prompt string with \\n\\nHuman:/\\n\\nAssistant: turns). Still documented as [Legacy] but the live API now rejects every request with 400 'The /v1/complete endpoint has been deprecated. Please use the /v1/messages endpoint instead.' Migrate to /v1/messages.", "status": [ "DOCUMENTED", "LEGACY", "DEPRECATED", "FAILED_VERIFICATION" ], "auth": "x-api-key: (or Authorization: Bearer ) + anthropic-version: 2023-06-01 + content-type: application/json", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-complete-legacy.json" }, "response": { "content_type": "application/json", "object": "Completion", "shape": { "type": "completion", "id": "compl_…", "completion": "string", "model": "string", "stop_reason": "stop_sequence|max_tokens|null" } }, "streaming": { "supported": true, "note": "documented SSE `completion` events; not observable live" }, "pagination": null, "idempotency": "none", "sdk": { "python": "removed in anthropic>=1.0 (no client.completions in 1.7.0)", "node": "client.completions.create(params) still present in @anthropic-ai/sdk 0.126.0" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 400, "request_note": "claude-2.1 and claude-haiku-4-5-20251001 both → 400 invalid_request_error 'endpoint has been deprecated'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/completions", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/completions/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-core.json" }, { "provider": "anthropic", "api_family": "files", "method": "POST", "path": "/v1/files", "name": "Upload File", "description": "Upload a file (multipart/form-data: file, expires_in_seconds). Returns FileMetadata with downloadable:false and expires_at. GA since 2026-08-19 (files-api-2025-04-14 header optional, returns legacy shape). Free; ~500 req/min.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key + anthropic-version", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "file, expires_in_seconds" }, "response": { "200": "FileMetadata", "400": "invalid file type / filename / storage limit / expires_in_seconds range", "413": "file too large (>500 MB)" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "n/a", "sdk": { "python": "client.files.upload(file=...)", "node": "client.files.upload({file})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "files_01/09/12/17 -> 200" }, "notes": null, "sources": [ { "url": "https://platform.claude.com/docs/en/api/files", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/build-with-claude/files", "retrieved_at": "2026-09-18" } ], "last_verified": "2026-09-18", "_fragment": "generated/fragments/endpoints/anthropic-files.json" }, { "provider": "anthropic", "api_family": "files", "method": "GET", "path": "/v1/files", "name": "List Files", "description": "List workspace files newest first. Query: limit (20, max 1000), page cursor, ids[] (<=100). Response {data, next_page}. Legacy header adds has_more/first_id/last_id and before_id/after_id cursors.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key + anthropic-version", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "200": "{data: FileMetadata[], next_page: string|null}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "param": "page", "cursor_field": "next_page", "legacy": "before_id/after_id + has_more with files-api-2025-04-14" }, "idempotency": "n/a", "sdk": { "python": "client.files.list(limit=…) (auto-pagination)", "node": "client.files.list()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "files_02 {data:[…], next_page:null}; files_03 legacy shape; files_04 ids[] filter" }, "notes": null, "sources": [ { "url": "https://platform.claude.com/docs/en/api/files", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/build-with-claude/files", "retrieved_at": "2026-09-18" } ], "last_verified": "2026-09-18", "_fragment": "generated/fragments/endpoints/anthropic-files.json" }, { "provider": "anthropic", "api_family": "files", "method": "GET", "path": "/v1/files/{file_id}", "name": "Get File Metadata", "description": "Retrieve FileMetadata. After deletion -> 404 'File `…` not found.' Expired files stay readable (metadata) up to 30 days.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key + anthropic-version", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "200": "FileMetadata", "404": "not found" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "n/a", "sdk": { "python": "client.files.retrieve_metadata(file_id)", "node": "client.files.retrieveMetadata(fileId)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "files_05 -> 200; files_16 after delete -> 404" }, "notes": null, "sources": [ { "url": "https://platform.claude.com/docs/en/api/files", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/build-with-claude/files", "retrieved_at": "2026-09-18" } ], "last_verified": "2026-09-18", "_fragment": "generated/fragments/endpoints/anthropic-files.json" }, { "provider": "anthropic", "api_family": "files", "method": "GET", "path": "/v1/files/{file_id}/content", "name": "Download File", "description": "Download file bytes. Only files created by skills / code execution (downloadable:true). Uploaded files -> 400 'File `…` is not downloadable. Only files generated by a tool (for example, the code execution tool) can be downloaded.' Expired -> 404. Generated media carries C2PA credentials.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key + anthropic-version", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "200": "binary", "400": "not downloadable", "404": "expired/not found" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "n/a", "sdk": { "python": "client.files.download(file_id)", "node": "client.files.download(fileId)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 400, "request_note": "files_06 on an uploaded file -> 400 (documented behaviour)" }, "notes": null, "sources": [ { "url": "https://platform.claude.com/docs/en/api/files", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/build-with-claude/files", "retrieved_at": "2026-09-18" } ], "last_verified": "2026-09-18", "_fragment": "generated/fragments/endpoints/anthropic-files.json" }, { "provider": "anthropic", "api_family": "files", "method": "DELETE", "path": "/v1/files/{file_id}", "name": "Delete File", "description": "Delete a file. Returns {id, type:'file_deleted'}. Irreversible; may persist briefly in in-flight Messages calls.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key + anthropic-version", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "200": "DeletedFile {id, type:'file_deleted'}", "404": "not found" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "n/a", "sdk": { "python": "client.files.delete(file_id)", "node": "client.files.delete(fileId)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "files_15_delete_* -> 200" }, "notes": null, "sources": [ { "url": "https://platform.claude.com/docs/en/api/files", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/build-with-claude/files", "retrieved_at": "2026-09-18" } ], "last_verified": "2026-09-18", "_fragment": "generated/fragments/endpoints/anthropic-files.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/agents", "name": "List Agents", "description": "List Agents", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "created_at[gte]", "created_at[lte]", "include_archived", "limit", "page" ] }, "response": { "type": "array of BetaManagedAgentsAgent", "content_type": "application/json", "example": { "data": [ { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.agents.list()" ], "node": [ "client.beta.agents.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; limit=1 -> {data: []}; without beta header -> 400 'unknown field \"limit\"'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/agents/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/agents", "name": "Create Agent", "description": "Create Agent", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/agents", "path_params": [], "query_params": [] }, "response": { "type": "BetaManagedAgentsAgent object", "content_type": "application/json", "example": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.agents.create()" ], "node": [ "client.beta.agents.create()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; haiku agent with system prompt -> version 1; model normalised to {id, speed}" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/agents/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/agents/{agent_id}", "name": "Get Agent", "description": "Get Agent", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "agent_id" ], "query_params": [ "version" ] }, "response": { "type": "BetaManagedAgentsAgent object", "content_type": "application/json", "example": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.agents.retrieve()" ], "node": [ "client.beta.agents.retrieve()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/agents/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/agents/{agent_id}", "name": "Update Agent", "description": "Update Agent", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/agents/{agent_id}", "path_params": [ "agent_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsAgent object", "content_type": "application/json", "example": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.agents.update()" ], "node": [ "client.beta.agents.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/agents/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/agents/{agent_id}/archive", "name": "Archive Agent", "description": "Archive Agent", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "agent_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsAgent object", "content_type": "application/json", "example": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.agents.archive()" ], "node": [ "client.beta.agents.archive()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; archived_at set" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/agents/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/agents/{agent_id}/versions", "name": "List Agent Versions", "description": "List Agent Versions", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "agent_id" ], "query_params": [ "limit", "page" ] }, "response": { "type": "array of BetaManagedAgentsAgent", "content_type": "application/json", "example": { "data": [ { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.agents.versions.list()" ], "node": [ "client.beta.agents.versions.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; {data:[version 1]}" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/agents/versions/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/agents/versions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/deployment_runs", "name": "List Deployment Runs", "description": "List Deployment Runs", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "created_at[gt]", "created_at[gte]", "created_at[lt]", "created_at[lte]", "deployment_id", "has_error", "limit", "page", "trigger_type" ] }, "response": { "type": "array of BetaManagedAgentsDeploymentRun", "content_type": "application/json", "example": { "data": [ { "id": "id", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 }, "created_at": "2019-12-27T18:11:19.117Z", "deployment_id": "deployment_id", "error": { "message": "message", "type": "environment_archived_error" }, "session_id": "session_id", "trigger_context": { "scheduled_at": "2019-12-27T18:11:19.117Z", "type": "schedule" }, "type": "deployment_run" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.deployment_runs.list()" ], "node": [ "client.beta.deploymentRuns.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; {data: []}" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/deployment_runs/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/deployment_runs/{deployment_run_id}", "name": "Get Deployment Run", "description": "Get Deployment Run", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "deployment_run_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsDeploymentRun object", "content_type": "application/json", "example": { "id": "id", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 }, "created_at": "2019-12-27T18:11:19.117Z", "deployment_id": "deployment_id", "error": { "message": "message", "type": "environment_archived_error" }, "session_id": "session_id", "trigger_context": { "scheduled_at": "2019-12-27T18:11:19.117Z", "type": "schedule" }, "type": "deployment_run" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.deployment_runs.retrieve()" ], "node": [ "client.beta.deploymentRuns.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/deployment_runs/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/deployments", "name": "List Deployments", "description": "List Deployments", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "agent_id", "created_at[gte]", "created_at[lte]", "include_archived", "limit", "page", "status" ] }, "response": { "type": "array of BetaManagedAgentsDeployment", "content_type": "application/json", "example": { "data": [ { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.deployments.list()" ], "node": [ "client.beta.deployments.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; {data: []}" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/deployments/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/deployments", "name": "Create Deployment", "description": "Create Deployment", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/deployments", "path_params": [], "query_params": [] }, "response": { "type": "BetaManagedAgentsDeployment object", "content_type": "application/json", "example": { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.deployments.create()" ], "node": [ "client.beta.deployments.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/deployments/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/deployments/{deployment_id}", "name": "Get Deployment", "description": "Get Deployment", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "deployment_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsDeployment object", "content_type": "application/json", "example": { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.deployments.retrieve()" ], "node": [ "client.beta.deployments.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/deployments/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/deployments/{deployment_id}", "name": "Update Deployment", "description": "Update Deployment", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/deployments/{deployment_id}", "path_params": [ "deployment_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsDeployment object", "content_type": "application/json", "example": { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.deployments.update()" ], "node": [ "client.beta.deployments.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/deployments/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/deployments/{deployment_id}/archive", "name": "Archive Deployment", "description": "Archive Deployment", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "deployment_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsDeployment object", "content_type": "application/json", "example": { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.deployments.archive()" ], "node": [ "client.beta.deployments.archive()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/deployments/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/deployments/{deployment_id}/pause", "name": "Pause Deployment", "description": "Pause Deployment", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "deployment_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsDeployment object", "content_type": "application/json", "example": { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.deployments.pause()" ], "node": [ "client.beta.deployments.pause()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/deployments/pause", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/deployments/{deployment_id}/run", "name": "Run Deployment Now", "description": "Run Deployment Now", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "deployment_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsDeploymentRun object", "content_type": "application/json", "example": { "id": "id", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 }, "created_at": "2019-12-27T18:11:19.117Z", "deployment_id": "deployment_id", "error": { "message": "message", "type": "environment_archived_error" }, "session_id": "session_id", "trigger_context": { "scheduled_at": "2019-12-27T18:11:19.117Z", "type": "schedule" }, "type": "deployment_run" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.deployments.run()" ], "node": [ "client.beta.deployments.run()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/deployments/run", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/deployments/{deployment_id}/unpause", "name": "Unpause Deployment", "description": "Unpause Deployment", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "deployment_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsDeployment object", "content_type": "application/json", "example": { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.deployments.unpause()" ], "node": [ "client.beta.deployments.unpause()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/deployments/unpause", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/dreams", "name": "List Dreams", "description": "List Dreams", "status": [ "DOCUMENTED", "BETA", "FAILED_VERIFICATION" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "dreaming-2026-04-21", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "created_at[gt]", "created_at[lt]", "include_archived", "limit", "page", "statuses" ] }, "response": { "type": "array of BetaDream", "content_type": "application/json", "example": { "data": [ { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "ended_at": "2019-12-27T18:11:19.117Z", "error": { "message": "message", "type": "type" }, "inputs": [ { "memory_store_id": "x", "type": "memory_store" } ], "instructions": "instructions", "model": { "id": "x", "speed": "standard" }, "output_behavior": { "type": "create_new" }, "outputs": [ { "memory_store_id": "memory_store_id", "type": "memory_store" } ], "session_id": "session_id", "status": "pending", "type": "dream", "usage": { "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.dreams.list()" ], "node": [ "client.beta.dreams.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "beta dreaming-2026-04-21; 404 not_found_error 'not found' — endpoint not enabled for this account (gated preview)" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/dreams/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/dreams", "name": "Create a Dream", "description": "Create a Dream", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "dreaming-2026-04-21", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/dreams", "path_params": [], "query_params": [] }, "response": { "type": "BetaDream object", "content_type": "application/json", "example": { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "ended_at": "2019-12-27T18:11:19.117Z", "error": { "message": "message", "type": "type" }, "inputs": [ { "memory_store_id": "x", "type": "memory_store" } ], "instructions": "instructions", "model": { "id": "x", "speed": "standard" }, "output_behavior": { "type": "create_new" }, "outputs": [ { "memory_store_id": "memory_store_id", "type": "memory_store" } ], "session_id": "session_id", "status": "pending", "type": "dream", "usage": { "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.dreams.create()" ], "node": [ "client.beta.dreams.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/dreams/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/dreams/{dream_id}", "name": "Get a Dream", "description": "Get a Dream", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "dreaming-2026-04-21", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "dream_id" ], "query_params": [] }, "response": { "type": "BetaDream object", "content_type": "application/json", "example": { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "ended_at": "2019-12-27T18:11:19.117Z", "error": { "message": "message", "type": "type" }, "inputs": [ { "memory_store_id": "x", "type": "memory_store" } ], "instructions": "instructions", "model": { "id": "x", "speed": "standard" }, "output_behavior": { "type": "create_new" }, "outputs": [ { "memory_store_id": "memory_store_id", "type": "memory_store" } ], "session_id": "session_id", "status": "pending", "type": "dream", "usage": { "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.dreams.retrieve()" ], "node": [ "client.beta.dreams.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/dreams/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/dreams/{dream_id}/archive", "name": "Archive a Dream", "description": "Archive a Dream", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "dreaming-2026-04-21", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "dream_id" ], "query_params": [] }, "response": { "type": "BetaDream object", "content_type": "application/json", "example": { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "ended_at": "2019-12-27T18:11:19.117Z", "error": { "message": "message", "type": "type" }, "inputs": [ { "memory_store_id": "x", "type": "memory_store" } ], "instructions": "instructions", "model": { "id": "x", "speed": "standard" }, "output_behavior": { "type": "create_new" }, "outputs": [ { "memory_store_id": "memory_store_id", "type": "memory_store" } ], "session_id": "session_id", "status": "pending", "type": "dream", "usage": { "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.dreams.archive()" ], "node": [ "client.beta.dreams.archive()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/dreams/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/dreams/{dream_id}/cancel", "name": "Cancel a Dream", "description": "Cancel a Dream", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "dreaming-2026-04-21", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "dream_id" ], "query_params": [] }, "response": { "type": "BetaDream object", "content_type": "application/json", "example": { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "ended_at": "2019-12-27T18:11:19.117Z", "error": { "message": "message", "type": "type" }, "inputs": [ { "memory_store_id": "x", "type": "memory_store" } ], "instructions": "instructions", "model": { "id": "x", "speed": "standard" }, "output_behavior": { "type": "create_new" }, "outputs": [ { "memory_store_id": "memory_store_id", "type": "memory_store" } ], "session_id": "session_id", "status": "pending", "type": "dream", "usage": { "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (observed: repeated cancel -> 200 same state)", "sdk": { "python": [ "client.beta.dreams.cancel()" ], "node": [ "client.beta.dreams.cancel()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/dreams/cancel", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/environments", "name": "List Environments", "description": "List environments with pagination support.", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "include_archived", "limit", "page" ] }, "response": { "type": "array of BetaEnvironment", "content_type": "application/json", "example": { "data": [ { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.environments.list()" ], "node": [ "client.beta.environments.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/environments/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/environments", "name": "Create Environment", "description": "Create a new environment with the specified configuration.", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/environments", "path_params": [], "query_params": [] }, "response": { "type": "BetaEnvironment object", "content_type": "application/json", "example": { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.environments.create()" ], "node": [ "client.beta.environments.create()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; config {type: cloud} -> defaults networking unrestricted, empty packages, scope organization" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/environments/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "DELETE", "path": "/v1/environments/{environment_id}", "name": "Delete Environment", "description": "Delete an environment by ID. Returns a confirmation of the deletion.", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "environment_id" ], "query_params": [] }, "response": { "type": "BetaEnvironmentDeleteResponse object", "content_type": "application/json", "example": { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "type": "environment_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.environments.delete()" ], "node": [ "client.beta.environments.delete()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; {type: environment_deleted} after archive" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/environments/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/environments/{environment_id}", "name": "Get Environment", "description": "Retrieve a specific environment by ID.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "environment_id" ], "query_params": [] }, "response": { "type": "BetaEnvironment object", "content_type": "application/json", "example": { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.environments.retrieve()" ], "node": [ "client.beta.environments.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/environments/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/environments/{environment_id}", "name": "Update Environment", "description": "Update an existing environment's configuration.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/environments/{environment_id}", "path_params": [ "environment_id" ], "query_params": [] }, "response": { "type": "BetaEnvironment object", "content_type": "application/json", "example": { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.environments.update()" ], "node": [ "client.beta.environments.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/environments/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/environments/{environment_id}/archive", "name": "Archive Environment", "description": "Archive an environment by ID. Archived environments cannot be used to create new sessions.", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "environment_id" ], "query_params": [] }, "response": { "type": "BetaEnvironment object", "content_type": "application/json", "example": { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.environments.archive()" ], "node": [ "client.beta.environments.archive()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/environments/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/environments/{environment_id}/work", "name": "List Work Items", "description": "Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. List work items in an environment.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "environment_id" ], "query_params": [ "limit", "page" ] }, "response": { "type": "BetaSelfHostedWorkListResponse object", "content_type": "application/json", "example": { "data": [ { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.environments.work.list()" ], "node": [ "client.beta.environments.work.list()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/environments/{environment_id}/work/poll", "name": "Poll for Work", "description": "Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Long poll for work items in the queue.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "Anthropic-Worker-ID" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "environment_id" ], "query_params": [ "block_ms", "reclaim_older_than_ms" ] }, "response": { "type": "BetaSelfHostedWork object", "content_type": "application/json", "example": { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.environments.work.poll()" ], "node": [ "client.beta.environments.work.poll()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/poll", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/environments/{environment_id}/work/stats", "name": "Get Queue Statistics", "description": "Get statistics about the work queue for an environment.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "environment_id" ], "query_params": [] }, "response": { "type": "BetaSelfHostedWorkQueueStats object", "content_type": "application/json", "example": { "depth": 0, "oldest_queued_at": "oldest_queued_at", "pending": 0, "type": "work_queue_stats", "workers_polling": 0 } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.environments.work.stats()" ], "node": [ "client.beta.environments.work.stats()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/stats", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/environments/{environment_id}/work/{work_id}", "name": "Get Work Item", "description": "Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Retrieve detailed information about a specific work item.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "environment_id", "work_id" ], "query_params": [] }, "response": { "type": "BetaSelfHostedWork object", "content_type": "application/json", "example": { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.environments.work.retrieve()" ], "node": [ "client.beta.environments.work.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/environments/work", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/environments/{environment_id}/work/{work_id}", "name": "Update Work Item", "description": "Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Update work item metadata with merge semantics.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/environments/{environment_id}/work/{work_id}", "path_params": [ "environment_id", "work_id" ], "query_params": [] }, "response": { "type": "BetaSelfHostedWork object", "content_type": "application/json", "example": { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.environments.work.update()" ], "node": [ "client.beta.environments.work.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/environments/{environment_id}/work/{work_id}/ack", "name": "Acknowledge Work", "description": "Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' and removing it from the queue.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "environment_id", "work_id" ], "query_params": [] }, "response": { "type": "BetaSelfHostedWork object", "content_type": "application/json", "example": { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.environments.work.ack()" ], "node": [ "client.beta.environments.work.ack()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/ack", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/environments/{environment_id}/work/{work_id}/heartbeat", "name": "Record Heartbeat", "description": "Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Record a heartbeat for a work item to maintain the lease.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "environment_id", "work_id" ], "query_params": [ "desired_ttl_seconds", "expected_last_heartbeat" ] }, "response": { "type": "BetaSelfHostedWorkHeartbeatResponse object", "content_type": "application/json", "example": { "last_heartbeat": "last_heartbeat", "lease_extended": true, "state": "queued", "ttl_seconds": 0, "type": "work_heartbeat" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.environments.work.heartbeat()" ], "node": [ "client.beta.environments.work.heartbeat()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/heartbeat", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/environments/{environment_id}/work/{work_id}/stop", "name": "Stop Work", "description": "Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Stop a work item, initiating graceful or forced shutdown.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/environments/{environment_id}/work/{work_id}/stop", "path_params": [ "environment_id", "work_id" ], "query_params": [] }, "response": { "type": "BetaSelfHostedWork object", "content_type": "application/json", "example": { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.environments.work.stop()" ], "node": [ "client.beta.environments.work.stop()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/environments/work/stop", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/memory_stores", "name": "List memory stores", "description": "List memory stores", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "agent-memory-2026-07-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "created_at[gte]", "created_at[lte]", "include_archived", "limit", "page" ] }, "response": { "type": "array of BetaManagedAgentsMemoryStore", "content_type": "application/json", "example": { "data": [ { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.memory_stores.list()" ], "node": [ "client.beta.memoryStores.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta agent-memory-2026-07-22; {data: []}" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/memory_stores", "name": "Create a memory store", "description": "Create a memory store", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "agent-memory-2026-07-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/memory_stores", "path_params": [], "query_params": [] }, "response": { "type": "BetaManagedAgentsMemoryStore object", "content_type": "application/json", "example": { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.memory_stores.create()" ], "node": [ "client.beta.memoryStores.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "DELETE", "path": "/v1/memory_stores/{memory_store_id}", "name": "Delete a memory store", "description": "Delete a memory store", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "agent-memory-2026-07-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "memory_store_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsDeletedMemoryStore object", "content_type": "application/json", "example": { "id": "id", "type": "memory_store_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.memory_stores.delete()" ], "node": [ "client.beta.memoryStores.delete()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/memory_stores/{memory_store_id}", "name": "Retrieve a memory store", "description": "Retrieve a memory store", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "agent-memory-2026-07-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "memory_store_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsMemoryStore object", "content_type": "application/json", "example": { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.memory_stores.retrieve()" ], "node": [ "client.beta.memoryStores.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/memory_stores/{memory_store_id}", "name": "Update a memory store", "description": "Update a memory store", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "agent-memory-2026-07-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/memory_stores/{memory_store_id}", "path_params": [ "memory_store_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsMemoryStore object", "content_type": "application/json", "example": { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.memory_stores.update()" ], "node": [ "client.beta.memoryStores.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/memory_stores/{memory_store_id}/archive", "name": "Archive a memory store", "description": "Archive a memory store", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "agent-memory-2026-07-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "memory_store_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsMemoryStore object", "content_type": "application/json", "example": { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.memory_stores.archive()" ], "node": [ "client.beta.memoryStores.archive()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/memory_stores/{memory_store_id}/memories", "name": "List memories", "description": "List memories", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "agent-memory-2026-07-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "memory_store_id" ], "query_params": [ "depth", "limit", "page", "path_prefix", "view" ] }, "response": { "type": "array of BetaManagedAgentsMemoryListItem", "content_type": "application/json", "example": { "data": [ { "id": "id", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_at": "2019-12-27T18:11:19.117Z", "memory_store_id": "memory_store_id", "memory_version_id": "memory_version_id", "path": "path", "type": "memory", "updated_at": "2019-12-27T18:11:19.117Z", "content": "content" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.memory_stores.memories.list()" ], "node": [ "client.beta.memoryStores.memories.list()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/memory_stores/{memory_store_id}/memories", "name": "Create a memory", "description": "Create a memory", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "agent-memory-2026-07-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/memory_stores/{memory_store_id}/memories", "path_params": [ "memory_store_id" ], "query_params": [ "view" ] }, "response": { "type": "BetaManagedAgentsMemory object", "content_type": "application/json", "example": { "id": "id", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_at": "2019-12-27T18:11:19.117Z", "memory_store_id": "memory_store_id", "memory_version_id": "memory_version_id", "path": "path", "type": "memory", "updated_at": "2019-12-27T18:11:19.117Z", "content": "content" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.memory_stores.memories.create()" ], "node": [ "client.beta.memoryStores.memories.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/create", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "DELETE", "path": "/v1/memory_stores/{memory_store_id}/memories/{memory_id}", "name": "Delete a memory", "description": "Delete a memory", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "agent-memory-2026-07-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "memory_store_id", "memory_id" ], "query_params": [ "expected_content_sha256" ] }, "response": { "type": "BetaManagedAgentsDeletedMemory object", "content_type": "application/json", "example": { "id": "id", "type": "memory_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.memory_stores.memories.delete()" ], "node": [ "client.beta.memoryStores.memories.delete()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/memory_stores/{memory_store_id}/memories/{memory_id}", "name": "Retrieve a memory", "description": "Retrieve a memory", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "agent-memory-2026-07-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "memory_store_id", "memory_id" ], "query_params": [ "view" ] }, "response": { "type": "BetaManagedAgentsMemory object", "content_type": "application/json", "example": { "id": "id", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_at": "2019-12-27T18:11:19.117Z", "memory_store_id": "memory_store_id", "memory_version_id": "memory_version_id", "path": "path", "type": "memory", "updated_at": "2019-12-27T18:11:19.117Z", "content": "content" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.memory_stores.memories.retrieve()" ], "node": [ "client.beta.memoryStores.memories.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/memory_stores/{memory_store_id}/memories/{memory_id}", "name": "Update a memory", "description": "Update a memory", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "agent-memory-2026-07-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/memory_stores/{memory_store_id}/memories/{memory_id}", "path_params": [ "memory_store_id", "memory_id" ], "query_params": [ "view" ] }, "response": { "type": "BetaManagedAgentsMemory object", "content_type": "application/json", "example": { "id": "id", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_at": "2019-12-27T18:11:19.117Z", "memory_store_id": "memory_store_id", "memory_version_id": "memory_version_id", "path": "path", "type": "memory", "updated_at": "2019-12-27T18:11:19.117Z", "content": "content" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.memory_stores.memories.update()" ], "node": [ "client.beta.memoryStores.memories.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/memory_stores/{memory_store_id}/memory_versions", "name": "List memory versions", "description": "List memory versions", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "agent-memory-2026-07-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "memory_store_id" ], "query_params": [ "api_key_id", "created_at[gte]", "created_at[lte]", "limit", "memory_id", "operation", "page", "service_account_id", "session_id", "view" ] }, "response": { "type": "array of BetaManagedAgentsMemoryVersion", "content_type": "application/json", "example": { "data": [ { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "memory_id": "memory_id", "memory_store_id": "memory_store_id", "operation": "created", "type": "memory_version", "content": "content", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_by": { "session_id": "x", "type": "session_actor" }, "path": "path", "redacted_at": "2019-12-27T18:11:19.117Z", "redacted_by": { "session_id": "x", "type": "session_actor" } } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.memory_stores.memory_versions.list()" ], "node": [ "client.beta.memoryStores.memoryVersions.list()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}", "name": "Retrieve a memory version", "description": "Retrieve a memory version", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "agent-memory-2026-07-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "memory_store_id", "memory_version_id" ], "query_params": [ "view" ] }, "response": { "type": "BetaManagedAgentsMemoryVersion object", "content_type": "application/json", "example": { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "memory_id": "memory_id", "memory_store_id": "memory_store_id", "operation": "created", "type": "memory_version", "content": "content", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_by": { "session_id": "x", "type": "session_actor" }, "path": "path", "redacted_at": "2019-12-27T18:11:19.117Z", "redacted_by": { "session_id": "x", "type": "session_actor" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.memory_stores.memory_versions.retrieve()" ], "node": [ "client.beta.memoryStores.memoryVersions.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact", "name": "Redact a memory version", "description": "Redact a memory version", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "agent-memory-2026-07-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "memory_store_id", "memory_version_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsMemoryVersion object", "content_type": "application/json", "example": { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "memory_id": "memory_id", "memory_store_id": "memory_store_id", "operation": "created", "type": "memory_version", "content": "content", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_by": { "session_id": "x", "type": "session_actor" }, "path": "path", "redacted_at": "2019-12-27T18:11:19.117Z", "redacted_by": { "session_id": "x", "type": "session_actor" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.memory_stores.memory_versions.redact()" ], "node": [ "client.beta.memoryStores.memoryVersions.redact()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/redact", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/sessions", "name": "List Sessions", "description": "List Sessions", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "agent_id", "agent_version", "created_at[gt]", "created_at[gte]", "created_at[lt]", "created_at[lte]", "deployment_id", "include_archived", "limit", "memory_store_id", "order", "page", "statuses" ] }, "response": { "type": "array of BetaManagedAgentsSession", "content_type": "application/json", "example": { "data": [ { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" }, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "deployment_id": "deployment_id" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=", "prev_page": "page_MjAyNS0wNS0xM1QwMDowMDowMFo=" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.sessions.list()" ], "node": [ "client.beta.sessions.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/sessions", "name": "Create Session", "description": "Create Session", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/sessions", "path_params": [], "query_params": [] }, "response": { "type": "BetaManagedAgentsSession object", "content_type": "application/json", "example": { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" }, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "deployment_id": "deployment_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.sessions.create()" ], "node": [ "client.beta.sessions.create()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; budget.max_list_cost.amount must be a string of cents ('20'); numeric 5 -> 400 'invalid value for string field amount'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "DELETE", "path": "/v1/sessions/{session_id}", "name": "Delete Session", "description": "Delete Session", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsDeletedSession object", "content_type": "application/json", "example": { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "type": "session_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.sessions.delete()" ], "node": [ "client.beta.sessions.delete()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; {type: session_deleted}" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/sessions/{session_id}", "name": "Get Session", "description": "Get Session", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsSession object", "content_type": "application/json", "example": { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" }, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "deployment_id": "deployment_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.sessions.retrieve()" ], "node": [ "client.beta.sessions.retrieve()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; status idle; usage/stats populated after turn" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/sessions/{session_id}", "name": "Update Session", "description": "Update Session", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/sessions/{session_id}", "path_params": [ "session_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsSession object", "content_type": "application/json", "example": { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" }, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "deployment_id": "deployment_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.sessions.update()" ], "node": [ "client.beta.sessions.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/sessions/{session_id}/archive", "name": "Archive Session", "description": "Archive Session", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsSession object", "content_type": "application/json", "example": { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" }, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "deployment_id": "deployment_id" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.sessions.archive()" ], "node": [ "client.beta.sessions.archive()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/sessions/{session_id}/events", "name": "List Events", "description": "List Events", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [ "created_at[gt]", "created_at[gte]", "created_at[lt]", "created_at[lte]", "limit", "order", "page", "types" ] }, "response": { "type": "array of BetaManagedAgentsSessionEvent", "content_type": "application/json", "example": { "data": [ { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" }, { "id": "sevt_011CZkZHPq1jCdq5lbRTjiVnz", "content": [ { "text": "Let me look up order #1234 for you.", "type": "text" } ], "processed_at": "2026-03-15T10:00:00Z", "type": "agent.message" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.sessions.events.list()" ], "node": [ "client.beta.sessions.events.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; 10 events listed after one turn" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/events/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/events", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/sessions/{session_id}/events", "name": "Send Events", "description": "Send Events", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/sessions/{session_id}/events", "path_params": [ "session_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsSendSessionEvents object", "content_type": "application/json", "example": { "data": [ { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } ] } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.sessions.events.send()" ], "node": [ "client.beta.sessions.events.send()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; user.message -> {data:[event with id sevt_]}" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/events/send", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/sessions/{session_id}/events/stream", "name": "Stream Events", "description": "Stream Events", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [ "event_deltas" ] }, "response": { "type": "BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 34 more", "content_type": "text/event-stream", "example": { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } }, "streaming": { "supported": true, "events_ref": "generated/fragments/streaming-events/anthropic-managed-agents.json" }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.sessions.events.stream()" ], "node": [ "client.beta.sessions.events.stream()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; SSE 'event: message'; sequence session.status_running, session.thread_status_running, user.message, span.model_request_start, agent.thinking, event_start, event_delta(content_delta), agent.message, span.model_request_end, session.thread_status_idle, session.usage, session.status_idle (~1s, 548 in / 33 out tokens)" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/events/stream", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/sessions/{session_id}/resources", "name": "List Session Resources", "description": "List Session Resources", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [ "limit", "page" ] }, "response": { "type": "array of BetaManagedAgentsSessionResource", "content_type": "application/json", "example": { "data": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.sessions.resources.list()" ], "node": [ "client.beta.sessions.resources.list()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/resources/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/sessions/{session_id}/resources", "name": "Add Session Resource", "description": "Add Session Resource", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/sessions/{session_id}/resources", "path_params": [ "session_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsFileResource object", "content_type": "application/json", "example": { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.sessions.resources.add()" ], "node": [ "client.beta.sessions.resources.add()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/resources/add", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/resources", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "DELETE", "path": "/v1/sessions/{session_id}/resources/{resource_id}", "name": "Delete Session Resource", "description": "Delete Session Resource", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "resource_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsDeleteSessionResource object", "content_type": "application/json", "example": { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "type": "session_resource_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.sessions.resources.delete()" ], "node": [ "client.beta.sessions.resources.delete()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/resources/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/sessions/{session_id}/resources/{resource_id}", "name": "Get Session Resource", "description": "Get Session Resource", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "resource_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsGitHubRepositoryResource object", "content_type": "application/json", "example": { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.sessions.resources.retrieve()" ], "node": [ "client.beta.sessions.resources.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/resources/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/sessions/{session_id}/resources/{resource_id}", "name": "Update Session Resource", "description": "Update Session Resource", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/sessions/{session_id}/resources/{resource_id}", "path_params": [ "session_id", "resource_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsGitHubRepositoryResource object", "content_type": "application/json", "example": { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.sessions.resources.update()" ], "node": [ "client.beta.sessions.resources.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/resources/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/sessions/{session_id}/threads", "name": "List Session Threads", "description": "List Session Threads", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [ "limit", "page" ] }, "response": { "type": "array of BetaManagedAgentsSessionThread", "content_type": "application/json", "example": { "data": [ { "id": "sthr_011CZkZVWa6oIjw0rgXZpnBt", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "parent_thread_id": null, "session_id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "stats": { "active_seconds": 0, "duration_seconds": 0, "startup_seconds": 0 }, "status": "idle", "type": "session_thread", "updated_at": "2026-03-15T10:00:00Z", "usage": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } } } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.sessions.threads.list()" ], "node": [ "client.beta.sessions.threads.list()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/sessions/{session_id}/threads/{thread_id}", "name": "Get Session Thread", "description": "Get Session Thread", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "thread_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsSessionThread object", "content_type": "application/json", "example": { "id": "sthr_011CZkZVWa6oIjw0rgXZpnBt", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "parent_thread_id": null, "session_id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "stats": { "active_seconds": 0, "duration_seconds": 0, "startup_seconds": 0 }, "status": "idle", "type": "session_thread", "updated_at": "2026-03-15T10:00:00Z", "usage": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.sessions.threads.retrieve()" ], "node": [ "client.beta.sessions.threads.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/sessions/{session_id}/threads/{thread_id}/archive", "name": "Archive Session Thread", "description": "Archive Session Thread", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "thread_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsSessionThread object", "content_type": "application/json", "example": { "id": "sthr_011CZkZVWa6oIjw0rgXZpnBt", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "parent_thread_id": null, "session_id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "stats": { "active_seconds": 0, "duration_seconds": 0, "startup_seconds": 0 }, "status": "idle", "type": "session_thread", "updated_at": "2026-03-15T10:00:00Z", "usage": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.sessions.threads.archive()" ], "node": [ "client.beta.sessions.threads.archive()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/sessions/{session_id}/threads/{thread_id}/events", "name": "List Session Thread Events", "description": "List Session Thread Events", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "thread_id" ], "query_params": [ "limit", "page" ] }, "response": { "type": "array of BetaManagedAgentsSessionEvent", "content_type": "application/json", "example": { "data": [ { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.sessions.threads.events.list()" ], "node": [ "client.beta.sessions.threads.events.list()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/sessions/{session_id}/threads/{thread_id}/stream", "name": "Stream Session Thread Events", "description": "Stream Session Thread Events", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "thread_id" ], "query_params": [ "event_deltas" ] }, "response": { "type": "BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 34 more", "content_type": "text/event-stream", "example": { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } }, "streaming": { "supported": true, "events_ref": "generated/fragments/streaming-events/anthropic-managed-agents.json" }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.sessions.threads.events.stream()" ], "node": [ "client.beta.sessions.threads.events.stream()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events/stream", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/tunnels", "name": "List Tunnels", "description": "The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Lists tunnels. Results are ordered by creation time, newest first; archived tunnels are excluded unless include_archived is set.", "status": [ "DOCUMENTED", "BETA", "ACCOUNT_RESTRICTED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "mcp-tunnels-2026-06-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "include_archived", "limit", "page" ] }, "response": { "type": "array of BetaTunnel", "content_type": "application/json", "example": { "data": [ { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "display_name": "display_name", "domain": "domain", "type": "tunnel" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.tunnels.list()" ], "node": [ "client.beta.tunnels.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "beta mcp-tunnels-2026-06-22; 401 authentication_error 'Authentication failed' with a regular key (needs workspace:manage_tunnels / OAuth?)" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/tunnels", "name": "Create Tunnel", "description": "The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; it is not idempotent. The new tunnel rejects MCP traffic until at least one CA certificate is added.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "mcp-tunnels-2026-06-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/tunnels", "path_params": [], "query_params": [] }, "response": { "type": "BetaTunnel object", "content_type": "application/json", "example": { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "display_name": "display_name", "domain": "domain", "type": "tunnel" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.tunnels.create()" ], "node": [ "client.beta.tunnels.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/tunnels/{tunnel_id}", "name": "Get Tunnel", "description": "The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Fetches a tunnel by ID.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "mcp-tunnels-2026-06-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "tunnel_id" ], "query_params": [] }, "response": { "type": "BetaTunnel object", "content_type": "application/json", "example": { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "display_name": "display_name", "domain": "domain", "type": "tunnel" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.tunnels.retrieve()" ], "node": [ "client.beta.tunnels.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/tunnels/{tunnel_id}/archive", "name": "Archive Tunnel", "description": "The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Archives a tunnel. Archival is irreversible: every non-archived certificate on the tunnel is archived in the same operation, the hostname is retired and never re-allocated, and the tunnel token is invalidated. Retrying against an already-archived tunnel returns the existing record unchanged.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "mcp-tunnels-2026-06-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "tunnel_id" ], "query_params": [] }, "response": { "type": "BetaTunnel object", "content_type": "application/json", "example": { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "display_name": "display_name", "domain": "domain", "type": "tunnel" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.tunnels.archive()" ], "node": [ "client.beta.tunnels.archive()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/tunnels/{tunnel_id}/certificates", "name": "List Tunnel Certificates", "description": "The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "mcp-tunnels-2026-06-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "tunnel_id" ], "query_params": [ "include_archived", "limit", "page" ] }, "response": { "type": "array of BetaTunnelCertificate", "content_type": "application/json", "example": { "data": [ { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "expires_at": "2019-12-27T18:11:19.117Z", "fingerprint": "fingerprint", "tunnel_id": "tunnel_id", "type": "tunnel_certificate" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.tunnels.certificates.list()" ], "node": [ "client.beta.tunnels.certificates.list()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/tunnels/{tunnel_id}/certificates", "name": "Create Tunnel Certificate", "description": "The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's server certificate against this CA when it terminates the inner TLS session. A tunnel holds at most two non-archived certificates.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "mcp-tunnels-2026-06-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/tunnels/{tunnel_id}/certificates", "path_params": [ "tunnel_id" ], "query_params": [] }, "response": { "type": "BetaTunnelCertificate object", "content_type": "application/json", "example": { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "expires_at": "2019-12-27T18:11:19.117Z", "fingerprint": "fingerprint", "tunnel_id": "tunnel_id", "type": "tunnel_certificate" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.tunnels.certificates.create()" ], "node": [ "client.beta.tunnels.certificates.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/create", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/tunnels/{tunnel_id}/certificates/{certificate_id}", "name": "Get Tunnel Certificate", "description": "The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Fetches a tunnel certificate by ID.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "mcp-tunnels-2026-06-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "tunnel_id", "certificate_id" ], "query_params": [] }, "response": { "type": "BetaTunnelCertificate object", "content_type": "application/json", "example": { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "expires_at": "2019-12-27T18:11:19.117Z", "fingerprint": "fingerprint", "tunnel_id": "tunnel_id", "type": "tunnel_certificate" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.tunnels.certificates.retrieve()" ], "node": [ "client.beta.tunnels.certificates.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive", "name": "Archive Tunnel Certificate", "description": "The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "mcp-tunnels-2026-06-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "tunnel_id", "certificate_id" ], "query_params": [] }, "response": { "type": "BetaTunnelCertificate object", "content_type": "application/json", "example": { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "expires_at": "2019-12-27T18:11:19.117Z", "fingerprint": "fingerprint", "tunnel_id": "tunnel_id", "type": "tunnel_certificate" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.tunnels.certificates.archive()" ], "node": [ "client.beta.tunnels.certificates.archive()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/tunnels/{tunnel_id}/reveal_token", "name": "Reveal Tunnel Token", "description": "The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Reveals a tunnel's connector token. The value is fetched live on each call; Anthropic does not store it. Repeated calls return the same value until the token is rotated. Exposed as POST so the token does not appear in intermediary access logs.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "mcp-tunnels-2026-06-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "tunnel_id" ], "query_params": [] }, "response": { "type": "BetaTunnelToken object", "content_type": "application/json", "example": { "id": "id", "tunnel_token": "tunnel_token", "type": "tunnel_token" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.tunnels.reveal_token()" ], "node": [ "client.beta.tunnels.revealToken()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/reveal_token", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/tunnels/{tunnel_id}/rotate_token", "name": "Rotate Tunnel Token", "description": "The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Rotates a tunnel's connector token. Rotation invalidates the current token for new connections and returns a fresh value; established connections are not severed. A connector restarted after rotation must use the new value.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "mcp-tunnels-2026-06-22", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/tunnels/{tunnel_id}/rotate_token", "path_params": [ "tunnel_id" ], "query_params": [] }, "response": { "type": "BetaTunnelToken object", "content_type": "application/json", "example": { "id": "id", "tunnel_token": "tunnel_token", "type": "tunnel_token" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.tunnels.rotate_token()" ], "node": [ "client.beta.tunnels.rotateToken()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/tunnels/rotate_token", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/user_profiles", "name": "List User Profiles", "description": "List User Profiles", "status": [ "DOCUMENTED", "BETA", "FAILED_VERIFICATION" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "user-profiles-2026-08-18", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "limit", "order", "order_by", "page" ] }, "response": { "type": "array of BetaUserProfile", "content_type": "application/json", "example": { "data": [ { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "country", "email_hash": "email_hash", "entity_type": "individual", "name_hash": "name_hash", "onboarded_at": "2019-12-27T18:11:19.117Z", "reference_id": "reference_id" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z", "name": "Example User" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.user_profiles.list()" ], "node": [ "client.beta.userProfiles.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "beta user-profiles-2026-08-18; 404 not_found_error 'not found' — endpoint not enabled for this account (gated preview)" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/user_profiles/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/user_profiles", "name": "Create User Profile", "description": "Create User Profile", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "user-profiles-2026-08-18", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/user_profiles", "path_params": [], "query_params": [] }, "response": { "type": "BetaUserProfile object", "content_type": "application/json", "example": { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "country", "email_hash": "email_hash", "entity_type": "individual", "name_hash": "name_hash", "onboarded_at": "2019-12-27T18:11:19.117Z", "reference_id": "reference_id" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z", "name": "Example User" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.user_profiles.create()" ], "node": [ "client.beta.userProfiles.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/user_profiles/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/user_profiles/{user_profile_id}", "name": "Get User Profile", "description": "Get User Profile", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "user-profiles-2026-08-18", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "user_profile_id" ], "query_params": [] }, "response": { "type": "BetaUserProfile object", "content_type": "application/json", "example": { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "country", "email_hash": "email_hash", "entity_type": "individual", "name_hash": "name_hash", "onboarded_at": "2019-12-27T18:11:19.117Z", "reference_id": "reference_id" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z", "name": "Example User" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.user_profiles.retrieve()" ], "node": [ "client.beta.userProfiles.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/user_profiles/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/user_profiles/{user_profile_id}", "name": "Update User Profile", "description": "Update User Profile", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "user-profiles-2026-08-18", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/user_profiles/{user_profile_id}", "path_params": [ "user_profile_id" ], "query_params": [] }, "response": { "type": "BetaUserProfile object", "content_type": "application/json", "example": { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "country", "email_hash": "email_hash", "entity_type": "individual", "name_hash": "name_hash", "onboarded_at": "2019-12-27T18:11:19.117Z", "reference_id": "reference_id" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z", "name": "Example User" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.user_profiles.update()" ], "node": [ "client.beta.userProfiles.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/user_profiles/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/user_profiles/{user_profile_id}/enrollment_url", "name": "Create Enrollment URL", "description": "Create Enrollment URL", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "user-profiles-2026-08-18", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "user_profile_id" ], "query_params": [] }, "response": { "type": "BetaUserProfileEnrollmentURL object", "content_type": "application/json", "example": { "expires_at": "2026-03-15T10:15:00Z", "type": "enrollment_url", "url": "https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.user_profiles.create_enrollment_url()" ], "node": [ "client.beta.userProfiles.createEnrollmentURL()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/user_profiles/create_enrollment_url", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/vaults", "name": "List Vaults", "description": "List Vaults", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "include_archived", "limit", "page" ] }, "response": { "type": "array of BetaManagedAgentsVault", "content_type": "application/json", "example": { "data": [ { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.vaults.list()" ], "node": [ "client.beta.vaults.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "beta managed-agents-2026-04-01; {data: []}" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/vaults/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/vaults", "name": "Create Vault", "description": "Create Vault", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/vaults", "path_params": [], "query_params": [] }, "response": { "type": "BetaManagedAgentsVault object", "content_type": "application/json", "example": { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.vaults.create()" ], "node": [ "client.beta.vaults.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/vaults/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "DELETE", "path": "/v1/vaults/{vault_id}", "name": "Delete Vault", "description": "Delete Vault", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "vault_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsDeletedVault object", "content_type": "application/json", "example": { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "type": "vault_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.vaults.delete()" ], "node": [ "client.beta.vaults.delete()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/vaults/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/vaults/{vault_id}", "name": "Get Vault", "description": "Get Vault", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "vault_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsVault object", "content_type": "application/json", "example": { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.vaults.retrieve()" ], "node": [ "client.beta.vaults.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/vaults/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/vaults/{vault_id}", "name": "Update Vault", "description": "Update Vault", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/vaults/{vault_id}", "path_params": [ "vault_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsVault object", "content_type": "application/json", "example": { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.vaults.update()" ], "node": [ "client.beta.vaults.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/vaults/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/vaults/{vault_id}/archive", "name": "Archive Vault", "description": "Archive Vault", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "vault_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsVault object", "content_type": "application/json", "example": { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.vaults.archive()" ], "node": [ "client.beta.vaults.archive()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/vaults/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/vaults/{vault_id}/credentials", "name": "List Credentials", "description": "List Credentials", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "vault_id" ], "query_params": [ "include_archived", "limit", "page" ] }, "response": { "type": "array of BetaManagedAgentsCredential", "content_type": "application/json", "example": { "data": [ { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.vaults.credentials.list()" ], "node": [ "client.beta.vaults.credentials.list()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/vaults/{vault_id}/credentials", "name": "Create Credential", "description": "Create Credential", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/vaults/{vault_id}/credentials", "path_params": [ "vault_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsCredential object", "content_type": "application/json", "example": { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.vaults.credentials.create()" ], "node": [ "client.beta.vaults.credentials.create()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "DELETE", "path": "/v1/vaults/{vault_id}/credentials/{credential_id}", "name": "Delete Credential", "description": "Delete Credential", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "vault_id", "credential_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsDeletedCredential object", "content_type": "application/json", "example": { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "type": "vault_credential_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.vaults.credentials.delete()" ], "node": [ "client.beta.vaults.credentials.delete()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "GET", "path": "/v1/vaults/{vault_id}/credentials/{credential_id}", "name": "Get Credential", "description": "Get Credential", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "vault_id", "credential_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsCredential object", "content_type": "application/json", "example": { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.vaults.credentials.retrieve()" ], "node": [ "client.beta.vaults.credentials.retrieve()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/vaults/{vault_id}/credentials/{credential_id}", "name": "Update Credential", "description": "Update Credential", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/anthropic-managed-agents.json#POST /v1/vaults/{vault_id}/credentials/{credential_id}", "path_params": [ "vault_id", "credential_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsCredential object", "content_type": "application/json", "example": { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.vaults.credentials.update()" ], "node": [ "client.beta.vaults.credentials.update()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/vaults/{vault_id}/credentials/{credential_id}/archive", "name": "Archive Credential", "description": "Archive Credential", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "vault_id", "credential_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsCredential object", "content_type": "application/json", "example": { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.vaults.credentials.archive()" ], "node": [ "client.beta.vaults.credentials.archive()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/archive", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "managed-agents", "method": "POST", "path": "/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate", "name": "Validate Credential", "description": "Validate Credential", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-api-key (regular API key) or OAuth bearer; optional anthropic-workspace-id header", "beta_header": "managed-agents-2026-04-01", "beta_header_note": null, "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "vault_id", "credential_id" ], "query_params": [] }, "response": { "type": "BetaManagedAgentsCredentialValidation object", "content_type": "application/json", "example": { "credential_id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "has_refresh_token": true, "mcp_probe": { "http_response": { "body": "body", "body_truncated": true, "content_type": "content_type", "status_code": 0 }, "method": "method" }, "refresh": { "http_response": { "body": "body", "body_truncated": true, "content_type": "content_type", "status_code": 0 }, "status": "succeeded" }, "status": "valid", "type": "vault_credential_validation", "validated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.beta.vaults.credentials.mcp_oauth_validate()" ], "node": [ "client.beta.vaults.credentials.mcpOAuthValidate()" ] }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/mcp_oauth_validate", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-managed-agents.json" }, { "provider": "anthropic", "api_family": "skills", "method": "GET", "path": "/v1/skills", "name": "List Skills", "description": "List Skills", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key); optional anthropic-workspace-id header", "beta_header": null, "beta_header_note": "skills-2025-10-02 is optional/legacy: the Skills API is GA; sending the header switches to legacy response shapes", "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "limit", "page", "source" ] }, "response": { "type": "array of BetaSkill", "content_type": "application/json", "example": { "data": [ { "id": "skill_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "display_name", "latest_version_id": "latest_version_id", "source": { "type": "custom" }, "type": "skill", "updated_at": "2024-10-30T23:58:27.427722Z" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.skills.list()", "client.beta.skills.list()" ], "node": [ "client.skills.list()", "client.beta.skills.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "source=anthropic -> 4 skills (xlsx, pptx, pdf, docx); source=custom; with skills-2025-10-02 header returns legacy shape (display_title, latest_version, source string)" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/skills/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/skills/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-skills.json" }, { "provider": "anthropic", "api_family": "skills", "method": "POST", "path": "/v1/skills", "name": "Create Skill", "description": "Create Skill", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key); optional anthropic-workspace-id header", "beta_header": null, "beta_header_note": "skills-2025-10-02 is optional/legacy: the Skills API is GA; sending the header switches to legacy response shapes", "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "multipart/form-data", "body_ref": "generated/fragments/parameters/anthropic-skills.json#POST /v1/skills", "path_params": [], "query_params": [] }, "response": { "type": "BetaSkill object", "content_type": "application/json", "example": { "id": "skill_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "display_name", "latest_version_id": "latest_version_id", "source": { "type": "custom" }, "type": "skill", "updated_at": "2024-10-30T23:58:27.427722Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.skills.create()", "client.beta.skills.create()" ], "node": [ "client.skills.create()", "client.beta.skills.create()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "multipart files[]=atlas-demo/SKILL.md + display_name; 400 when SKILL.md lacks YAML frontmatter" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/skills/create", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/skills/create", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-skills.json" }, { "provider": "anthropic", "api_family": "skills", "method": "DELETE", "path": "/v1/skills/{skill_id}", "name": "Delete Skill", "description": "Delete Skill", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key); optional anthropic-workspace-id header", "beta_header": null, "beta_header_note": "skills-2025-10-02 is optional/legacy: the Skills API is GA; sending the header switches to legacy response shapes", "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "skill_id" ], "query_params": [] }, "response": { "type": "BetaDeletedSkill object", "content_type": "application/json", "example": { "id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "skill_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.skills.delete()", "client.beta.skills.delete()" ], "node": [ "client.skills.delete()", "client.beta.skills.delete()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "{type: skill_deleted}; deletes remaining versions; 404 on second call" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/skills/delete", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/skills/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-skills.json" }, { "provider": "anthropic", "api_family": "skills", "method": "GET", "path": "/v1/skills/{skill_id}", "name": "Get Skill", "description": "Get Skill", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key); optional anthropic-workspace-id header", "beta_header": null, "beta_header_note": "skills-2025-10-02 is optional/legacy: the Skills API is GA; sending the header switches to legacy response shapes", "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "skill_id" ], "query_params": [] }, "response": { "type": "BetaSkill object", "content_type": "application/json", "example": { "id": "skill_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "display_name", "latest_version_id": "latest_version_id", "source": { "type": "custom" }, "type": "skill", "updated_at": "2024-10-30T23:58:27.427722Z" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.skills.retrieve()", "client.beta.skills.retrieve()" ], "node": [ "client.skills.retrieve()", "client.beta.skills.retrieve()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "custom skill retrieved; 404 not_found_error after delete" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/skills/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/skills/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-skills.json" }, { "provider": "anthropic", "api_family": "skills", "method": "GET", "path": "/v1/skills/{skill_id}/versions", "name": "List Skill Versions", "description": "List Skill Versions", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key); optional anthropic-workspace-id header", "beta_header": null, "beta_header_note": "skills-2025-10-02 is optional/legacy: the Skills API is GA; sending the header switches to legacy response shapes", "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "skill_id" ], "query_params": [ "limit", "page" ] }, "response": { "type": "array of BetaSkillVersion", "content_type": "application/json", "example": { "data": [ { "id": "id", "created_at": "2024-10-30T23:58:27.427722Z", "description": "description", "name": "name", "skill_id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "skill_version" } ], "next_page": "next_page" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_cursor", "params": [ "limit", "page" ], "response_fields": [ "data", "next_page" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.skills.versions.list()", "client.beta.skills.versions.list()" ], "node": [ "client.skills.versions.list()", "client.beta.skills.versions.list()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "{data, next_page}; newest first" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/skills/versions/list", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/skills/versions/list", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-skills.json" }, { "provider": "anthropic", "api_family": "skills", "method": "POST", "path": "/v1/skills/{skill_id}/versions", "name": "Create Skill Version", "description": "Create Skill Version", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key); optional anthropic-workspace-id header", "beta_header": null, "beta_header_note": "skills-2025-10-02 is optional/legacy: the Skills API is GA; sending the header switches to legacy response shapes", "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": "multipart/form-data", "body_ref": "generated/fragments/parameters/anthropic-skills.json#POST /v1/skills/{skill_id}/versions", "path_params": [ "skill_id" ], "query_params": [] }, "response": { "type": "BetaSkillVersion object", "content_type": "application/json", "example": { "id": "id", "created_at": "2024-10-30T23:58:27.427722Z", "description": "description", "name": "name", "skill_id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "skill_version" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent (no Idempotency-Key header documented)", "sdk": { "python": [ "client.skills.versions.create()", "client.beta.skills.versions.create()" ], "node": [ "client.skills.versions.create()", "client.beta.skills.versions.create()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "multipart with 2 files (SKILL.md + notes.md) -> new skill_version" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/skills/versions/create", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/beta/skills/versions", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/skills/versions/create", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/skills/versions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-skills.json" }, { "provider": "anthropic", "api_family": "skills", "method": "DELETE", "path": "/v1/skills/{skill_id}/versions/{version}", "name": "Delete Skill Version", "description": "Delete Skill Version", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key); optional anthropic-workspace-id header", "beta_header": null, "beta_header_note": "skills-2025-10-02 is optional/legacy: the Skills API is GA; sending the header switches to legacy response shapes", "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "skill_id", "version" ], "query_params": [] }, "response": { "type": "BetaDeletedSkillVersion object", "content_type": "application/json", "example": { "id": "id", "type": "skill_version_deleted" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.skills.versions.delete()", "client.beta.skills.versions.delete()" ], "node": [ "client.skills.versions.delete()", "client.beta.skills.versions.delete()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "200 {type: skill_version_deleted} for a non-last version; 400 'cannot delete a Skill's only version' for the last one" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/skills/versions/delete", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/skills/versions/delete", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-skills.json" }, { "provider": "anthropic", "api_family": "skills", "method": "GET", "path": "/v1/skills/{skill_id}/versions/{version}", "name": "Get Skill Version", "description": "Get Skill Version", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key); optional anthropic-workspace-id header", "beta_header": null, "beta_header_note": "skills-2025-10-02 is optional/legacy: the Skills API is GA; sending the header switches to legacy response shapes", "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "skill_id", "version" ], "query_params": [] }, "response": { "type": "BetaSkillVersion object", "content_type": "application/json", "example": { "id": "id", "created_at": "2024-10-30T23:58:27.427722Z", "description": "description", "name": "name", "skill_id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "skill_version" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.skills.versions.retrieve()", "client.beta.skills.versions.retrieve()" ], "node": [ "client.skills.versions.retrieve()", "client.beta.skills.versions.retrieve()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "by skver_ id and by 'latest'" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/skills/versions/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://platform.claude.com/docs/en/api/skills/versions/retrieve", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-skills.json" }, { "provider": "anthropic", "api_family": "skills", "method": "GET", "path": "/v1/skills/{skill_id}/versions/{version}/content", "name": "Download Skill Version Content", "description": "Download a skill version's content as a zip archive.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-api-key (regular API key); optional anthropic-workspace-id header", "beta_header": null, "beta_header_note": "skills-2025-10-02 is optional/legacy: the Skills API is GA; sending the header switches to legacy response shapes", "headers": [ "anthropic-beta", "anthropic-workspace-id" ], "request": { "content_type": null, "body_ref": null, "path_params": [ "skill_id", "version" ], "query_params": [] }, "response": { "type": null, "content_type": "application/zip", "example": null }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent (safe)", "sdk": { "python": [ "client.beta.skills.versions.download()" ], "node": [ "client.beta.skills.versions.download()" ] }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "binary zip archive (PK header) containing /SKILL.md" }, "sources": [ { "url": "https://platform.claude.com/docs/en/api/beta/skills/versions/download", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/anthropic-skills.json" }, { "provider": "gemini", "api_family": "transcription", "method": "POST", "path": "/v1beta/models/{model}:generateContent", "name": "Transcribe audio (gemini-3.5-transcribe)", "description": "Speech-to-text with the dedicated gemini-3.5-transcribe model (supportedGenerationMethods [generateContent, countTokens]; no batch). Input audio part (inlineData or fileData), optional generationConfig.audioTranscriptionConfig {languageCodes, customVocabulary, mode VERBATIM|SMART, diarization, wordTimestamp}. Text output; word annotations with speaker/offsets when diarization/timestamps are on. Interactions API form: generation_config.transcription_config. Live streaming variant gemini-3.5-transcribe-live uses the Live API (bidiGenerateContent) — see the Live agent.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "GenerateContentRequest (generationConfig.audioTranscriptionConfig)" }, "response": { "content_type": "application/json", "object": "GenerateContentResponse (parts[].audioTranscription — LIVE_DISCOVERED)", "live_note": "speech: {\"candidates\": [{\"content\": {\"parts\": [{\"audioTranscription\": {\"text\": \"Okay.\"}}], \"role\": \"model\"}, \"finishReason\": \"STOP\", \"index\": 0}], \"usageMetadata\": {\"promptTokenCount\": 21, \"totalTokenCount\": 21, \"promptTokensDetails\": [{\"modality\": \"AUDIO\", \"tokenCoun | diarization+timestamps: {\"parts\": [{\"text\": \"Okay.\", \"audioTranscription\": {\"text\": \"Okay.\", \"speakerLabel\": \"spk:0\", \"words\": [{\"word\": \"Okay.\", \"startOffset\": \"0.200s\", \"endOffset\": \"0.500s\"}]}}], \"role\": \"model\"}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.models.generate_content(model='gemini-3.5-transcribe', contents=[types.Part.from_bytes(data=audio, mime_type='audio/wav')])", "node": "ai.models.generateContent({model:'gemini-3.5-transcribe', contents:[{inlineData:{mimeType:'audio/wav', data}}]})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "0.8 s TTS 'OK' WAV as inlineData -> 200 parts[0].audioTranscription.text 'Okay.' (21 audio tokens, free tier); 0.5 s silence -> 200 with empty content {}; diarization+wordTimestamp -> 200 with speakerLabel + words[]" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/transcribe", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/models/gemini-3.5-transcribe", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/generate-content", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/pricing", "retrieved_at": "2026-09-18" } ], "notes": "generateContent returns the transcript in a non-documented part field `audioTranscription` {text, speakerLabel, words[{word,startOffset,endOffset}]} (plus a plain `text` when diarization is on) instead of the Interactions `word_info` annotations. Silence -> candidates[0].content = {} (no parts). SMART+diarization -> HTTP 400 INVALID_ARGUMENT: Transcription mode SMART is incompatible with diarization. | gemini-3.5-transcribe-live via generateContent -> HTTP 400 INVALID_ARGUMENT: models/gemini-3.5-transcribe-live only supports real-time bidirectional streaming via WebSocket (bidiGenerateContent). Please use the Gemini Live API (bidiGenerateContent via WebSocket) instead of gen. Pricing (paid): $2/M audio input tokens (~$0.003/min), $12/M text output (~$0.002/min); blended ~$0.005/min; free tier free of charge. Limits: 1 h per request (30 min with diarization/timestamps), 8 speakers, 1,000 vocabulary terms.", "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "generate-content", "method": "POST", "path": "/v1beta/models/{model}:streamGenerateContent", "name": "Stream generate content", "description": "Same request as generateContent; the response is a sequence of partial GenerateContentResponse chunks. Framing: `?alt=sse` → `text/event-stream` with one `data: {json}` line per chunk (no `event:` names, no [DONE] sentinel); without `alt=sse` → `application/json` body that is a pretty-printed JSON array of the same chunks (streamed as `[{ ... }\\n,\\n{ ... }\\n]`).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/gemini-generate-content.json", "query": { "alt": "sse (recommended) | omitted → JSON array" } }, "response": { "content_type": "text/event-stream (alt=sse) | application/json; charset=UTF-8 (array)", "object": "GenerateContentResponse[] (partial)", "object_ref": "generated/fragments/objects/gemini-core-objects.json#GenerateContentResponse" }, "streaming": { "supported": true, "param": "URL suffix :streamGenerateContent (+ ?alt=sse)", "content_type": "text/event-stream | application/json", "events_ref": "generated/fragments/streaming-events/gemini-core.json", "observed_sequence_2026_09_18": [ "chunk{text} ×N (usageMetadata present in every chunk, finishReason absent)", "final chunk{text:'' + thoughtSignature, finishReason: STOP, usageMetadata final}" ], "observed_framing": { "sse": "`data: \\r\\n\\r\\n` per chunk; 4 chunks / 8 lines for a 26-token answer", "json_array": "lines `[{` … `}` `,` `{` … `}` `]` (pretty-printed, 122 lines for the same 4 chunks)" } }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": { "python": "client.models.generate_content_stream(...)", "node": "ai.models.generateContentStream(...)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "b_stream_sse + b_stream_json_array on gemini-3.5-flash-lite: both 200, identical 4-chunk sequence, final usage promptTokenCount 13 / candidatesTokenCount 26" }, "sources": [ { "url": "https://ai.google.dev/api/generate-content", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/generate-content/text-generation", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "tokens", "method": "POST", "path": "/v1beta/models/{model}:countTokens", "name": "Count tokens", "description": "Returns the model's token count for `contents` or for a whole `generateContentRequest` (which may include systemInstruction, tools, cachedContent, generationConfig). Free: no billing. Multimodal inputs (inlineData, fileData incl. YouTube URLs) are counted per modality.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/gemini-count-tokens.json" }, "response": { "content_type": "application/json", "object": "CountTokensResponse", "object_ref": "generated/fragments/objects/gemini-core-objects.json#CountTokensResponse" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": { "python": "client.models.count_tokens(model=, contents=) — CountTokensConfig(system_instruction=, tools=) raises ValueError in Developer API mode (SDK 2.24); use raw REST for the generateContentRequest wrapper", "node": "ai.models.countTokens({model, contents}) — same restriction in @google/genai 2.23" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "g_count_*: text 11 tokens; wrapper with systemInstruction+tools 51; 1×1 PNG 1089 IMAGE tokens (256 with mediaResolution LOW); YouTube URL → VIDEO 10650 + AUDIO 4777; PDF page 560 DOCUMENT tokens; empty body → 400 'CountTokens requires generate_content_request or contents to be set.'" }, "sources": [ { "url": "https://ai.google.dev/api/tokens", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/generate-content/tokens", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "embeddings", "method": "POST", "path": "/v1beta/models/{model}:embedContent", "name": "Embed content", "description": "Text (gemini-embedding-001) or multimodal (gemini-embedding-2: text, image, audio, video, PDF) embedding of one `content`. `outputDimensionality` truncates the 3072-d Matryoshka vector (128–3072). gemini-embedding-2 aggregates all parts of the content into ONE vector.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/gemini-embeddings.json" }, "response": { "content_type": "application/json", "object": "EmbedContentResponse", "object_ref": "generated/fragments/objects/gemini-core-objects.json#EmbedContentResponse" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": { "python": "client.models.embed_content(model=, contents=, config=types.EmbedContentConfig(task_type=, output_dimensionality=, title=))", "node": "ai.models.embedContent({model, contents, config})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "h_embed_001 (taskType SEMANTIC_SIMILARITY, outputDimensionality 64) → 64 floats, no usageMetadata; default → 3072 floats; gemini-embedding-2 outputDimensionality 64 → 64 floats + usageMetadata.promptTokenCount 8; text+PNG aggregate → 1 vector, usage TEXT 3 + IMAGE 258; outputDimensionality 4096 → 400" }, "sources": [ { "url": "https://ai.google.dev/api/embeddings", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/embeddings", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "embeddings", "method": "POST", "path": "/v1beta/models/{model}:batchEmbedContents", "name": "Batch embed contents (synchronous)", "description": "Embeds several `requests[]` (each an EmbedContentRequest that MUST repeat `model`) in one call; returns `embeddings[]` in order. Distinct from the asynchronous Batch API.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/gemini-embeddings.json" }, "response": { "content_type": "application/json", "object": "BatchEmbedContentsResponse", "object_ref": "generated/fragments/objects/gemini-core-objects.json#BatchEmbedContentsResponse" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": { "python": "client.models.embed_content(model=, contents=[...]) (SDK fans a list out to batchEmbedContents)", "node": "ai.models.embedContent({contents: [...]})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "h_batch_embed_001: 2 requests → embeddings_lens [64, 64]; request without per-item model → 400 '* BatchEmbedContentsRequest.requests[0].model: model is not specified'" }, "sources": [ { "url": "https://ai.google.dev/api/embeddings", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "batch", "method": "POST", "path": "/v1beta/models/{model}:asyncBatchEmbedContent", "name": "Create an embedding batch", "description": "Async batch of EmbedContent requests (embedding models expose asyncBatchEmbedContent; the synchronous batchEmbedContents is a different, immediate method). Same inline/file input model; output inlinedResponses of EmbedContentResponse or responsesFile.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "AsyncBatchEmbedContentRequest {batch: EmbedContentBatch}" }, "response": { "content_type": "application/json", "object": "Operation (metadata EmbedContentBatch)", "live_note": "{\"error\": {\"code\": 400, \"message\": \"Precondition check failed.\", \"status\": \"FAILED_PRECONDITION\"}}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.batches.create_embeddings(model='gemini-embedding-2', src=..., config=...)", "node": "ai.batches.createEmbeddings(...)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 400, "request_note": "HTTP 400 FAILED_PRECONDITION: Precondition check failed." }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/batch-api", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/batch-api", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "caching", "method": "POST", "path": "/v1beta/cachedContents", "name": "Create cached content (explicit context caching)", "description": "Pre-processes `contents` (+ optional systemInstruction, tools, toolConfig) for one `model` and stores them for `ttl`/`expireTime` (default 1 h). Minimum size is model-specific (live: min_total_token_count=1024 for gemini-3.5-flash-lite; docs table lists 4,096 for Gemini 3.x Flash/Pro and 2,048 for 2.5 — for implicit caching). Cached tokens are billed at the reduced cache rate + storage per token-hour.", "status": [ "DOCUMENTED", "BETA", "ACCOUNT_RESTRICTED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/gemini-cached-contents.json" }, "response": { "content_type": "application/json", "object": "CachedContent", "object_ref": "generated/fragments/objects/gemini-core-objects.json#CachedContent" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": { "python": "client.caches.create(model=, config=types.CreateCachedContentConfig(contents=, system_instruction=, ttl='300s', display_name=))", "node": "ai.caches.create({model, config})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": [ 429, 400 ], "request_note": "i_cache_create on gemini-3.5-flash-lite (5301 tokens, ttl 120s) → 429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash-lite: limit=0, requested=5301' (free tier: caching 'Not available' for Flash-Lite per pricing page); 6-token cache → 400 'Cached content is too small. total_token_count=6, min_total_token_count=1024'; missing model → 400 \"Model name must be in the format 'models/{model_name}'\". Pass 2 on gemini-3.5-flash: 429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301' (ttl 120s, displayName, systemInstruction, 5301-token contents) — explicit caching needs a billing-enabled project" }, "sources": [ { "url": "https://ai.google.dev/api/caching", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/generate-content/caching", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/pricing", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "caching", "method": "GET", "path": "/v1beta/cachedContents", "name": "List cached contents", "description": "Lists cache metadata (name, model, displayName, usageMetadata.totalTokenCount, createTime, updateTime, expireTime) — contents themselves are never readable back.", "status": [ "DOCUMENTED", "BETA", "ACCOUNT_RESTRICTED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json" }, "response": { "content_type": "application/json", "object": "ListCachedContentsResponse" }, "streaming": { "supported": false }, "pagination": { "style": "pageToken/nextPageToken", "pageSize_max": 1000 }, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": { "python": "client.caches.list()", "node": "ai.caches.list({config:{pageSize}})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "i_cache_list: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite)" }, "sources": [ { "url": "https://ai.google.dev/api/caching", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "caching", "method": "GET", "path": "/v1beta/cachedContents/{id}", "name": "Get cached content", "description": "Returns one CachedContent's metadata.", "status": [ "DOCUMENTED", "BETA", "ACCOUNT_RESTRICTED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json" }, "response": { "content_type": "application/json", "object": "CachedContent" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": { "python": "client.caches.get(name=)", "node": "ai.caches.get({name})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "i_cache_get: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite)" }, "sources": [ { "url": "https://ai.google.dev/api/caching", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "caching", "method": "PATCH", "path": "/v1beta/cachedContents/{id}", "name": "Update cached content (TTL / expireTime only)", "description": "Only the expiration (`ttl` or `expireTime`) can be changed; optional `updateMask` query. Any other field is rejected/ignored.", "status": [ "DOCUMENTED", "BETA", "ACCOUNT_RESTRICTED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/gemini-cached-contents.json", "query": { "updateMask": "FieldMask, e.g. ttl" } }, "response": { "content_type": "application/json", "object": "CachedContent" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": { "python": "client.caches.update(name=, config=types.UpdateCachedContentConfig(ttl=|expire_time=))", "node": "ai.caches.update({name, config})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "i_cache_patch_ttl: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite) | displayName patch: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite) | expireTime patch: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite)" }, "sources": [ { "url": "https://ai.google.dev/api/caching", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "caching", "method": "DELETE", "path": "/v1beta/cachedContents/{id}", "name": "Delete cached content", "description": "Deletes the cache immediately (stops storage billing). Returns {}.", "status": [ "DOCUMENTED", "BETA", "ACCOUNT_RESTRICTED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json" }, "response": { "content_type": "application/json", "object": "Empty {}" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": { "python": "client.caches.delete(name=)", "node": "ai.caches.delete({name})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "i_cache_delete: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite) | GET after delete: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite)" }, "sources": [ { "url": "https://ai.google.dev/api/caching", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "files", "method": "POST", "path": "/upload/v1beta/files", "name": "Upload a file (media.upload)", "description": "Creates a File from raw bytes. Three wire protocols (all verified): (1) resumable — POST JSON metadata with `X-Goog-Upload-Protocol: resumable`, `X-Goog-Upload-Command: start`, `X-Goog-Upload-Header-Content-Length`, `X-Goog-Upload-Header-Content-Type` → 200 empty body + `X-Goog-Upload-URL` (+ `X-Goog-Upload-Control-URL`, `X-Goog-Upload-Status: active`, `X-Goog-Upload-Chunk-Granularity: 8388608`); then POST the bytes to that URL with `X-Goog-Upload-Offset: 0` and `X-Goog-Upload-Command: upload, finalize` → `{file: File}` + `X-Goog-Upload-Status: final`; (2) `?uploadType=multipart` with a `multipart/related` body (JSON metadata part + media part); (3) `?uploadType=media` raw bytes with Content-Type. Max 2 GB/file, 20 GB/project, files expire after 48 h; the Files API is free.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json (resumable start) | multipart/related; boundary=… (multipart) | (media)", "body_ref": "generated/fragments/parameters/gemini-files.json", "size_limit": "2 GB per file (discovery mediaUpload.maxSize 2147483648)" }, "response": { "content_type": "application/json", "object": "CreateFileResponse {file: File}", "object_ref": "generated/fragments/objects/gemini-core-objects.json#File" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": { "python": "client.files.upload(file=path_or_io, config=types.UploadFileConfig(mime_type=, display_name=, name=))", "node": "ai.files.upload({file, config:{mimeType, displayName}})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "j_upload_start → 200 (empty body, X-Goog-Upload-URL); j_upload_finalize → 200 file state ACTIVE, sizeBytes 174, expirationTime = now+48h, source UPLOADED, sha256Hash (base64 of hex digest); j_upload_multipart_pdf → 200 ACTIVE (580-byte PDF); j_upload_simple_raw (uploadType=media) → 200 ACTIVE" }, "sources": [ { "url": "https://ai.google.dev/api/files", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/generate-content/files", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/generate-content/file-input-methods", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "discovery_media_upload": { "accept": [ "*/*" ], "maxSize": "2147483648", "protocols": { "simple": { "multipart": true, "path": "/upload/v1beta/files" }, "resumable": { "multipart": true, "path": "/resumable/upload/v1beta/files" } } }, "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "files", "method": "GET", "path": "/v1beta/files", "name": "List files", "description": "Lists the project's Files (uploaded + registered + generated). Also served under `/v1/files`.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json" }, "response": { "content_type": "application/json", "object": "ListFilesResponse {files[], nextPageToken}" }, "streaming": { "supported": false }, "pagination": { "style": "pageToken/nextPageToken", "pageSize": "query" }, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": { "python": "client.files.list()", "node": "ai.files.list({config:{pageSize}})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "j_files_list ?pageSize=3 → 200 {files:[1]}; /v1/files?pageSize=1 → 200" }, "sources": [ { "url": "https://ai.google.dev/api/files", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "files", "method": "GET", "path": "/v1beta/files/{id}", "name": "Get file metadata", "description": "Returns the File (poll `state` PROCESSING → ACTIVE for video/audio before use).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json" }, "response": { "content_type": "application/json", "object": "File" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": { "python": "client.files.get(name=)", "node": "ai.files.get({name})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": [ 200, 403 ], "request_note": "j_files_get → 200 ACTIVE; unknown or deleted id → 403 PERMISSION_DENIED 'You do not have permission to access the File or it may not exist.' (never 404)" }, "sources": [ { "url": "https://ai.google.dev/api/files", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "files", "method": "DELETE", "path": "/v1beta/files/{id}", "name": "Delete file", "description": "Deletes an uploaded/registered file (otherwise auto-deleted after 48 h). Returns {}.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json" }, "response": { "content_type": "application/json", "object": "Empty {}" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": { "python": "client.files.delete(name=)", "node": "ai.files.delete({name})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "j_files_delete → 200 {}; subsequent generateContent with the fileData → 403 PERMISSION_DENIED" }, "sources": [ { "url": "https://ai.google.dev/api/files", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "files", "method": "POST", "path": "/v1beta/files:register", "name": "Register Google Cloud Storage objects as Files", "description": "Registers `gs://bucket/object` URIs with the File service without copying them; returns a File per URI (`source: REGISTERED`, no expirationTime/state in the response). If one URI fails the whole request fails. Docs: registration gives access for up to 30 days; 2 GB/file, no storage cap.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "generated/fragments/parameters/gemini-files.json" }, "response": { "content_type": "application/json", "object": "RegisterFilesResponse {files: File[]}" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": { "python": "(no dedicated helper in google-genai 2.24; use client.files.register if present or raw request)", "node": "raw fetch" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "j_files_register with the public gs://cloud-samples-data/generative-ai/image/scones.jpg → 200 {files:[{name files/…, displayName , mimeType image/jpeg, sizeBytes 394671, uri, source REGISTERED}]} (deleted afterwards)" }, "sources": [ { "url": "https://ai.google.dev/api/files", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/generate-content/file-input-methods", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "files", "method": "GET", "path": "/v1beta/generatedFiles", "name": "List generated files", "description": "Lists files generated on behalf of the project (GeneratedFile: name generatedFiles/…, state GENERATING|GENERATED|FAILED, mimeType, error).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "ListGeneratedFilesResponse", "live_note": "{}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": "pageSize/pageToken -> nextPageToken", "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "GET /v1beta/generatedFiles?pageSize=10 -> 200 {}" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "files", "method": "GET", "path": "/v1beta/generatedFiles/{id}/operations/{operation}", "name": "Get generated-file operation", "description": "Polls a long-running operation attached to a generated file.", "status": [ "LIVE_DISCOVERED", "UNVERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json" }, "response": { "content_type": "application/json", "object": "Operation" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": {}, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "success", "http_status": null, "request_note": "discovery only; no generated files on this key" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "generate-content", "method": "POST", "path": "/v1beta/dynamic/{id}:generateContent", "name": "Generate content on a `dynamic/*` resource", "description": "Present in the discovery document (also :streamGenerateContent) with path pattern `^dynamic/[^/]+$` and the same GenerateContentRequest/Response, but absent from every doc page. Probed ids `default` and a model id → 404 'dynamic/ is not found for API version v1beta, or is not supported for generateContent'. Purpose unknown (possibly server-side model routing / dynamic model aliases); treat as internal.", "status": [ "LIVE_DISCOVERED", "UNVERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json" }, "response": { "content_type": "application/json" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": {}, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "l_dynamic_default, l_dynamic_lite → 404 NOT_FOUND" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "generate-content", "method": "POST", "path": "/v1beta/dynamic/{id}:streamGenerateContent", "name": "Stream generate content on a `dynamic/*` resource", "description": "Streaming twin of dynamic.generateContent (discovery only).", "status": [ "LIVE_DISCOVERED", "UNVERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json" }, "response": { "content_type": "application/json" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": {}, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "success", "http_status": null, "request_note": "discovery only" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "legacy-palm", "method": "POST", "path": "/v1beta/models/{model}:generateText", "name": "PaLM legacy: generateText", "description": "PaLM 2 text completion (`prompt.text`, candidateCount 1–8, temperature 0–1). Still in the discovery document; PaLM models are retired and current models do not implement it.", "status": [ "LEGACY", "DOCUMENTED", "FAILED_VERIFICATION" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json", "body": "GenerateTextRequest {prompt:{text}, safetySettings, stopSequences, temperature, candidateCount, maxOutputTokens, topP, topK}" }, "response": { "content_type": "application/json", "object": "GenerateTextResponse {candidates[], filters[], safetyFeedback[]}" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": {}, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "text-bison-001 and gemini-3.5-flash-lite → 404 NOT_FOUND 'Requested entity was not found.'" }, "sources": [ { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "legacy-palm", "method": "POST", "path": "/v1beta/models/{model}:generateMessage", "name": "PaLM legacy: generateMessage", "description": "PaLM 2 chat (`prompt.{context, examples[], messages[{author, content}]}`).", "status": [ "LEGACY", "DOCUMENTED", "FAILED_VERIFICATION" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json", "body": "GenerateMessageRequest {prompt: MessagePrompt, temperature, candidateCount, topP, topK}" }, "response": { "content_type": "application/json", "object": "GenerateMessageResponse" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": {}, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 501, "request_note": "chat-bison-001 → 501 UNIMPLEMENTED 'Operation is not implemented, or supported, or enabled.'" }, "sources": [ { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "legacy-palm", "method": "POST", "path": "/v1beta/models/{model}:embedText", "name": "PaLM legacy: embedText", "description": "PaLM 2 text embedding (`text`). Also `:batchEmbedText` (`texts[]` / `requests[]`).", "status": [ "LEGACY", "DOCUMENTED", "FAILED_VERIFICATION" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json", "body": "EmbedTextRequest {model, text}" }, "response": { "content_type": "application/json", "object": "EmbedTextResponse {embedding:{value[]}}" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": {}, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "embedding-gecko-001 and gemini-embedding-001 → 404 NOT_FOUND 'Requested entity was not found.'" }, "sources": [ { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "legacy-palm", "method": "POST", "path": "/v1beta/models/{model}:batchEmbedText", "name": "PaLM legacy: batchEmbedText", "description": "Batch twin of embedText (discovery only).", "status": [ "LEGACY", "DOCUMENTED", "UNVERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json" }, "response": { "content_type": "application/json" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": {}, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "success", "http_status": null, "request_note": "not probed (embedText already 404)" }, "sources": [ { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "legacy-palm", "method": "POST", "path": "/v1beta/models/{model}:countTextTokens", "name": "PaLM legacy: countTextTokens", "description": "Token count for a TextPrompt. Still advertised in `supportedGenerationMethods` of the embedding models, yet returns 404.", "status": [ "LEGACY", "DOCUMENTED", "FAILED_VERIFICATION" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json" }, "response": { "content_type": "application/json" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": {}, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "gemini-embedding-001 (lists countTextTokens) and gemini-3.5-flash-lite → 404 NOT_FOUND" }, "sources": [ { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/models", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "legacy-palm", "method": "POST", "path": "/v1beta/models/{model}:countMessageTokens", "name": "PaLM legacy: countMessageTokens", "description": "Token count for a MessagePrompt.", "status": [ "LEGACY", "DOCUMENTED", "FAILED_VERIFICATION" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json" }, "response": { "content_type": "application/json" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": {}, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 501, "request_note": "gemini-3.5-flash-lite → 501 UNIMPLEMENTED" }, "sources": [ { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "legacy-palm", "method": "POST", "path": "/v1beta/models/{model}:generateAnswer", "name": "Attributed Question Answering (model `aqa`)", "description": "Grounded answer over `inlinePassages` or a Semantic Retriever corpus, with `answerStyle` (ABSTRACTIVE|EXTRACTIVE|VERBOSE) and `answerableProbability`. Only model `aqa` supports it (listed in models API with inputTokenLimit 7168). English only. Still live.", "status": [ "LEGACY", "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json", "body": "GenerateAnswerRequest {contents[], answerStyle, safetySettings[], temperature, inlinePassages:{passages[{id, content}]} | semanticRetriever}" }, "response": { "content_type": "application/json", "object": "GenerateAnswerResponse {answer: Candidate(+groundingAttributions[]), answerableProbability, inputFeedback:{safetyRatings[]}}" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": {}, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "models/aqa:generateAnswer with one inline passage → 200, answer text = passage, answerableProbability 0.999992, groundingAttributions[0].sourceId.groundingPassage.passageId 'p1', 4 safetyRatings on answer and inputFeedback; no usageMetadata" }, "sources": [ { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "generate-content", "method": "POST", "path": "/v1/models/{model}:generateContent", "name": "Generate content (stable v1)", "description": "Stable-version route; same body. `v1` lacks the beta-only resources (`/v1/cachedContents` → 404 empty body) but serves `/v1/files`.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (recommended; the `key` query parameter also works but leaks into logs — never use it) or OAuth 2.0 Bearer token for user-scoped resources", "beta_header": null, "request": { "content_type": "application/json" }, "response": { "content_type": "application/json" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none (no idempotency header; POSTs are not idempotent)", "sdk": {}, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "a_v1_minimal → 200 identical shape (serviceTier, thoughtSignature included); GET /v1/cachedContents → 404 with empty body; GET /v1/files → 200" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/api-versions", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-core.json" }, { "provider": "gemini", "api_family": "image-generation", "method": "POST", "path": "/v1beta/models/{model}:predict", "name": "Predict (Imagen — shut down)", "description": "Synchronous prediction (instances[] + parameters). Historically the Imagen 3/4 endpoint (client.models.generate_images). Imagen models are shut down in the Gemini API (imagen-4.0-* shutdown 2026-08-17); the method remains in the discovery document but no image model is served through it.", "status": [ "DOCUMENTED", "RETIRED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "PredictRequest {instances[], parameters, labels}" }, "response": { "content_type": "application/json", "object": "PredictResponse {predictions[]}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.models.generate_images(...) # SDK method still exists; server returns error", "node": "ai.models.generateImages(...)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "HTTP 404 NOT_FOUND: models/imagen-4.0-fast-generate-001 is not found for API version v1beta, or is not supported for predict. Call ModelService.ListModels to see the list of available models and their supported methods." }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/imagen", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/models", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "notes": "Live: imagen-4.0-generate-001 -> HTTP 404 NOT_FOUND: models/imagen-4.0-generate-001 is not found for API version v1beta, or is not supported for predict. Call ModelService.ListModels to see the list of available m | gemini-3.5-flash-lite:predict -> HTTP 404 NOT_FOUND: models/gemini-3.5-flash-lite is not found for API version v1beta, or is not supported for predict. Call ModelService.ListModels to see the list of available mod", "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "video-generation", "method": "POST", "path": "/v1beta/models/{model}:predictLongRunning", "name": "Generate video (Veo, long-running)", "description": "Starts a Veo video generation and returns an Operation (name models/{model}/operations/{id}). Body: instances[{prompt, image, lastFrame, referenceImages[], video}], parameters{aspectRatio, durationSeconds, resolution, personGeneration, negativePrompt, seed, numberOfVideos}. Poll GET /v1beta/{name}; when done, response.generateVideoResponse.generatedSamples[].video.uri is a files download URI (API key header, 2-day retention). Latency 11 s to 6 min. Billed per second of output only if generation succeeds.", "status": [ "DOCUMENTED", "PREVIEW" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "PredictLongRunningRequest {instances[], parameters, labels}" }, "response": { "content_type": "application/json", "object": "Operation (response.@type GenerateVideoResponse)" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "op = client.models.generate_videos(model='veo-3.1-generate-preview', prompt=..., config=types.GenerateVideosConfig(...)); while not op.done: op = client.operations.get(op); client.files.download(file=op.response.generated_videos[0].video)", "node": "let op = await ai.models.generateVideos({model, prompt, config}); while(!op.done){ op = await ai.operations.getVideosOperation({operation: op}) }; ai.files.download({file: op.response.generatedVideos[0].video, downloadPath})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 400, "request_note": "Validation-only probes (no paid generation): {} -> HTTP 400 INVALID_ARGUMENT: No instances in the request. | instances:[{}] -> HTTP 400 INVALID_ARGUMENT: Unsupported video generation request. Please check the documentation for supported usage: https://ai.google.dev/gemini-api/docs/video | bogus model -> HTTP 404 NOT_FOUND: models/veo-9-generate is not found for API version v1beta, or is not supported for predictLongRunning. Call ModelService" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/veo", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/models", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/pricing", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "notes": "Live models: veo-3.1-generate-preview, veo-3.1-fast-generate-preview, veo-3.1-lite-generate-preview (supportedGenerationMethods = [predictLongRunning] only). veo-3.0-generate-001 / veo-3.0-fast-generate-001 / veo-2.0-generate-001 deprecated 2025-09-09, shut down 2026-06-30 (not in the live list). Gemini Omni Flash (Interactions API) is now the recommended default for video; Veo remains for extension/last-frame.", "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "operations", "method": "GET", "path": "/v1beta/{name=models/*/operations/*}", "name": "Get model operation (Veo polling)", "description": "Latest state of a long-running operation started by predictLongRunning. Fields: name, done, metadata, response|error.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "Operation" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.operations.get(operation)", "node": "ai.operations.getVideosOperation({operation})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "bogus name -> HTTP 403 PERMISSION_DENIED: You do not have permission to access the Operation with ID bogus-op or it may not exist. (error shape recorded; a real operation was not created to avoid Veo cost)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/veo", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "operations", "method": "GET", "path": "/v1beta/{name=models/*}/operations", "name": "List model operations", "description": "Lists operations under a model (filter, pageSize, pageToken, returnPartialSuccess).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "ListOperationsResponse", "live_note": "{}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": "pageSize/pageToken -> nextPageToken", "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "GET models/veo-3.1-lite-generate-preview/operations -> 200" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "operations", "method": "GET", "path": "/v1beta/{name=generatedFiles/*/operations/*}", "name": "Get generatedFiles operation", "description": "Operation variant scoped under generatedFiles (discovery: generatedFiles.operations.get).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "Operation" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 400, "request_note": "HTTP 400 INVALID_ARGUMENT: Request contains an invalid argument." }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "operations", "method": "GET", "path": "/v1beta/{name=tunedModels/*/operations/*}", "name": "Get tuning operation", "description": "Operation for tunedModels.create progress (metadata: CreateTunedModelMetadata with tunedModel, totalSteps, completedSteps, completedPercent, snapshots).", "status": [ "DOCUMENTED", "LEGACY", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "Operation" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 400, "request_note": "HTTP 400 INVALID_ARGUMENT: Request contains an invalid argument." }, "sources": [ { "url": "https://ai.google.dev/api/tuning", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "operations", "method": "GET", "path": "/v1beta/{name=tunedModels/*}/operations", "name": "List tuning operations", "description": "Lists operations of a tuned model.", "status": [ "DOCUMENTED", "LEGACY" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "ListOperationsResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": "pageSize/pageToken", "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "operations", "method": "GET", "path": "/v1beta/{name=fileSearchStores/*/operations/*} | /v1beta/{name=fileSearchStores/*/upload/operations/*} | /v1beta/{name=corpora/*/operations/*}", "name": "Other operation scopes (cross-reference)", "description": "Same Operation resource for file-search-store uploads and corpora (documented by the file-search agent).", "status": [ "DOCUMENTED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "Operation" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "files", "method": "GET", "path": "/v1beta/files/{file}:download?alt=media (via generatedSamples[].video.uri)", "name": "Download a generated video", "description": "Downloads bytes of a model-generated file (Veo MP4). Only model-generated files can be downloaded (not user uploads). Send x-goog-api-key and follow redirects; also used for batch responsesFile via /download/v1beta/{file}:download?alt=media.", "status": [ "DOCUMENTED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "video/mp4 (binary)" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.files.download(file=video)", "node": "ai.files.download({file, downloadPath})" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/veo", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/files", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/files", "retrieved_at": "2026-09-18" } ], "notes": "Retention: videos 2 days (timer resets when referenced for extension); batch response files 6 weeks; uploaded files 48 h.", "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "music-generation", "method": "WS", "path": "wss://generativelanguage.googleapis.com/ws/google.ai.generativelanguage.v1beta.GenerativeService.BidiGenerateMusic", "name": "Lyria RealTime (WebSocket)", "description": "Bidirectional streaming music generation with lyria-realtime-exp (supportedGenerationMethods = [bidiGenerateMusic]). Client sends setup -> waits setupComplete -> clientContent.weightedPrompts / musicGenerationConfig / playbackControl; server streams serverContent.audioChunks[] (raw 16-bit PCM, 48 kHz stereo) and filteredPrompt notices. Control latency <= 2 s. Instrumental only.", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": "LiveMusicClientMessage" }, "response": { "content_type": "JSON text frames", "object": "LiveMusicServerMessage" }, "streaming": { "supported": true, "events_ref": "generated/fragments/streaming-events/gemini-lyria-realtime.json", "transport": "WebSocket, API key in x-goog-api-key header" }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "async with client.aio.live.music.connect(model='models/lyria-realtime-exp') as session: await session.set_weighted_prompts(...); await session.set_music_generation_config(...); await session.play(); async for msg in session.receive(): ...", "node": "ai.live.music.connect({model:'models/lyria-realtime-exp', callbacks:{onmessage}}) -> session.setWeightedPrompts / setMusicGenerationConfig / play / pause / stop / resetContext" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 101, "request_note": "raw websockets: setup -> ['setupComplete']; received 2 audio chunks (audio/l16;rate=48000;channels=2), STOP sent" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/realtime-music-generation", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/models/lyria-realtime-exp", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/googleapis/python-genai/blob/main/google/genai/types.py", "retrieved_at": "2026-09-18" } ], "notes": "Experimental model (lyria-realtime-exp, May 2025); no price listed on the pricing page. Base URL path taken from google-genai live_music.py (version = client api_version, v1beta by default).", "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "batch", "method": "POST", "path": "/v1beta/models/{model}:batchGenerateContent", "name": "Create a generateContent batch", "description": "Enqueues a batch (inline requests < 20 MB, or a JSONL Files API file <= 2 GB) at 50% of standard price, 24 h target turnaround (expires after 48 h). Returns an Operation whose metadata is the GenerateContentBatch (state BATCH_STATE_PENDING …) and whose name is batches/{id}. Supported by all models exposing batchGenerateContent (incl. image and TTS models); also on tunedModels/*.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "BatchGenerateContentRequest {batch: GenerateContentBatch}" }, "response": { "content_type": "application/json", "object": "Operation (metadata GenerateContentBatch)", "live_note": "{\"error\": {\"code\": 400, \"message\": \"Precondition check failed.\", \"status\": \"FAILED_PRECONDITION\"}}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.batches.create(model='gemini-3.5-flash-lite', src=[{'contents': [...]}, ...] | 'files/…', config={'display_name': ...})", "node": "ai.batches.create({model, src, config:{displayName}})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 400, "request_note": "every create body (valid docs body on gemini-3.8-flash, body missing displayName, bogus fileName, embedding batch) -> HTTP 400 FAILED_PRECONDITION: Precondition check failed. — same error regardless of payload validity => account-level gate (pricing page: Batch 'Free Tier: Not available'; this key is on the free tier). No batch was created, so poll/cancel/delete could not be exercised." }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/batch-api", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/batch-api", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/pricing", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/rate-limits", "retrieved_at": "2026-09-18" } ], "notes": "Rate limits: 100 concurrent batch requests, per-model enqueued-token caps (rate-limits page). Not idempotent. Context caching allowed per request. Webhooks: batch.succeeded / batch.failed. GET /v1beta/batches -> 200 {} on this key.", "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "batch", "method": "GET", "path": "/v1beta/{name=batches/*}", "name": "Get batch (poll)", "description": "Returns the Operation: metadata.state / batchStats, done, then response.inlinedResponses[] {metadata, response|error} or response.responsesFile (JSONL, download via /download/v1beta/{file}:download?alt=media, kept 6 weeks).", "status": [ "DOCUMENTED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "Operation" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.batches.get(name='batches/…')", "node": "ai.batches.get({name})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 400, "request_note": "no batch could be created on this key (see create); GET batches/bogus-batch and batches/123456789 -> HTTP 400 INVALID_ARGUMENT: Could not parse the batch name" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/batch-api", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/batch-api", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "batch", "method": "GET", "path": "/v1beta/batches", "name": "List batches", "description": "Lists batch operations (filter, pageSize, pageToken).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "ListOperationsResponse", "live_note": "{}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": "pageSize/pageToken -> nextPageToken", "idempotency": "none documented", "sdk": { "python": "client.batches.list(config={'page_size': 10})", "node": "ai.batches.list({config:{pageSize:10}})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "GET /v1beta/batches?pageSize=5 -> 200" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/batch-api", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/batch-api", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "batch", "method": "POST", "path": "/v1beta/{name=batches/*}:cancel", "name": "Cancel batch", "description": "Best-effort asynchronous cancellation; the operation is kept and ends with error code 1 (CANCELLED) / state BATCH_STATE_CANCELLED. Empty body, empty response.", "status": [ "DOCUMENTED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": null }, "response": { "content_type": "application/json", "object": "Empty {}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.batches.cancel(name=...)", "node": "ai.batches.cancel({name})" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "only exercised if a batch was still running after 5 min (see lifecycle observed)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/batch-api", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/batch-api", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "batch", "method": "DELETE", "path": "/v1beta/{name=batches/*}", "name": "Delete batch", "description": "Deletes the operation record (does not cancel processing). Empty response.", "status": [ "DOCUMENTED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "Empty {}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.batches.delete(name=...)", "node": "ai.batches.delete({name})" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested (no live call)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/batch-api", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/batch-api", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "batch", "method": "PATCH", "path": "/v1beta/{name=batches/*}:updateGenerateContentBatch", "name": "Update generateContent batch", "description": "Updates mutable fields (priority; displayName/inputConfig per reference) with updateMask. Returns GenerateContentBatch.", "status": [ "DOCUMENTED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "GenerateContentBatch" }, "response": { "content_type": "application/json", "object": "GenerateContentBatch" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested (no live call)" }, "sources": [ { "url": "https://ai.google.dev/api/batch-api", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "batch", "method": "PATCH", "path": "/v1beta/{name=batches/*}:updateEmbedContentBatch", "name": "Update embedding batch", "description": "Same as above for EmbedContentBatch.", "status": [ "DOCUMENTED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "EmbedContentBatch" }, "response": { "content_type": "application/json", "object": "EmbedContentBatch" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested" }, "sources": [ { "url": "https://ai.google.dev/api/batch-api", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "batch", "method": "POST", "path": "/v1beta/{model=tunedModels/*}:batchGenerateContent | :asyncBatchEmbedContent", "name": "Batch on tuned models", "description": "Batch variants addressed at tunedModels/* (discovery).", "status": [ "DOCUMENTED", "LEGACY" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": null }, "response": { "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "tuning", "method": "POST", "path": "/v1beta/tunedModels", "name": "Create tuned model", "description": "Creates a TunedModel (baseModel or tunedModelSource + tuningTask.trainingData.examples + hyperparameters); returns an Operation (metadata CreateTunedModelMetadata). NOTE: since Gemini 1.5 Flash-001 was deprecated (May 2025) no base model in the Gemini API supports fine-tuning; the resource remains in the API and discovery document. Use Gemini Enterprise Agent Platform (Vertex) for supervised tuning.", "status": [ "DOCUMENTED", "DEPRECATED", "RETIRED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "TunedModel" }, "response": { "content_type": "application/json", "object": "Operation" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.tunings.tune(base_model=..., training_dataset=..., config=...) # Gemini API path returns an error today", "node": "ai.tunings.tune(...)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 501, "request_note": "POST /v1beta/tunedModels with an EMPTY body (nothing can be created) -> HTTP 501 UNIMPLEMENTED: Operation is not implemented, or supported, or enabled.; list/get also 501 => the tunedModels service is switched off for API-key callers" }, "sources": [ { "url": "https://ai.google.dev/api/tuning", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/model-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "notes": "No tuned model was created (empty-body probe only).", "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "tuning", "method": "GET", "path": "/v1beta/tunedModels", "name": "List tuned models", "description": "Paginated list (pageSize default 10 / max 1000, pageToken, filter owner:me|readers:me|…).", "status": [ "DOCUMENTED", "LEGACY", "RETIRED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "ListTunedModelsResponse", "live_note": "{\"error\": {\"code\": 501, \"message\": \"Operation is not implemented, or supported, or enabled.\", \"status\": \"UNIMPLEMENTED\"}}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": "pageSize/pageToken -> nextPageToken", "idempotency": "none documented", "sdk": { "python": "client.tunings.list()", "node": "ai.tunings.list()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 501, "request_note": "HTTP 501 UNIMPLEMENTED: Operation is not implemented, or supported, or enabled." }, "sources": [ { "url": "https://ai.google.dev/api/tuning", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "tuning", "method": "GET", "path": "/v1beta/{name=tunedModels/*}", "name": "Get tuned model", "description": "TunedModel resource (state CREATING|ACTIVE|FAILED, tuningTask.snapshots…).", "status": [ "DOCUMENTED", "LEGACY", "RETIRED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "TunedModel" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.tunings.get(name=...)", "node": "ai.tunings.get({name})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 501, "request_note": "bogus id -> HTTP 501 UNIMPLEMENTED: Operation is not implemented, or supported, or enabled." }, "sources": [ { "url": "https://ai.google.dev/api/tuning", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "tuning", "method": "PATCH", "path": "/v1beta/{tunedModel.name=tunedModels/*}", "name": "Update tuned model", "description": "Updates displayName/description etc. with updateMask.", "status": [ "DOCUMENTED", "LEGACY" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "TunedModel" }, "response": { "content_type": "application/json", "object": "TunedModel" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested" }, "sources": [ { "url": "https://ai.google.dev/api/tuning", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "tuning", "method": "DELETE", "path": "/v1beta/{name=tunedModels/*}", "name": "Delete tuned model", "description": "Deletes a tuned model; empty response.", "status": [ "DOCUMENTED", "LEGACY" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "Empty {}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested" }, "sources": [ { "url": "https://ai.google.dev/api/tuning", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "tuning", "method": "POST", "path": "/v1beta/{model=tunedModels/*}:generateContent", "name": "Generate with a tuned model", "description": "Same body as models.generateContent (also :streamGenerateContent). Legacy :generateText also present in discovery.", "status": [ "DOCUMENTED", "LEGACY" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "GenerateContentRequest" }, "response": { "content_type": "application/json", "object": "GenerateContentResponse" }, "streaming": { "supported": true, "events_ref": ":streamGenerateContent (SSE)", "transport": "SSE" }, "pagination": null, "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested" }, "sources": [ { "url": "https://ai.google.dev/api/tuning", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "tuning", "method": "POST", "path": "/v1beta/{name=tunedModels/*}:transferOwnership", "name": "Transfer ownership", "description": "Transfers ownership to another user (emailAddress); the only way to change the owner.", "status": [ "DOCUMENTED", "LEGACY" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "TransferOwnershipRequest {emailAddress}" }, "response": { "content_type": "application/json", "object": "TransferOwnershipResponse {}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "tuning", "method": "GET", "path": "/v1beta/{parent=tunedModels/*}/permissions", "name": "List permissions", "description": "Permissions (USER|GROUP|EVERYONE x OWNER|WRITER|READER) on a tuned model.", "status": [ "DOCUMENTED", "LEGACY", "RETIRED" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "ListPermissionsResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": "pageSize/pageToken", "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 501, "request_note": "bogus parent -> HTTP 501 UNIMPLEMENTED: Operation is not implemented, or supported, or enabled." }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "tuning", "method": "POST", "path": "/v1beta/{parent=tunedModels/*}/permissions", "name": "Create permission", "description": "Grants a role to a user/group/everyone.", "status": [ "DOCUMENTED", "LEGACY" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "Permission" }, "response": { "content_type": "application/json", "object": "Permission" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "tuning", "method": "GET", "path": "/v1beta/{name=tunedModels/*/permissions/*}", "name": "Get permission", "description": "Single permission.", "status": [ "DOCUMENTED", "LEGACY" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "Permission" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "tuning", "method": "PATCH", "path": "/v1beta/{name=tunedModels/*/permissions/*}", "name": "Update permission", "description": "Updates role (updateMask).", "status": [ "DOCUMENTED", "LEGACY" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "Permission" }, "response": { "content_type": "application/json", "object": "Permission" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "tuning", "method": "DELETE", "path": "/v1beta/{name=tunedModels/*/permissions/*}", "name": "Delete permission", "description": "Revokes a permission.", "status": [ "DOCUMENTED", "LEGACY" ], "auth": "x-goog-api-key header (API key); never put the key in the URL", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "Empty {}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not tested" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "notes": null, "_fragment": "generated/fragments/endpoints/gemini-media-batch-tuning.json" }, { "provider": "gemini", "api_family": "models", "method": "GET", "path": "/v1beta/models", "name": "models.list", "description": "Lists Model resources available to the caller. Paginated: pageSize (default 50, max 1000) + pageToken; response {models:[Model], nextPageToken}. Model fields: name, baseModelId (absent live), version, displayName, description, inputTokenLimit, outputTokenLimit, supportedGenerationMethods[], temperature, maxTemperature, topP, topK, thinking (bool; documented in discovery revision 20260918). Live 2026-09-19: 58 models, 6 pages at pageSize=10; ids include aliases (-latest), agents (deep-research-*, antigravity-*), legacy aqa, previews already marked shut down in docs.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key | ?key= | OAuth Bearer", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [ "pageSize", "pageToken" ] }, "response": { "body_ref": "ListModelsResponse", "fields": [ "models[]", "nextPageToken" ] }, "streaming": { "supported": false }, "pagination": { "style": "pageToken", "page_size_param": "pageSize", "default": 50, "max": 1000, "next_field": "nextPageToken" }, "idempotency": "GET", "sdk": { "python": "client.models.list() # types.Model.supported_actions", "node": "ai.models.list()" }, "verification": { "method": "live_api", "verified_at": "2026-09-19T00:00:00Z", "result": "success", "http_status": 200, "request_note": "GET /v1beta/models?pageSize=10 (+pageToken) x6 -> 58 models" }, "sources": [ { "url": "https://ai.google.dev/api/models", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-models-misc.json" }, { "provider": "gemini", "api_family": "models", "method": "GET", "path": "/v1beta/models/{model}", "name": "models.get", "description": "Returns one Model. Works for aliases (gemini-flash-latest: version field = 'Gemini Flash Latest'), variants (gemini-3.1-pro-preview-customtools), agents and even 2.5 models that generation refuses for new users (GET 200, generateContent 404). Shut-down ids not in the listing -> 404 NOT_FOUND 'Model is not found: models/{id} for api version v1beta' (imagen-4.0-generate-001).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key | OAuth Bearer", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "body_ref": "Model" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "GET", "sdk": { "python": "client.models.get(model='gemini-3.8-flash')", "node": "ai.models.get({ model })" }, "verification": { "method": "live_api", "verified_at": "2026-09-19T00:00:00Z", "result": "success", "http_status": 200, "request_note": "12 ids probed: 11x 200, imagen-4.0-generate-001 -> 404" }, "sources": [ { "url": "https://ai.google.dev/api/models", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-models-misc.json" }, { "provider": "gemini", "api_family": "models", "method": "GET", "path": "/v1/models", "name": "models.list (v1 stable surface)", "description": "Same schema as v1beta but the stable surface lists only GA models: 22 ids live (gemini-2.5-flash, gemini-2.5-pro, gemma-4-26b-a4b-it, gemma-4-31b-it, gemini-2.5-flash-lite, gemini-2.5-flash-image, gemini-3.1-flash-lite, gemini-3-pro-image, gemini-3.1-flash-image, gemini-3.1-flash-lite-image, gemini-3.5-flash, gemini-3.5-flash-lite, gemini-3.6-flash, gemini-3.7-flash, gemini-3.8-flash, antigravity-preview-05-2026, antigravity-preview-09-2026, deep-research-max-preview-04-2026, deep-research-preview-04-2026, deep-research-pro-preview-12-2025, gemini-embedding-001, gemini-embedding-2). 36 v1beta ids are absent (all previews, -latest aliases, Live/TTS/transcribe, Veo, Lyria, Omni, robotics, aqa). GET /v1/models/gemini-3.1-pro-preview -> 404 'for api version v1'. Contradicts api-versions.md ('All models are supported in both v1 and v1beta'). v1 discovery doc has 47 methods vs 86 in v1beta (no cachedContents, tunedModels, corpora, environments, auth_tokens, PaLM legacy methods, predict/predictLongRunning, generateAnswer).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "x-goog-api-key", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [ "pageSize", "pageToken" ] }, "response": { "body_ref": "ListModelsResponse" }, "streaming": { "supported": false }, "pagination": { "style": "pageToken", "page_size_param": "pageSize" }, "idempotency": "GET", "sdk": { "python": "genai.Client(http_options={'api_version': 'v1'}).models.list()", "node": "new GoogleGenAI({ httpOptions: { apiVersion: 'v1' } }).models.list()" }, "verification": { "method": "live_api", "verified_at": "2026-09-19T00:00:00Z", "result": "success", "http_status": 200, "request_note": "GET /v1/models?pageSize=10 x3 -> 22 models; GET /v1/models/gemini-3.1-pro-preview -> 404" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/api-versions", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/models", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-models-misc.json" }, { "provider": "gemini", "api_family": "openai-compat", "method": "POST", "path": "/v1beta/openai/chat/completions", "name": "OpenAI-compatible chat completions", "description": "OpenAI Chat Completions surface over Gemini models. Auth: Authorization: Bearer (x-goog-api-key alone -> 400 'Missing or invalid Authorization header.'). Supported: messages (system/user/assistant/tool), stream + stream_options.include_usage, tools/tool_choice (function calling), image_url (data: URLs) and input_audio parts, response_format json_schema (structured output), reasoning_effort (minimal|low|medium|high -> thinking_level; 'none' disables thinking on 2.5 non-Pro only), service_tier flex|priority|standard, n, max_tokens, extra_body.google.{thinking_config:{thinking_level,include_thoughts,thinking_budget}, cached_content}. Response adds message.extra_content.google.thought_signature on Gemini 3 (echo it back in multi-turn tool calls). Unknown params are silently ignored. Live: gemini-3.5-flash-lite max_tokens=8 -> 200, finish_reason 'stop', usage prompt 5 / completion 2 / total 7, no reasoning usage breakdown.", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer ", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "OpenAI ChatCompletionRequest subset" }, "response": { "body_ref": "OpenAI ChatCompletion (+ extra_content.google.thought_signature)" }, "streaming": { "supported": true, "events_ref": "OpenAI SSE chunks (choices[].delta)" }, "pagination": null, "idempotency": "none", "sdk": { "python": "openai.OpenAI(api_key=GEMINI_API_KEY, base_url='https://generativelanguage.googleapis.com/v1beta/openai/').chat.completions.create(...)", "node": "new OpenAI({ apiKey, baseURL: 'https://generativelanguage.googleapis.com/v1beta/openai/' }).chat.completions.create(...)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19T00:00:00Z", "result": "success", "http_status": 200, "request_note": "model gemini-3.5-flash-lite, 'Reply with OK.', max_tokens 8 -> 200 'OK.'; without Bearer -> 400" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/openai", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-models-misc.json" }, { "provider": "gemini", "api_family": "openai-compat", "method": "POST", "path": "/v1beta/openai/embeddings", "name": "OpenAI-compatible embeddings", "description": "OpenAI embeddings request {model, input} with gemini-embedding-2-preview / gemini-embedding-2 (multimodal ids, text input here) or gemini-embedding-001. dimensions parameter: not documented for this layer (use native output_dimensionality).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Authorization: Bearer ", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "OpenAI EmbeddingRequest" }, "response": { "body_ref": "OpenAI EmbeddingResponse" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none", "sdk": { "python": "client.embeddings.create(model='gemini-embedding-2-preview', input='...')", "node": "openai.embeddings.create({ model, input })" }, "verification": { "method": "docs_only", "verified_at": null, "result": "not_tested", "http_status": null, "request_note": null }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/openai", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-models-misc.json" }, { "provider": "gemini", "api_family": "openai-compat", "method": "GET", "path": "/v1beta/openai/models", "name": "OpenAI-compatible models list", "description": "Returns {object:'list', data:[{id:'models/', object:'model', owned_by:'google', display_name}]} - same 58 ids as GET /v1beta/models (ids keep the 'models/' prefix, which the OpenAI SDK accepts as model names). Not paginated.", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (x-goog-api-key -> 404 'Requested entity was not found.')", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "body_ref": "OpenAI ModelList" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "GET", "sdk": { "python": "client.models.list()", "node": "openai.models.list()" }, "verification": { "method": "live_api", "verified_at": "2026-09-19T00:00:00Z", "result": "success", "http_status": 200, "request_note": "58 models returned" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/openai", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-models-misc.json" }, { "provider": "gemini", "api_family": "openai-compat", "method": "GET", "path": "/v1beta/openai/models/{model}", "name": "OpenAI-compatible model retrieve", "description": "Returns {id:'models/gemini-3.8-flash', object:'model', owned_by:'google', display_name:'Gemini 3.8 Flash'} (no created timestamp).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer ", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "body_ref": "OpenAI Model" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "GET", "sdk": { "python": "client.models.retrieve('gemini-3.8-flash')", "node": "openai.models.retrieve('gemini-3.8-flash')" }, "verification": { "method": "live_api", "verified_at": "2026-09-19T00:00:00Z", "result": "success", "http_status": 200, "request_note": "gemini-3.8-flash -> 200" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/openai", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-models-misc.json" }, { "provider": "gemini", "api_family": "openai-compat", "method": "POST", "path": "/v1beta/openai/images/generations", "name": "OpenAI-compatible image generation", "description": "Supported params: prompt, model (gemini-2.5-flash-image, gemini-3-pro-image-preview per docs; GA ids not listed), n, size, response_format (b64_json). extra_body: aspect_ratio, generation_config ({responseModalities:['IMAGE'], candidateCount}), safety_settings, tools ([{google_search:{}}] only for gemini-3-pro-image-preview). Other params silently ignored.", "status": [ "DOCUMENTED", "BETA" ], "auth": "Authorization: Bearer ", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "OpenAI ImageGenerationRequest subset" }, "response": { "body_ref": "OpenAI ImagesResponse (b64_json)" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none", "sdk": { "python": "client.images.generate(model='gemini-2.5-flash-image', prompt=..., response_format='b64_json', n=1)", "node": "openai.images.generate({...})" }, "verification": { "method": "docs_only", "verified_at": null, "result": "not_tested", "http_status": null, "request_note": "not called (paid-only image models)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/openai", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-models-misc.json" }, { "provider": "gemini", "api_family": "openai-compat", "method": "POST", "path": "/v1beta/openai/videos", "name": "OpenAI (Sora-style) compatible video generation", "description": "client.videos.create(model='veo-3.1-generate-preview', prompt) -> long-running operation {id, status:'processing'}; poll GET /v1beta/openai/videos/{id} until status completed (url) or failed (error). Top-level params: prompt, model; extra_body: aspect_ratio, resolution (720p|1080p|4K), duration_seconds (4|6|8), frame_rate, input_reference, extend_video_id, negative_prompt, seed, style (cinematic|creative), person_generation, reference_images (<=3), image, last_frame. REST form uses multipart -F fields.", "status": [ "DOCUMENTED", "BETA" ], "auth": "Authorization: Bearer ", "beta_header": null, "request": { "content_type": "multipart/form-data | application/json", "body_ref": "OpenAI VideoCreate subset" }, "response": { "body_ref": "OpenAI Video object (id, status, url, error)" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none", "sdk": { "python": "client.videos.create(...); client.videos.retrieve(id)", "node": "openai.videos.create(...); openai.videos.retrieve(id)" }, "verification": { "method": "docs_only", "verified_at": null, "result": "not_tested", "http_status": null, "request_note": "not called (paid, $0.40/s)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/openai", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-models-misc.json" }, { "provider": "gemini", "api_family": "openai-compat", "method": "POST", "path": "/v1beta/openai/batches", "name": "OpenAI-compatible Batch API", "description": "batches.create(input_file_id, endpoint='/v1/chat/completions' | '/v1/embeddings', completion_window='24h'), batches.retrieve(id) with statuses completed/failed/cancelled/expired. Input JSONL in OpenAI format ({custom_id, method, url, body}). File upload/download is NOT supported through the OpenAI layer: upload with the genai SDK (client.files.upload(..., mime_type='jsonl')) and download results with client.files.download(file=batch.output_file_id).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Authorization: Bearer ", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "OpenAI BatchCreate" }, "response": { "body_ref": "OpenAI Batch" }, "streaming": { "supported": false }, "pagination": null, "idempotency": "none", "sdk": { "python": "openai_client.batches.create(...); genai client.files.upload/download", "node": "n/a in docs" }, "verification": { "method": "docs_only", "verified_at": null, "result": "not_tested", "http_status": null, "request_note": null }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/openai", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-models-misc.json" }, { "provider": "gemini", "api_family": "file-search", "method": "POST", "path": "/v1beta/fileSearchStores", "name": "fileSearchStores.create", "description": "Creates an empty FileSearchStore. Body: FileSearchStore {displayName? (≤512 chars), embeddingModel? (models/{model}; models/gemini-embedding-2 for multimodal)}. Returns the store with server-generated `name` (fileSearchStores/-<12 random chars>), createTime, updateTime, counters. Store names are globally scoped.", "status": [ "DOCUMENTED", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "FileSearchStore", "path_params": [], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "FileSearchStore", "error_statuses": [ 400, 403, 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.file_search_stores.create(config={'display_name': 'My Store', 'embedding_model': 'models/gemini-embedding-2'})", "node": "ai.fileSearchStores.create({ config: { displayName: 'My Store', embeddingModel: 'models/gemini-embedding-2' } })" }, "relations": [ "POST /v1beta/models/{model}:generateContent (consumer: tools[].fileSearch.fileSearchStoreNames — documented by the generateContent agent)", "POST /v1beta/models/{model}:streamGenerateContent (same)", "POST /v1beta/interactions (tools[{type:file_search,file_search_store_names}])" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "g1: {displayName} → {name, displayName, createTime, updateTime, embeddingModel: models/gemini-embedding-001} (tmp-live/gemini-tools/g1_store_create.json)" }, "sources": [ { "url": "https://ai.google.dev/api/file-search/file-search-stores", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "file-search", "method": "GET", "path": "/v1beta/fileSearchStores", "name": "fileSearchStores.list", "description": "Lists all FileSearchStores owned by the caller, sorted by ascending createTime. Query: pageSize (max 10 per discovery; default 10), pageToken. Response ListFileSearchStoresResponse {fileSearchStores[], nextPageToken}.", "status": [ "DOCUMENTED", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "pageSize", "pageToken" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ListFileSearchStoresResponse", "error_statuses": [ 400, 403, 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "token", "params": [ "pageSize", "pageToken" ], "response_fields": [ "fileSearchStores", "nextPageToken" ] }, "idempotency": null, "sdk": { "python": "for s in client.file_search_stores.list(): ...", "node": "for await (const s of await ai.fileSearchStores.list()) { ... }" }, "relations": [ "POST /v1beta/models/{model}:generateContent (consumer: tools[].fileSearch.fileSearchStoreNames — documented by the generateContent agent)", "POST /v1beta/models/{model}:streamGenerateContent (same)", "POST /v1beta/interactions (tools[{type:file_search,file_search_store_names}])" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "g7b: ?pageSize=5 → {fileSearchStores:[…]}" }, "sources": [ { "url": "https://ai.google.dev/api/file-search/file-search-stores", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "file-search", "method": "GET", "path": "/v1beta/fileSearchStores/{name}", "name": "fileSearchStores.get", "description": "Gets a FileSearchStore by resource name (fileSearchStores/{id}). Returns name, displayName, embeddingModel, sizeBytes, activeDocumentsCount, pendingDocumentsCount, failedDocumentsCount, createTime, updateTime.", "status": [ "DOCUMENTED", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "name" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "FileSearchStore", "error_statuses": [ 403, 404, 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.file_search_stores.get(name='fileSearchStores/my-store-123')", "node": "ai.fileSearchStores.get({ name: 'fileSearchStores/my-store-123' })" }, "relations": [ "POST /v1beta/models/{model}:generateContent (consumer: tools[].fileSearch.fileSearchStoreNames — documented by the generateContent agent)", "POST /v1beta/models/{model}:streamGenerateContent (same)", "POST /v1beta/interactions (tools[{type:file_search,file_search_store_names}])" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "g7: store with activeDocumentsCount '1', sizeBytes '200' (tmp-live/gemini-tools/g7_store_get.json)" }, "sources": [ { "url": "https://ai.google.dev/api/file-search/file-search-stores", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "file-search", "method": "DELETE", "path": "/v1beta/fileSearchStores/{name}", "name": "fileSearchStores.delete", "description": "Deletes a FileSearchStore. Query `force=true` also deletes contained Documents (and their chunks/embeddings); with force=false (default) a FAILED_PRECONDITION error is returned if the store contains Documents. Response: empty JSON object.", "status": [ "DOCUMENTED", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "name" ], "query_params": [ "force" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Empty", "error_statuses": [ 400, 403, 404, 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.file_search_stores.delete(name='fileSearchStores/my-store-123', config={'force': True})", "node": "ai.fileSearchStores.delete({ name: 'fileSearchStores/my-store-123', config: { force: true } })" }, "relations": [ "POST /v1beta/models/{model}:generateContent (consumer: tools[].fileSearch.fileSearchStoreNames — documented by the generateContent agent)", "POST /v1beta/models/{model}:streamGenerateContent (same)", "POST /v1beta/interactions (tools[{type:file_search,file_search_store_names}])" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "g9: DELETE …?force=true → 200 {} (store still held one document)" }, "sources": [ { "url": "https://ai.google.dev/api/file-search/file-search-stores", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "file-search", "method": "POST", "path": "/upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore", "name": "media.uploadToFileSearchStore", "description": "Uploads raw bytes to a FileSearchStore, chunks, embeds and indexes them into a new Document (long-running operation). TWO URIs: media upload `POST https://generativelanguage.googleapis.com/upload/v1beta/{fileSearchStoreName}:uploadToFileSearchStore` (discovery mediaUpload.protocols.simple.path; multipart/related JSON metadata + bytes) and the resumable variant `/resumable/upload/v1beta/{fileSearchStoreName}:uploadToFileSearchStore` (discovery) — the guide's REST example initiates resumable uploads directly on the /upload/v1beta/ URI with X-Goog-Upload-Protocol: resumable / X-Goog-Upload-Command: start, then sends bytes to the returned X-Goog-Upload-URL with X-Goog-Upload-Command: upload, finalize. Metadata-only URI (discovery `path`): `POST /v1beta/{fileSearchStoreName}:uploadToFileSearchStore`. Metadata body UploadToFileSearchStoreRequest {displayName?, mimeType?, customMetadata[]?, chunkingConfig?{whiteSpaceConfig{maxTokensPerChunk,maxOverlapTokens}}}. Accepts */*, max 100 MB (104857600 bytes). Response: CustomLongRunningOperation {name: fileSearchStores/{id}/upload/operations/{op}, done, metadata, response|error} — poll GET on that name. Files uploaded this way bypass Files API storage.", "status": [ "DOCUMENTED", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted)", "beta_header": null, "request": { "content_type": "multipart/related (simple) or application/json metadata + X-Goog-Upload-* headers (resumable)", "body_ref": "UploadToFileSearchStoreRequest + media", "path_params": [ "fileSearchStoreName" ], "query_params": [], "header_params": [ "X-Goog-Upload-Protocol", "X-Goog-Upload-Command", "X-Goog-Upload-Header-Content-Length", "X-Goog-Upload-Header-Content-Type", "X-Goog-Upload-Offset" ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "CustomLongRunningOperation (google.longrunning.Operation)", "error_statuses": [ 400, 403, 404, 413, 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "op = client.file_search_stores.upload_to_file_search_store(file='sample.txt', file_search_store_name=store.name, config={'display_name': 'sample.txt', 'custom_metadata': [{'key':'author','string_value':'X'}], 'chunking_config': {'white_space_config': {'max_tokens_per_chunk': 200, 'max_overlap_tokens': 20}}}); while not op.done: op = client.operations.get(op)", "node": "let op = await ai.fileSearchStores.uploadToFileSearchStore({ file: 'sample.txt', fileSearchStoreName: store.name, config: { displayName: 'sample.txt' } }); while (!op.done) op = await ai.operations.get({ operation: op })" }, "relations": [ "POST /v1beta/models/{model}:generateContent (consumer: tools[].fileSearch.fileSearchStoreNames — documented by the generateContent agent)", "POST /v1beta/models/{model}:streamGenerateContent (same)", "POST /v1beta/interactions (tools[{type:file_search,file_search_store_names}])" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "g2/g3: resumable protocol — start (X-Goog-Upload-Protocol: resumable, -Command: start, JSON metadata displayName+customMetadata) → 200 + X-Goog-Upload-URL; then POST upload URL with 'upload, finalize' + 200 bytes → Operation {name: fileSearchStores/…/upload/operations/…, response} (tmp-live/gemini-tools/g3_upload_finalize.json)" }, "sources": [ { "url": "https://ai.google.dev/api/file-search/file-search-stores", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/file-search", "retrieved_at": "2026-09-18" } ], "alternate_paths": [ "POST /v1beta/fileSearchStores/{name}:uploadToFileSearchStore (metadata-only, discovery `path`)", "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore (simple/multipart, discovery mediaUpload.protocols.simple)", "POST /resumable/upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore (discovery mediaUpload.protocols.resumable)" ], "limits": { "maxSize_bytes": 104857600, "accept": [ "*/*" ] }, "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "file-search", "method": "POST", "path": "/v1beta/fileSearchStores/{name}:importFile", "name": "fileSearchStores.importFile", "description": "Imports an existing Files API File (files/*) into a FileSearchStore as a Document (long-running operation). Body ImportFileRequest {fileName (required), customMetadata[]?, chunkingConfig?}. Response: Operation {name: fileSearchStores/{id}/operations/{op}, done, ...}; poll via fileSearchStores.operations.get. The source File still expires after 48 h; the indexed Document persists until deleted.", "status": [ "DOCUMENTED", "PREVIEW" ], "auth": "x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ImportFileRequest", "path_params": [ "fileSearchStoreName" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Operation", "error_statuses": [ 400, 403, 404, 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "op = client.file_search_stores.import_file(file_search_store_name=store.name, file_name=sample_file.name, custom_metadata=[{'key':'year','numeric_value':1934}]); while not op.done: time.sleep(5); op = client.operations.get(op)", "node": "let op = await ai.fileSearchStores.importFile({ fileSearchStoreName: store.name, fileName: sampleFile.name }); while (!op.done) op = await ai.operations.get({ operation: op })" }, "relations": [ "POST /v1beta/models/{model}:generateContent (consumer: tools[].fileSearch.fileSearchStoreNames — documented by the generateContent agent)", "POST /v1beta/models/{model}:streamGenerateContent (same)", "POST /v1beta/interactions (tools[{type:file_search,file_search_store_names}])" ], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/api/file-search/file-search-stores", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "file-search", "method": "GET", "path": "/v1beta/fileSearchStores/{name}/documents", "name": "fileSearchStores.documents.list", "description": "Lists Documents of a store, sorted by ascending createTime. Query pageSize (max 20 per discovery; default 10), pageToken. Response ListDocumentsResponse {documents[], nextPageToken}. Document fields: name, displayName, customMetadata[], state (STATE_PENDING|STATE_ACTIVE|STATE_FAILED), sizeBytes, mimeType, createTime, updateTime.", "status": [ "DOCUMENTED", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "parent" ], "query_params": [ "pageSize", "pageToken" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ListDocumentsResponse", "error_statuses": [ 403, 404, 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "token", "params": [ "pageSize", "pageToken" ], "response_fields": [ "documents", "nextPageToken" ] }, "idempotency": null, "sdk": { "python": "for doc in client.file_search_stores.documents.list(parent='fileSearchStores/my-store-123'): ...", "node": "for await (const doc of await ai.fileSearchStores.documents.list({ parent: 'fileSearchStores/my-store-123' })) { ... }" }, "relations": [ "POST /v1beta/models/{model}:generateContent (consumer: tools[].fileSearch.fileSearchStoreNames — documented by the generateContent agent)", "POST /v1beta/models/{model}:streamGenerateContent (same)", "POST /v1beta/interactions (tools[{type:file_search,file_search_store_names}])" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "g5: {documents:[{name, displayName, mimeType, sizeBytes, state: STATE_ACTIVE, customMetadata, createTime, updateTime}]} (tmp-live/gemini-tools/g5_documents_list.json)" }, "sources": [ { "url": "https://ai.google.dev/api/file-search/documents", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "file-search", "method": "GET", "path": "/v1beta/fileSearchStores/{name}/documents/{document}", "name": "fileSearchStores.documents.get", "description": "Gets a Document (fileSearchStores/{store}/documents/{doc}).", "status": [ "DOCUMENTED", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "name" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Document", "error_statuses": [ 403, 404, 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.file_search_stores.documents.get(name='fileSearchStores/my-store-123/documents/my-doc')", "node": "ai.fileSearchStores.documents.get({ name: 'fileSearchStores/my-store-123/documents/my-doc' })" }, "relations": [ "POST /v1beta/models/{model}:generateContent (consumer: tools[].fileSearch.fileSearchStoreNames — documented by the generateContent agent)", "POST /v1beta/models/{model}:streamGenerateContent (same)", "POST /v1beta/interactions (tools[{type:file_search,file_search_store_names}])" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "g5b: same Document shape as list" }, "sources": [ { "url": "https://ai.google.dev/api/file-search/documents", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "file-search", "method": "DELETE", "path": "/v1beta/fileSearchStores/{name}/documents/{document}", "name": "fileSearchStores.documents.delete", "description": "Deletes a Document. Query force=true also deletes its Chunks; with force=false (default) FAILED_PRECONDITION if the Document contains Chunks. Response: empty JSON object.", "status": [ "DOCUMENTED", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "name" ], "query_params": [ "force" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Empty", "error_statuses": [ 400, 403, 404, 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.file_search_stores.documents.delete(name='fileSearchStores/my-store-123/documents/my-doc', config={'force': True})", "node": "ai.fileSearchStores.documents.delete({ name: 'fileSearchStores/my-store-123/documents/my-doc', config: { force: true } })" }, "relations": [ "POST /v1beta/models/{model}:generateContent (consumer: tools[].fileSearch.fileSearchStoreNames — documented by the generateContent agent)", "POST /v1beta/models/{model}:streamGenerateContent (same)", "POST /v1beta/interactions (tools[{type:file_search,file_search_store_names}])" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "g8 without force → 400 FAILED_PRECONDITION 'Cannot delete non-empty Document'; with ?force=true → 200 (examples/file_search_lifecycle.py, test_file_search.py)" }, "sources": [ { "url": "https://ai.google.dev/api/file-search/documents", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "file-search", "method": "GET", "path": "/v1beta/fileSearchStores/{name}/operations/{operation}", "name": "fileSearchStores.operations.get", "description": "Polls a long-running operation created by importFile (name fileSearchStores/{id}/operations/{op}). Operation {name, metadata, done, error{code,message,details}|response}.", "status": [ "DOCUMENTED", "PREVIEW" ], "auth": "x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "name" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Operation", "error_statuses": [ 403, 404, 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.operations.get(op) # SDK routes by operation name", "node": "ai.operations.get({ operation: op })" }, "relations": [ "POST /v1beta/models/{model}:generateContent (consumer: tools[].fileSearch.fileSearchStoreNames — documented by the generateContent agent)", "POST /v1beta/models/{model}:streamGenerateContent (same)", "POST /v1beta/interactions (tools[{type:file_search,file_search_store_names}])" ], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/api/file-search/file-search-stores", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "file-search", "method": "GET", "path": "/v1beta/fileSearchStores/{name}/upload/operations/{operation}", "name": "fileSearchStores.upload.operations.get", "description": "Polls a long-running operation created by media.uploadToFileSearchStore (name fileSearchStores/{id}/upload/operations/{op}). Same Operation shape.", "status": [ "DOCUMENTED", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "name" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Operation", "error_statuses": [ 403, 404, 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.operations.get(op)", "node": "ai.operations.get({ operation: op })" }, "relations": [ "POST /v1beta/models/{model}:generateContent (consumer: tools[].fileSearch.fileSearchStoreNames — documented by the generateContent agent)", "POST /v1beta/models/{model}:streamGenerateContent (same)", "POST /v1beta/interactions (tools[{type:file_search,file_search_store_names}])" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "g4: polled until done:true; response {@type, documentName, mimeType, parent, sizeBytes} (tmp-live/gemini-tools/g4_operation_done.json)" }, "sources": [ { "url": "https://ai.google.dev/api/file-search/file-search-stores", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "file-search", "method": "GET", "path": "/v1beta/fileSearchStores/{name}/media/{blob}", "name": "fileSearchStores.media.download (mediaId)", "description": "Downloads the image chunk cited by groundingChunks[].retrievedContext.mediaId (multimodal File Search). Documented only in the guide (REST example uses https://generativelanguage.googleapis.com/v1/fileSearchStores/my-store-123/media/BlobId-456 with x-goog-api-key); not among the 86 v1beta discovery methods on 2026-09-18 (the reference page's 'media.download' entry describes an unrelated environments files endpoint).", "status": [ "DOCUMENTED", "PREVIEW", "DOCUMENTATION_INCOMPLETE", "UNVERIFIED" ], "auth": "x-goog-api-key: header (or ?key= query — avoid; OAuth also accepted)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [ "mediaId" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "image/* (bytes)", "body_ref": null, "error_statuses": [ 403, 404, 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.file_search_stores.download_media(media_id=chunk.retrieved_context.media_id)", "node": "ai.fileSearchStores.downloadMedia(chunk.retrievedContext.mediaId)" }, "relations": [ "POST /v1beta/models/{model}:generateContent (consumer: tools[].fileSearch.fileSearchStoreNames — documented by the generateContent agent)", "POST /v1beta/models/{model}:streamGenerateContent (same)", "POST /v1beta/interactions (tools[{type:file_search,file_search_store_names}])" ], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/generate-content/file-search", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/file-search/file-search-stores", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "interactions", "method": "POST", "path": "/v1beta/interactions", "name": "Create interaction", "description": "Creates a new Interaction against a `model` (Gemini/Gemma/Lyria/robotics) or an `agent` (deep-research-*, antigravity-*, custom agent id). One of `model`/`agent` is required plus `input`. `stream: true` switches the response to SSE (InteractionSseEvent); `background: true` returns immediately with status queued/in_progress; `previous_interaction_id` chains server-side state (requires the previous interaction stored with `store=true`). The create response returns only model-generated `steps` (GET returns the full timeline incl. `user_input`).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": "application/json", "body_ref": "CreateInteractionRequest (CreateModelInteraction | CreateAgentInteraction)", "path_params": [ { "name": "api_version", "required": true, "description": "API version path segment (v1beta here; v1 also exists)." } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Content-Type", "required": true, "description": "application/json" }, { "name": "Api-Revision", "required": false, "description": "Schema revision opt-in/out. `2026-05-20` = current steps/response_format schema (default since 2026-05-26); `2026-05-07` = legacy outputs schema (removed 2026-06-08)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Interaction", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": true, "events_ref": "streaming-events/gemini-interactions", "trigger": "body `stream: true`", "content_type": "text/event-stream", "note": "SSE with `event:` = event_type and `data:` JSON; terminal `event: done` / `data: [DONE]`. Resume with GET ?stream=true&last_event_id=..." }, "pagination": null, "idempotency": "not documented (no idempotency key)", "sdk": { "python": "client.interactions.create(model=..., input=..., stream=False|True, background=..., previous_interaction_id=..., agent=..., environment=..., agent_config=..., tools=..., response_format=..., generation_config=...)", "node": "ai.interactions.create({model, input, stream, background, previous_interaction_id, agent, environment, agent_config, tools, response_format, generation_config})", "java": "client.interactions.create(CreateInteractionRequestBody.of(CreateModelInteraction|CreateAgentInteraction))" }, "relations": [ "GET /v1beta/interactions/{id}", "POST /v1beta/interactions/{id}/cancel", "DELETE /v1beta/interactions/{id}", "POST /v1beta/agents", "POST /v1beta/credentials", "environments" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "h1 create (steps [thought, model_output], usage), h2 stream:true (SSE event:/data:, 9 events), h3 previous_interaction_id, h5 store:false (no id), h6 function tool → requires_action, h8 agent deep-research-preview-04-2026 background:true → in_progress; f2 tools[{type: computer_use, environment: browser}] accepted on gemini-3.5-flash-lite (tmp-live/gemini-tools/h*.json). Burst of ~10 calls/min → HTTP 429 too_many_requests observed once in pytest." }, "sources": [ { "url": "https://ai.google.dev/api/interactions", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/interactions-api", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/interactions-overview", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/streaming", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/background-execution", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "interactions", "method": "GET", "path": "/v1beta/interactions/{id}", "name": "Get interaction (poll or resume stream)", "description": "Retrieves the full details of a single interaction (full step timeline incl. `user_input`). Used to poll background interactions. With `?stream=true` the server streams the interaction as SSE; `last_event_id` resumes from the event after the given `event_id` (only with stream=true).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "api_version", "required": true }, { "name": "id", "required": true, "description": "Interaction.id (e.g. `v1_Chd...`)." } ], "query_params": [ { "name": "stream", "type": "boolean", "default": false, "description": "Stream the interaction incrementally as SSE." }, { "name": "last_event_id", "type": "string", "description": "Resume the stream after this event_id. Only with stream=true." } ], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Api-Revision", "required": false, "description": "Schema revision opt-in/out. `2026-05-20` = current steps/response_format schema (default since 2026-05-26); `2026-05-07` = legacy outputs schema (removed 2026-06-08)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Interaction", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": true, "events_ref": "streaming-events/gemini-interactions", "trigger": "query `stream=true` (+ `last_event_id`)", "note": "Reconnect/resume pattern for background interactions." }, "pagination": null, "idempotency": "safe (GET)", "sdk": { "python": "client.interactions.get(id=..., stream=False|True, last_event_id=...)", "node": "ai.interactions.get(id, {stream, last_event_id})" }, "relations": [ "POST /v1beta/interactions" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "h4: full Interaction incl. generation_config echo; after DELETE → 404 'Requested entity was not found'; ?include_steps=true → 400; unstored (store:false) interactions have no id" }, "sources": [ { "url": "https://ai.google.dev/api/interactions", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/background-execution", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "interactions", "method": "DELETE", "path": "/v1beta/interactions/{id}", "name": "Delete interaction", "description": "Deletes the stored interaction by id. Empty response body. Subsequent GET returns 404.", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "api_version", "required": true }, { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Empty ({})", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "idempotent by semantics (second call 404)", "sdk": { "python": "client.interactions.delete(id=...)", "node": "ai.interactions.delete(id)" }, "relations": [ "POST /v1beta/interactions" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "h9: → 200 {}" }, "sources": [ { "url": "https://ai.google.dev/api/interactions", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/background-execution", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "interactions", "method": "POST", "path": "/v1beta/interactions/{id}/cancel", "name": "Cancel interaction", "description": "Cancels an in-progress background interaction. Only applies to background interactions still running; status transitions to `cancelled` (may lag slightly in GET). Returns the Interaction. NOTE: one guide (antigravity-agent) shows the gRPC-transcoding form `POST /v1beta/interactions/{id}:cancel`; the reference uses `/{id}/cancel` — treat `:cancel` as UNVERIFIED alias.", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "api_version", "required": true }, { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Api-Revision", "required": false, "description": "Schema revision opt-in/out. `2026-05-20` = current steps/response_format schema (default since 2026-05-26); `2026-05-07` = legacy outputs schema (removed 2026-06-08)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Interaction", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "idempotent by semantics", "sdk": { "python": "client.interactions.cancel(id=...)", "node": "ai.interactions.cancel(id)" }, "relations": [ "POST /v1beta/interactions", "GET /v1beta/interactions/{id}" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "h8b: cancel of an in_progress deep-research background interaction → 200 status 'cancelled'; GET afterwards 'cancelled' (tmp-live/gemini-tools/h8b_deep_research_cancel.json)" }, "sources": [ { "url": "https://ai.google.dev/api/interactions", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/background-execution", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/antigravity-agent", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "interactions", "method": "POST", "path": "/v1/interactions", "name": "Create interaction (v1)", "description": "Stable v1 surface documented at ai.google.dev/api/interactions-api-v1 (smaller schema: no `environment`, `service_tier`, `webhook_config`, `agent_config` only `dynamic`, tools without mcp_server/computer_use). The v1 reference page itself renders `/v1beta/` URLs (documentation bug); the `/v1/interactions` path comes from the api-versions guide curl. Requires the SDK `http_options.api_version='v1'`.", "status": [ "DOCUMENTED", "GA", "UNVERIFIED" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com/v1 (stable)", "request": { "content_type": "application/json", "body_ref": "CreateInteractionRequest (v1 subset)", "path_params": [], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Interaction", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": true, "events_ref": "streaming-events/gemini-interactions", "note": "same InteractionSseEvent union (v1 page lists error, interaction.completed, interaction.created, interaction.status_update, step.delta, step.start, step.stop)" }, "pagination": null, "idempotency": null, "sdk": { "python": "genai.Client(http_options={'api_version': 'v1'}).interactions.", "node": "new GoogleGenAI({httpOptions: {apiVersion: 'v1'}}).interactions." }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/api/interactions-api-v1", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/api-versions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "interactions", "method": "GET", "path": "/v1/interactions/{id}", "name": "Get interaction (v1)", "description": "Stable v1 surface documented at ai.google.dev/api/interactions-api-v1 (smaller schema: no `environment`, `service_tier`, `webhook_config`, `agent_config` only `dynamic`, tools without mcp_server/computer_use). The v1 reference page itself renders `/v1beta/` URLs (documentation bug); the `/v1/interactions` path comes from the api-versions guide curl. Requires the SDK `http_options.api_version='v1'`.", "status": [ "DOCUMENTED", "GA", "UNVERIFIED" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com/v1 (stable)", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [ { "name": "stream" }, { "name": "last_event_id" } ], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Interaction", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": true, "events_ref": "streaming-events/gemini-interactions", "note": "same InteractionSseEvent union (v1 page lists error, interaction.completed, interaction.created, interaction.status_update, step.delta, step.start, step.stop)" }, "pagination": null, "idempotency": null, "sdk": { "python": "genai.Client(http_options={'api_version': 'v1'}).interactions.", "node": "new GoogleGenAI({httpOptions: {apiVersion: 'v1'}}).interactions." }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/api/interactions-api-v1", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/api-versions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "interactions", "method": "DELETE", "path": "/v1/interactions/{id}", "name": "Delete interaction (v1)", "description": "Stable v1 surface documented at ai.google.dev/api/interactions-api-v1 (smaller schema: no `environment`, `service_tier`, `webhook_config`, `agent_config` only `dynamic`, tools without mcp_server/computer_use). The v1 reference page itself renders `/v1beta/` URLs (documentation bug); the `/v1/interactions` path comes from the api-versions guide curl. Requires the SDK `http_options.api_version='v1'`.", "status": [ "DOCUMENTED", "GA", "UNVERIFIED" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com/v1 (stable)", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Empty", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": "streaming-events/gemini-interactions", "note": "same InteractionSseEvent union (v1 page lists error, interaction.completed, interaction.created, interaction.status_update, step.delta, step.start, step.stop)" }, "pagination": null, "idempotency": null, "sdk": { "python": "genai.Client(http_options={'api_version': 'v1'}).interactions.", "node": "new GoogleGenAI({httpOptions: {apiVersion: 'v1'}}).interactions." }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/api/interactions-api-v1", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/api-versions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "interactions", "method": "POST", "path": "/v1/interactions/{id}/cancel", "name": "Cancel interaction (v1)", "description": "Stable v1 surface documented at ai.google.dev/api/interactions-api-v1 (smaller schema: no `environment`, `service_tier`, `webhook_config`, `agent_config` only `dynamic`, tools without mcp_server/computer_use). The v1 reference page itself renders `/v1beta/` URLs (documentation bug); the `/v1/interactions` path comes from the api-versions guide curl. Requires the SDK `http_options.api_version='v1'`.", "status": [ "DOCUMENTED", "GA", "UNVERIFIED" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com/v1 (stable)", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Interaction", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": "streaming-events/gemini-interactions", "note": "same InteractionSseEvent union (v1 page lists error, interaction.completed, interaction.created, interaction.status_update, step.delta, step.start, step.stop)" }, "pagination": null, "idempotency": null, "sdk": { "python": "genai.Client(http_options={'api_version': 'v1'}).interactions.", "node": "new GoogleGenAI({httpOptions: {apiVersion: 'v1'}}).interactions." }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/api/interactions-api-v1", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/api-versions", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "credentials", "method": "POST", "path": "/v1beta/credentials", "name": "Create credential", "description": "Creates a server-managed secret (`bearer_token`, `oauth2`, `environment_variable`) referenced by id from environment network allowlists, `mcp_server` tools and `environment.env`. Secret fields are write-only. OAuth2 creation performs a live token exchange against `token_url`. `id` optional (UUID generated). 409/`aborted` if id exists. Field names must be snake_case (camelCase → 400).", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": "application/json", "body_ref": "EnvironmentVariableConfig | HttpBearerConfig | OAuth2Config (discriminator `type`)", "path_params": [], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Content-Type", "required": true, "description": "application/json" } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Credential (metadata only, secrets never returned)", "error_statuses": [ 400, 401, 403, 404, 409, 429, 500 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "no (duplicate id → 409 aborted)", "sdk": { "python": "client.credentials.create(id=..., type='bearer_token', token=...)", "node": "ai.credentials.create({id, type, token})" }, "relations": [ "POST /v1beta/interactions (environment.network.allowlist[].credential, tools[](mcp_server).credential, environment.env)" ], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/api/interactions", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/agent-credentials", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "credentials", "method": "GET", "path": "/v1beta/credentials", "name": "List credentials", "description": "Lists credentials for the project (metadata only).", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ { "name": "page_size", "type": "integer", "default": 50, "maximum": 1000 }, { "name": "page_token", "type": "string" } ], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ListCredentialsResponse {credentials[], next_page_token}", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request": [ "page_size", "page_token" ], "response": "next_page_token" }, "idempotency": "safe (GET)", "sdk": { "python": "client.credentials.list(page_size=...)", "node": "ai.credentials.list({page_size})" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/api/interactions", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/agent-credentials", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "credentials", "method": "GET", "path": "/v1beta/credentials/{id}", "name": "Get credential", "description": "Gets metadata of a single credential (no secret fields). 404 `not_found` if missing.", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Credential (metadata only, secrets never returned)", "error_statuses": [ 400, 401, 403, 404, 409, 429, 500 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (GET)", "sdk": { "python": "client.credentials.get(id=...)", "node": "ai.credentials.get(id)" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/api/interactions", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/agent-credentials", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "credentials", "method": "PATCH", "path": "/v1beta/credentials/{id}", "name": "Update (rotate) credential", "description": "Updates/rotates a credential. Body must carry the same `type` (type is fixed at creation) plus the fields to change (e.g. new `token`, `refresh_token`). Optional `update_mask` query. Rotation takes effect on next proxy resolution.", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": "application/json", "body_ref": "EnvironmentVariableUpdateConfig | HttpBearerUpdateConfig | OAuth2UpdateConfig", "path_params": [ { "name": "id", "required": true } ], "query_params": [ { "name": "update_mask", "type": "string", "description": "Optional. The list of fields to update." } ], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Content-Type", "required": true, "description": "application/json" } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Credential (metadata only, secrets never returned)", "error_statuses": [ 400, 401, 403, 404, 409, 429, 500 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "idempotent for same payload", "sdk": { "python": "client.credentials.update(id=..., type='bearer_token', token=...)", "node": "ai.credentials.update(id, {type, token})" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/api/interactions", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/agent-credentials", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "credentials", "method": "DELETE", "path": "/v1beta/credentials/{id}", "name": "Delete credential", "description": "Deletes a credential and its stored secret. Fails if referenced by active triggers. Returns `{}`.", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Empty ({})", "error_statuses": [ 400, 401, 403, 404, 409, 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "second call 404", "sdk": { "python": "client.credentials.delete(id=...)", "node": "ai.credentials.delete(id)" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/api/interactions", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/agent-credentials", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "agents", "method": "POST", "path": "/v1beta/agents", "name": "Create managed (custom) agent", "description": "Saves a reusable agent definition on top of a base managed agent (`base_agent`, currently only `antigravity-preview-09-2026` per the guide; reference examples use `antigravity-preview-05-2026`). Fields: id (unique, reserved prefixes forbidden: antigravity-, veo-, omni-, lyria-, imagen-, gemma-, gemini-, google-, youtube-, android-, chrome-, pixel-, waze-, fitbit-, nest-, kaggle-), description, agent_config {type: antigravity, model}, system_instruction, tools, base_environment ('remote' | env id | EnvironmentConfig). Invoke with `POST /v1beta/interactions {agent: }`. Max 1000 agents. No versioning.", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": "application/json", "body_ref": "Agent", "path_params": [], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Content-Type", "required": true, "description": "application/json" } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Agent", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "no (id must be unique)", "sdk": { "python": "client.agents.create(id=..., base_agent=..., system_instruction=..., base_environment={...}, agent_config={...}, tools=[...])", "node": "ai.agents.create({id, base_agent, system_instruction, base_environment, agent_config, tools})" }, "relations": [ "POST /v1beta/interactions (agent=)" ], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/api/interactions", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/custom-agents", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/managed-agents-quickstart", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "agents", "method": "GET", "path": "/v1beta/agents", "name": "List agents", "description": "Lists managed agents of the project (SDK exposes page_size/page_token).", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ { "name": "page_size", "type": "integer", "note": "from SDK ListAgentsParams" }, { "name": "page_token", "type": "string" } ], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "AgentListResponse {agents[], next_page_token?}", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token (per SDK)", "request": [ "page_size", "page_token" ] }, "idempotency": "safe (GET)", "sdk": { "python": "client.agents.list()", "node": "ai.agents.list()" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/custom-agents", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "agents", "method": "GET", "path": "/v1beta/agents/{id}", "name": "Get agent", "description": "Gets a managed agent definition.", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Agent", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (GET)", "sdk": { "python": "client.agents.get(id=...)", "node": "ai.agents.get(id)" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/custom-agents", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "agents", "method": "DELETE", "path": "/v1beta/agents/{id}", "name": "Delete agent", "description": "Deletes the agent configuration. Existing environments and interactions created by the agent are not affected.", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Empty", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "second call 404", "sdk": { "python": "client.agents.delete(id=...)", "node": "ai.agents.delete(id)" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/custom-agents", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "triggers", "method": "POST", "path": "/v1beta/triggers", "name": "Create trigger (cron-scheduled agent run)", "description": "Binds an agent interaction request (`interaction` = CreateInteractionRequest), a cron `schedule` and `time_zone` into a persistent resource that fires unattended; every execution reuses the same environment. Optional display_name, max_consecutive_failures (default 5 → auto-pause), execution_timeout_seconds (default 600). Starts `active`.", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": "application/json", "body_ref": "CreateTriggerRequest", "path_params": [], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Content-Type", "required": true, "description": "application/json" } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Trigger", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.triggers.create(schedule=..., time_zone=..., interaction={...})", "node": "ai.triggers.create({schedule, time_zone, interaction})" }, "relations": [ "POST /v1beta/interactions", "credentials" ], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/antigravity-agent", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "triggers", "method": "GET", "path": "/v1beta/triggers", "name": "List triggers", "description": "Lists all triggers of the project.", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ { "name": "page_size" }, { "name": "page_token" } ], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ListTriggersResponse", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token (per SDK)" }, "idempotency": "safe (GET)", "sdk": { "python": "client.triggers.list()", "node": "ai.triggers.list()" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/antigravity-agent", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "triggers", "method": "GET", "path": "/v1beta/triggers/{id}", "name": "Get trigger", "description": "Fetches full configuration and current state of a trigger.", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Trigger", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (GET)", "sdk": { "python": "client.triggers.get(id=...)", "node": "ai.triggers.get(id)" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/antigravity-agent", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "triggers", "method": "PATCH", "path": "/v1beta/triggers/{id}", "name": "Update trigger (pause / resume)", "description": "Updates a trigger; documented use is `{\"status\": \"paused\"}` / `{\"status\": \"active\"}`. Pausing does not affect manual executions.", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": "application/json", "body_ref": "UpdateTriggerRequest (status, ...)", "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Content-Type", "required": true, "description": "application/json" } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Trigger", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.triggers.update(id=..., status='paused')", "node": "ai.triggers.update(id, {status: 'paused'})" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/antigravity-agent", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "triggers", "method": "DELETE", "path": "/v1beta/triggers/{id}", "name": "Delete trigger", "description": "Permanently removes a trigger; past execution history is not deleted.", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Empty", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.triggers.delete(id=...)", "node": "ai.triggers.delete(id)" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/antigravity-agent", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "triggers", "method": "POST", "path": "/v1beta/triggers/{id}/executions", "name": "Run trigger now", "description": "Fires the trigger immediately (works even when paused). Returns a TriggerExecution.", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "TriggerExecution", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.triggers.run(trigger_id=...)", "node": "ai.triggers.run(trigger_id)" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/antigravity-agent", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "triggers", "method": "GET", "path": "/v1beta/triggers/{id}/executions", "name": "List trigger executions", "description": "Execution history: each execution has status, timestamps, `interaction_id` (fetch output via GET /interactions/{id}) and `environment_id`.", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [ { "name": "page_size" }, { "name": "page_token" } ], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ListTriggerExecutionsResponse", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (GET)", "sdk": { "python": "client.triggers.list_executions(trigger_id=...)", "node": "ai.triggers.listExecutions(trigger_id)" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/antigravity-agent", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "webhooks", "method": "POST", "path": "/v1/webhooks", "name": "Create webhook", "description": "Registers a webhook endpoint {name, uri, subscribed_events[]}. The signing secret is returned ONCE in the create response. Static project-level webhooks (WebhookService). Shared with Batch and video LROs; interaction events: interaction.requires_action, interaction.completed, interaction.failed, interaction.cancelled. Documented on the **/v1** prefix. Dynamic (per-request) webhooks use `webhook_config` on POST /v1beta/interactions instead.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com/v1 (per docs)", "request": { "content_type": "application/json", "body_ref": "CreateWebhookRequest {name, uri, subscribed_events[]}", "path_params": [], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Content-Type", "required": true, "description": "application/json" } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Webhook", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.webhooks.create(name=..., uri=..., subscribed_events=[...])", "node": "ai.webhooks.create({name, uri, subscribed_events})" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/webhooks", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "webhooks", "method": "GET", "path": "/v1/webhooks", "name": "List webhooks", "description": "Lists project webhooks. Static project-level webhooks (WebhookService). Shared with Batch and video LROs; interaction events: interaction.requires_action, interaction.completed, interaction.failed, interaction.cancelled. Documented on the **/v1** prefix. Dynamic (per-request) webhooks use `webhook_config` on POST /v1beta/interactions instead.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com/v1 (per docs)", "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "WebhookListResponse", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.webhooks.list()", "node": "ai.webhooks.list()" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/webhooks", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "webhooks", "method": "GET", "path": "/v1/webhooks/{id}", "name": "Get webhook", "description": "Gets a webhook. Static project-level webhooks (WebhookService). Shared with Batch and video LROs; interaction events: interaction.requires_action, interaction.completed, interaction.failed, interaction.cancelled. Documented on the **/v1** prefix. Dynamic (per-request) webhooks use `webhook_config` on POST /v1beta/interactions instead.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com/v1 (per docs)", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Webhook", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.webhooks.get(id=...)", "node": "ai.webhooks.get(id)" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/webhooks", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "webhooks", "method": "PATCH", "path": "/v1/webhooks/{id}", "name": "Update webhook", "description": "Updates e.g. `subscribed_events`. Static project-level webhooks (WebhookService). Shared with Batch and video LROs; interaction events: interaction.requires_action, interaction.completed, interaction.failed, interaction.cancelled. Documented on the **/v1** prefix. Dynamic (per-request) webhooks use `webhook_config` on POST /v1beta/interactions instead.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com/v1 (per docs)", "request": { "content_type": "application/json", "body_ref": "UpdateWebhookRequest", "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Content-Type", "required": true, "description": "application/json" } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Webhook", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.webhooks.update(id=..., subscribed_events=[...])", "node": "ai.webhooks.update(id, {subscribed_events})" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/webhooks", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "webhooks", "method": "DELETE", "path": "/v1/webhooks/{id}", "name": "Delete webhook", "description": "Deletes a webhook. Static project-level webhooks (WebhookService). Shared with Batch and video LROs; interaction events: interaction.requires_action, interaction.completed, interaction.failed, interaction.cancelled. Documented on the **/v1** prefix. Dynamic (per-request) webhooks use `webhook_config` on POST /v1beta/interactions instead.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com/v1 (per docs)", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Empty", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.webhooks.delete(id=...)", "node": "ai.webhooks.delete(id)" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/webhooks", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "webhooks", "method": "POST", "path": "/v1/webhooks/{id}/rotate_secret", "name": "Rotate webhook signing secret", "description": "Rotates the signing secret; body `{\"revocation_behavior\": \"REVOKE_PREVIOUS_SECRETS_AFTER_H24\"}`. Static project-level webhooks (WebhookService). Shared with Batch and video LROs; interaction events: interaction.requires_action, interaction.completed, interaction.failed, interaction.cancelled. Documented on the **/v1** prefix. Dynamic (per-request) webhooks use `webhook_config` on POST /v1beta/interactions instead.", "status": [ "DOCUMENTED", "BETA" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com/v1 (per docs)", "request": { "content_type": "application/json", "body_ref": "RotateSigningSecretRequest {revocation_behavior}", "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Content-Type", "required": true, "description": "application/json" } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "WebhookRotateSigningSecretResponse", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.webhooks.rotate_signing_secret(id=...)", "node": "ai.webhooks.rotateSigningSecret(id)" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/webhooks", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "webhooks", "method": "POST", "path": "/v1/webhooks/{id}:ping", "name": "Ping webhook (SDK-only)", "description": "Present in google-genai (`client.webhooks.ping`) and @google/genai (`webhooks.ping`) but not in the downloaded docs; exact REST path UNVERIFIED (guessed `:ping`).", "status": [ "UNVERIFIED", "DOCUMENTATION_INCOMPLETE" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "unknown (SDK-only)", "request": { "content_type": "application/json", "body_ref": "PingWebhookRequest", "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "WebhookPingResponse", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.webhooks.ping(id=...)", "node": "ai.webhooks.ping(id)" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/webhooks", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "environments", "method": "POST", "path": "/v1beta/environments", "name": "Create environment (sandbox)", "description": "Creates a managed Linux sandbox (Ubuntu, Python 3.12, Node 22; 4 vCPU / 16 GB) without starting an interaction. Body (REST page, snake_case): sources[], network (allowlist object | 'disabled'), from_environment (fork; sources/env must then be empty). Discovery doc (camelCase): sources, networkMode (DISABLED), networkAllowlist, fromEnvironment; flatPath `v1beta/environments:create` (custom verb) — REST page shows plain `POST /v1beta/environments`. Both forms recorded; UNVERIFIED which the server prefers.", "status": [ "DOCUMENTED", "BETA", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": "application/json", "body_ref": "CreateEnvironmentRequest", "path_params": [], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Content-Type", "required": true, "description": "application/json" } ], "alt_paths": [ "/v1beta/environments:create (discovery flatPath)" ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Environment", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.environments.create(...) (gaos: create_environment)", "node": "ai.environments.createEnvironment(body)" }, "relations": [ "POST /v1beta/interactions (environment=)", "PUT /upload/v1beta/environments/{environment}/files/{path}" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "env2: {} → 200 {id} (tmp-live/gemini-tools/env2_environment_create.json)" }, "sources": [ { "url": "https://ai.google.dev/api/environments", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/agent-environment", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "environments", "method": "GET", "path": "/v1beta/environments", "name": "List environments", "description": "Lists environments of the project. Query: REST page `page_size`/`page_token`; discovery doc `pageSize`/`pageToken` (guide curl uses `?pageSize=10`). Default 50, max 1000. Response {environments[], next_page_token|nextPageToken}. Discovery flatPath `v1beta/environments:list`.", "status": [ "DOCUMENTED", "BETA", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ { "name": "page_size", "alias": "pageSize", "type": "integer", "default": 50, "maximum": 1000 }, { "name": "page_token", "alias": "pageToken", "type": "string" } ], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ], "alt_paths": [ "/v1beta/environments:list (discovery flatPath)" ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ListEnvironmentsResponse", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token", "request": [ "page_size|pageSize", "page_token|pageToken" ], "response": "next_page_token|nextPageToken", "default_page_size": 50, "max_page_size": 1000 }, "idempotency": "safe (GET)", "sdk": { "python": "client.environments.list(page_size=10)", "node": "ai.environments.list({page_size}) / environments.listEnvironments()" }, "relations": [], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "env1: → 200 {} (no environments); discovery spelling GET /v1beta/environments:list → 200 too (env6)" }, "sources": [ { "url": "https://ai.google.dev/api/environments", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/agent-environment", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "environments", "method": "GET", "path": "/v1beta/environments/{id}", "name": "Get environment", "description": "Gets environment metadata (id, status active|expired, created/updated/last_accessed, file_count, size_bytes, sources, network). Discovery flatPath `v1beta/environments/{id}:get`.", "status": [ "DOCUMENTED", "BETA", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ], "alt_paths": [ "/v1beta/environments/{id}:get (discovery flatPath)" ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Environment", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (GET)", "sdk": { "python": "client.environments.get(id=...)", "node": "ai.environments.get(id) / environments.getEnvironment(id)" }, "relations": [], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "env3: {id, status: active, storage: {tier: free, project_used_bytes, project_limit_bytes: 1073741824}, file_count, size_bytes, created, updated}" }, "sources": [ { "url": "https://ai.google.dev/api/environments", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/agent-environment", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "environments", "method": "DELETE", "path": "/v1beta/environments/{id}", "name": "Delete environment", "description": "Explicitly terminates and deletes a sandbox (otherwise auto-deleted after 7 days idle TTL). Empty response. Discovery flatPath `v1beta/environments/{id}:delete`.", "status": [ "DOCUMENTED", "BETA", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "id", "required": true } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ], "alt_paths": [ "/v1beta/environments/{id}:delete (discovery flatPath)" ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "Empty", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.environments.delete(id=...)", "node": "ai.environments.delete(id) / environments.deleteEnvironment(id)" }, "relations": [], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "env5: → 200 {}" }, "sources": [ { "url": "https://ai.google.dev/api/environments", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/agent-environment", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "environments", "method": "GET", "path": "/v1beta/environments/{environment}/files/{path}", "name": "Get environment files (list directory / file metadata / download)", "description": "Multi-mode endpoint on the environment snapshot. Without `alt`: JSON `{files[]}` — directory listing (immediate children, or all descendants with `recursive=true`) or single-entry file metadata. With `?alt=media`: raw file bytes for a file, or a POSIX tar (not gzipped) for a directory (`recursive=true` to include subdirectories). Empty `{path}` (i.e. `GET /v1beta/environments/{environment}/files`) = workspace root. Discovery id `environments.files.media.download` (`useMediaDownloadService`). 404 `not_found` if path missing.", "status": [ "DOCUMENTED", "BETA", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "environment", "required": true, "description": "environment id (discovery `parent` = environments/{environment_id})" }, { "name": "path", "required": false, "description": "relative path in the workspace; empty = root" } ], "query_params": [ { "name": "alt", "enum": [ "media" ], "description": "Return content instead of JSON metadata." }, { "name": "recursive", "type": "boolean", "default": false }, { "name": "page_size", "type": "integer", "default": 100, "maximum": 1000 }, { "name": "page_token", "type": "string" } ], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/json | application/octet-stream | application/x-tar", "body_ref": "GetEnvironmentFilesResponse {files[], next_page_token} or raw bytes", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "page_token (directory listing)", "default_page_size": 100, "max_page_size": 1000 }, "idempotency": "safe (GET)", "sdk": { "python": "client.environments.files.list(environment=..., path=..., recursive=...) / client.environments.files.download(environment=..., path=...)", "node": "ai.environments.files.list({environment, path, recursive}) / ai.environments.files.download({environment, path})" }, "relations": [ "PUT /upload/v1beta/environments/{environment}/files/{path}" ], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "partial", "http_status": 200, "request_note": "env4: GET …/files/ on a fresh empty environment → 404 in the first run, 200 {} in the second (examples/gemini/interactions/environments.py); file download not exercised" }, "sources": [ { "url": "https://ai.google.dev/api/environments", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/agent-environment", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "environments", "method": "PUT", "path": "/upload/v1beta/environments/{environment}/files/{path}", "name": "Upload file / extract archive into environment", "description": "Creates or updates a file in the environment workspace (parent dirs auto-created). Simple upload: `PUT` raw bytes with `Content-Type`; query `overwrite=true` (else 409 Conflict if exists), `extract=true` (treat body as tar/tar.gz and unpack into `path`). Resumable protocol: `X-Goog-Upload-Protocol: resumable`, `X-Goog-Upload-Command: start`, `X-Goog-Upload-Header-Content-Length`, `X-Goog-Upload-Header-Content-Type` → session URL in `X-Goog-Upload-URL` (discovery path `/resumable/upload/v1beta/{+parent}/files/{+path}`). Max 2 GiB (discovery mediaUpload.maxSize). A PUT without the `/upload/` prefix returns 400.", "status": [ "DOCUMENTED", "BETA", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com/upload/v1beta (upload prefix)", "request": { "content_type": "*/* (file bytes) | multipart", "body_ref": "raw file bytes (+ UploadEnvironmentFileRequest {extract, overwrite} as query/metadata)", "path_params": [ { "name": "environment", "required": true }, { "name": "path", "required": true, "description": "destination relative path, e.g. workspace/src/main.py (trailing slash dir for extract)" } ], "query_params": [ { "name": "extract", "type": "boolean" }, { "name": "overwrite", "type": "boolean" } ], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Content-Type", "required": true, "description": "MIME of the uploaded bytes (e.g. text/plain, application/x-tar)" }, { "name": "X-Goog-Upload-Protocol", "required": false, "description": "`resumable` to start a resumable session" }, { "name": "X-Goog-Upload-Command", "required": false, "description": "`start`" }, { "name": "X-Goog-Upload-Header-Content-Length", "required": false }, { "name": "X-Goog-Upload-Header-Content-Type", "required": false } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "UploadEnvironmentFileResponse {files[]} (resumable start: empty body + X-Goog-Upload-URL header)", "error_statuses": [ 400, 401, 403, 404, 409, 413, 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "no (409 on existing file unless overwrite=true)", "sdk": { "python": "client.environments.files.upload(environment=..., path=..., file=f, mime_type=..., overwrite=True, extract=False)", "node": "ai.environments.files.upload({environment, path, file, mime_type, overwrite, extract})" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/api/environments", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/agent-environment", "retrieved_at": "2026-09-18" }, { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "environments", "method": "GET", "path": "/v1beta/files/environment-{environment}:download", "name": "Download environment snapshot (legacy Files API form)", "description": "Older documented way to download the whole sandbox as a tar: `GET /v1beta/files/environment-$ENV_ID:download?alt=media`. The environments guide now says to replace it with `GET /v1beta/environments/{id}/files?alt=media`. The quickstart still shows it (no SDK method).", "status": [ "DOCUMENTED", "LEGACY", "PREVIEW" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": null, "body_ref": null, "path_params": [ { "name": "environment", "required": true } ], "query_params": [ { "name": "alt", "enum": [ "media" ], "required": true } ], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." } ] }, "response": { "success_status": 200, "content_type": "application/x-tar", "body_ref": "tar archive", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "safe (GET)", "sdk": { "python": null, "node": null }, "relations": [ "GET /v1beta/environments/{environment}/files/{path}" ], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/managed-agents-quickstart", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/agent-environment", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "dynamic", "method": "POST", "path": "/v1beta/dynamic/{dynamicId}:generateContent", "name": "dynamic.generateContent", "description": "Generates a model response given a GenerateContentRequest against a `dynamic/*` resource. Discovery-doc-only resource (`generativelanguage.dynamic.*`, path `v1beta/{+model}:...` with `model` matching `^dynamic/[^/]+$`). Same GenerateContentRequest/GenerateContentResponse as models/*:generateContent. No guide or reference page explains what a `dynamic/{dynamicId}` resource is (likely the server-side counterpart of the `DynamicAgentConfig` / `agent_config.type=dynamic` in Interactions, or dynamic webhooks). DOCUMENTATION_INCOMPLETE — semantics unknown; the model list on this key contains no `dynamic/` entries.", "status": [ "DOCUMENTED", "BETA", "UNVERIFIED", "DOCUMENTATION_INCOMPLETE" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": "application/json", "body_ref": "GenerateContentRequest", "path_params": [ { "name": "model", "required": true, "pattern": "^dynamic/[^/]+$", "description": "Resource name `dynamic/{dynamicId}` (discovery description still says `models/{model}`)." } ], "query_params": [], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Content-Type", "required": true, "description": "application/json" } ] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "GenerateContentResponse", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.models.generate_content(model='dynamic/', ...) (untested)", "node": "ai.models.generateContent({model: 'dynamic/'}) (untested)" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "dynamic", "method": "POST", "path": "/v1beta/dynamic/{dynamicId}:streamGenerateContent", "name": "dynamic.streamGenerateContent", "description": "Streamed variant (`?alt=sse` for SSE, as for models) of dynamic.generateContent. Discovery-doc-only resource (`generativelanguage.dynamic.*`, path `v1beta/{+model}:...` with `model` matching `^dynamic/[^/]+$`). Same GenerateContentRequest/GenerateContentResponse as models/*:generateContent. No guide or reference page explains what a `dynamic/{dynamicId}` resource is (likely the server-side counterpart of the `DynamicAgentConfig` / `agent_config.type=dynamic` in Interactions, or dynamic webhooks). DOCUMENTATION_INCOMPLETE — semantics unknown; the model list on this key contains no `dynamic/` entries.", "status": [ "DOCUMENTED", "BETA", "UNVERIFIED", "DOCUMENTATION_INCOMPLETE" ], "auth": "x-goog-api-key header", "beta_header": null, "host": "https://generativelanguage.googleapis.com", "host_note": "generativelanguage.googleapis.com, version prefix in path", "request": { "content_type": "application/json", "body_ref": "GenerateContentRequest", "path_params": [ { "name": "model", "required": true, "pattern": "^dynamic/[^/]+$" } ], "query_params": [ { "name": "alt", "enum": [ "sse" ], "description": "SSE framing (as for models:streamGenerateContent)" } ], "header_params": [ { "name": "x-goog-api-key", "required": true, "description": "Gemini API key (never in the URL)." }, { "name": "Content-Type", "required": true, "description": "application/json" } ] }, "response": { "success_status": 200, "content_type": "application/json (chunked) | text/event-stream", "body_ref": "stream of GenerateContentResponse", "error_statuses": [ 400, 401, 403, 404, 429, 500, 503 ] }, "streaming": { "supported": true, "events_ref": "GenerateContentResponse chunks (not InteractionSseEvent)", "note": "same framing as models:streamGenerateContent" }, "pagination": null, "idempotency": null, "sdk": { "python": "client.models.generate_content_stream(model='dynamic/', ...) (untested)", "node": "ai.models.generateContentStream({model: 'dynamic/'}) (untested)" }, "relations": [], "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not exercised in the 2026-09-18 run (docs only)" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/api/all-methods", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "live", "method": "WSS", "path": "/ws/google.ai.generativelanguage.v1beta.GenerativeService.BidiGenerateContent", "name": "BidiGenerateContent", "description": "Gemini Live API: stateful bidirectional WebSocket session (audio/video/text in, native audio or text out, tool calls). Host wss://generativelanguage.googleapis.com. First message must be `setup`; server answers `setupComplete`; then clientContent/realtimeInput/toolResponse ↔ serverContent/toolCall/toolCallCancellation/usageMetadata/goAway/sessionResumptionUpdate. v1beta only. Connection lifetime ≈ 10 min (GoAway first); session limits 15 min audio / 2 min audio+video without contextWindowCompression.", "status": [ "DOCUMENTED", "PREVIEW", "LIVE_VERIFIED" ], "auth": "API key as URL query parameter `?key=YOUR_API_KEY` (documented raw-WebSocket form); SDKs send the key for you. Ephemeral tokens are NOT used on this URL — see BidiGenerateContentConstrained.", "beta_header": null, "request": { "content_type": "WebSocket text frames (JSON)", "body_ref": "BidiGenerateContentClientMessage = {setup | clientContent | realtimeInput | toolResponse}", "first_message": "setup (BidiGenerateContentSetup)" }, "response": { "content_type": "WebSocket text frames (JSON)", "body_ref": "BidiGenerateContentServerMessage = {usageMetadata?} + {setupComplete | serverContent | toolCall | toolCallCancellation | goAway | sessionResumptionUpdate}" }, "streaming": { "supported": true, "events_ref": "streaming-events/gemini-live" }, "pagination": null, "idempotency": null, "sdk": { "python": "async with client.aio.live.connect(model='gemini-3.8-live', config=types.LiveConnectConfig(...)) as session: await session.send_realtime_input(...); async for msg in session.receive(): ...", "node": "const session = await ai.live.connect({model, config, callbacks:{onopen,onmessage,onerror,onclose}}); session.sendRealtimeInput({...}); session.close()" }, "models": [ "gemini-3.8-live", "gemini-3.8-live-extended-thinking", "gemini-3.1-flash-live-preview", "gemini-2.5-flash-native-audio-preview-12-2025", "gemini-2.5-flash-native-audio-preview-09-2025", "gemini-2.5-flash-native-audio-latest", "gemini-3.5-live-translate-preview", "gemini-3.5-transcribe-live", "gemini-robotics-er-2-streaming-preview" ], "limits_documented": { "connection_lifetime": "≈10 minutes (GoAway before reset)", "session_audio_only": "15 minutes without compression", "session_audio_video": "2 minutes without compression", "context_window": "128k tokens native audio models / 32k other Live models", "resumption_handle_validity": "2 hours after last session termination", "transcribe_live_session": "10 minutes", "video_frame_rate": "≤ 1 FPS", "concurrent_sessions": "not documented in rate-limits page" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 101, "request_note": "j1/j4/j5: x-goog-api-key header on the handshake; gemini-2.5-flash-native-audio-latest, gemini-3.1-flash-live-preview and gemini-3.8-live ALL close 1007 on responseModalities [TEXT] ('not supported by the model'); AUDIO turn → setupComplete → serverContent… → turnComplete+usageMetadata; setup.toolConfig → close 1007 'Unknown name toolConfig'; toolCall received for a NON_BLOCKING declaration; ephemeral token on this method → close 1008 (tmp-live/gemini-tools/j*.json)" }, "sources": [ { "url": "https://ai.google.dev/api/live", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/live-api/get-started-websocket", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/live-api/session-management", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/live-api", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "live", "method": "WSS", "path": "/ws/google.ai.generativelanguage.v1beta.GenerativeService.BidiGenerateContentConstrained", "name": "BidiGenerateContentConstrained (ephemeral-token Live endpoint)", "description": "Same Live protocol, but authenticated with an ephemeral token minted by POST /v1beta/auth_tokens; the token's locked BidiGenerateContentSetup / liveConnectConstraints constrain the session (client setup fields overwritten per fieldMask). Client-to-server (browser/mobile) usage. v1beta only.", "status": [ "DOCUMENTED", "PREVIEW", "LIVE_VERIFIED" ], "auth": "Ephemeral token via query `?access_token=` (documented) or header `Authorization: Token ` (reference); SDK: new GoogleGenAI({apiKey: token.name}) with httpOptions apiVersion 'v1beta'.", "beta_header": null, "request": { "content_type": "WebSocket text frames (JSON)", "body_ref": "BidiGenerateContentClientMessage" }, "response": { "content_type": "WebSocket text frames (JSON)", "body_ref": "BidiGenerateContentServerMessage" }, "streaming": { "supported": true, "events_ref": "streaming-events/gemini-live" }, "pagination": null, "idempotency": null, "sdk": { "python": "genai.Client(api_key=token.name, http_options={'api_version':'v1beta'}).aio.live.connect(...)", "node": "new GoogleGenAI({apiKey: token.name, httpOptions:{apiVersion:'v1beta'}}).live.connect({model, config, callbacks})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 101, "request_note": "j9a/j9b/j9c on the v1alpha spelling: Authorization: Token header AND ?access_token= query both reached setupComplete → turnComplete; a setup-locked token also worked (docs: v1alpha for ephemeral tokens; SDK uses v1alpha + this method)" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/live-api/get-started-websocket", "retrieved_at": "2026-09-18", "note": "URL with ?access_token=" }, { "url": "https://ai.google.dev/api/live", "retrieved_at": "2026-09-18", "note": "Ephemeral authentication tokens: access_token query param or Authorization: Token" }, { "url": "https://ai.google.dev/gemini-api/docs/live-api/ephemeral-tokens", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "live", "method": "WSS", "path": "/ws/google.ai.generativelanguage.v1alpha.GenerativeService.BidiGenerateContent", "name": "BidiGenerateContent (v1alpha URL variant)", "description": "v1alpha WebSocket URL appears once in the Live thinking guide's protocol comparison (`...v1alpha.GenerativeService.BidiGenerateContent?key=$API_KEY`). All other pages (reference, WebSocket guide, ephemeral tokens) use v1beta and state ephemeral tokens work only with v1beta. Treat v1alpha as legacy/undocumented for new work.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "?key=API_KEY (query)", "beta_header": null, "request": { "content_type": "WebSocket text frames (JSON)", "body_ref": "BidiGenerateContentClientMessage" }, "response": { "content_type": "WebSocket text frames (JSON)", "body_ref": "BidiGenerateContentServerMessage" }, "streaming": { "supported": true, "events_ref": "streaming-events/gemini-live" }, "pagination": null, "idempotency": null, "sdk": { "python": "genai.Client(http_options={'api_version':'v1alpha'})", "node": "new GoogleGenAI({httpOptions:{apiVersion:'v1alpha'}})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "j8a/j8b: ephemeral token on the plain v1alpha BidiGenerateContent method → close 1008 'Method doesn't allow unregistered callers'; use …BidiGenerateContentConstrained instead" }, "sources": [ { "url": "https://ai.google.dev/gemini-api/docs/live-api/thinking", "retrieved_at": "2026-09-18", "note": "Step 1: Session setup URL uses v1alpha" }, { "url": "https://ai.google.dev/api/live", "retrieved_at": "2026-09-18", "note": "Note: The URL is for version v1beta" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "auth-tokens", "method": "POST", "path": "/v1beta/auth_tokens", "name": "auth_tokens.create (ephemeral token)", "description": "Creates a short-lived token constraining a BidiGenerateContent session (Live API only). Body = AuthToken {uses, expireTime, newSessionExpireTime, fieldMask, bidiGenerateContentSetup} (discovery) — official curl examples use `liveConnectConstraints: {model, config}` instead. Response = AuthToken with `name` = the token string to hand to the client. Defaults: uses 1, expireTime +30 min, newSessionExpireTime +60 s; both < 20 h. Resuming a session does not consume a use; sessionResumption is needed to reconnect every ~10 min within expireTime.", "status": [ "DOCUMENTED", "PREVIEW", "LIVE_VERIFIED" ], "auth": "x-goog-api-key: (server side only)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "AuthToken (CreateAuthTokenRequest.authToken)", "example": { "uses": 1, "expireTime": "2026-09-18T20:30:00Z", "newSessionExpireTime": "2026-09-18T20:01:00Z", "liveConnectConstraints": { "model": "models/gemini-3.8-live", "config": { "sessionResumption": {}, "responseModalities": [ "AUDIO" ] } } } }, "response": { "content_type": "application/json", "body_ref": "AuthToken", "fields": [ "name (the token)", "expireTime?", "newSessionExpireTime?", "uses?" ], "note": "Exact response body not shown in docs beyond token.name — parent agent to capture." }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.auth_tokens.create(config={'uses':1,'expire_time':..., 'new_session_expire_time':..., 'live_connect_constraints':{'model':'gemini-3.8-live','config':{...}}, 'lock_additional_fields':[...]}) -> token.name", "node": "await client.authTokens.create({config:{uses:1, expireTime, newSessionExpireTime, liveConnectConstraints:{model, config}}}) -> token.name" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "i: {uses:1, expireTime, newSessionExpireTime} → 200 {name: auth_tokens/…} on BOTH /v1alpha and /v1beta; with bidiGenerateContentSetup{model, generationConfig} lock → 200 (j9c). Token redacted in tmp-live/gemini-tools/i_auth_token_*.json" }, "sources": [ { "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta", "retrieved_at": "2026-09-18", "note": "resources.auth_tokens.methods.create: POST v1beta/auth_tokens, request/response AuthToken" }, { "url": "https://ai.google.dev/api/live", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/live-api/ephemeral-tokens", "retrieved_at": "2026-09-18" }, { "url": "https://ai.google.dev/gemini-api/docs/ephemeral-tokens", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "gemini", "api_family": "interactions", "method": "GET", "path": "/v1beta/interactions", "name": "List interactions (probe)", "description": "Not documented. Probed 2026-09-18: HTTP 404 (empty error body). Interactions are retrieved individually by id; there is no documented list endpoint.", "status": [ "UNVERIFIED", "FAILED_VERIFICATION" ], "auth": "x-goog-api-key header", "beta_header": null, "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [], "header_params": [] }, "response": { "success_status": null, "content_type": null, "body_ref": null, "error_statuses": [ 404 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": null, "node": null }, "relations": [], "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "h0: GET /v1beta/interactions → 404 with empty body" }, "sources": [ { "url": "https://ai.google.dev/api/interactions", "retrieved_at": "2026-09-18", "note": "no list method documented" } ], "_fragment": "generated/fragments/endpoints/gemini-tools-agents-live.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/admin_api_keys", "name": "List all organization and project API keys.", "operation_id": "admin-api-keys-list", "tags": [], "description": "List organization API keys", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ApiKeyList", "object": "list", "fields": [ "object", "data", "has_more", "first_id", "last_id" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.admin_api_key\",\n \"id\": \"key_abc\",\n \"name\": \"Main Admin Key\",\n \"redacted_value\": \"sk-admin...def\",\n \"created_at\": 1711471533,\n \"expires_at\": 1714063533,\n \"last_used_at\": 1711471534,\n \"owner\": {\n \"type\": \"service_account\",\n \"object\": \"organization.service_account\",\n \"id\": \"sa_456\",\n \"name\": \"My Service Account\",\n \"created_at\": 1711471533,\n \"role\": \"member\"\n }\n }\n ],\n \"first_id\": \"key_abc\",\n \"last_id\": \"key_abc\",\n \"has_more\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.admin_api_keys.list(**params) -> SyncCursorPage[AdminAPIKey]", "node": "client.admin.organization.adminAPIKeys.list({ ...params }) -> AdminAPIKeysPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/admin_api_keys?after=key_abc&limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "project key -> 403: You have insufficient permissions for this operation. Missing scopes: api.management.read. Check that you have the correct role in your organization, and if you're using a restricted API key, that it has the necessary scopes." }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/admin_api_keys", "name": "Create admin API key", "operation_id": "admin-api-keys-create", "tags": [], "description": "Create an organization admin API key", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "inline" }, "response": { "status": 200, "schema_ref": "AdminApiKeyCreateResponse", "object": "organization.admin_api_key", "fields": [ "object", "id", "name", "redacted_value", "created_at", "expires_at", "last_used_at", "owner", "value" ], "example": "{\n \"object\": \"organization.admin_api_key\",\n \"id\": \"key_xyz\",\n \"name\": \"New Admin Key\",\n \"redacted_value\": \"sk-admin...xyz\",\n \"created_at\": 1711471533,\n \"expires_at\": 1714063533,\n \"last_used_at\": 1711471534,\n \"owner\": {\n \"type\": \"user\",\n \"object\": \"organization.user\",\n \"id\": \"user_123\",\n \"name\": \"John Doe\",\n \"created_at\": 1711471533,\n \"role\": \"owner\"\n },\n \"value\": \"sk-admin-1234abcd\"\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.admin_api_keys.create(**params) -> AdminAPIKeyCreateResponse", "node": "client.admin.organization.adminAPIKeys.create({ ...params }) -> AdminAPIKeyCreateResponse" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/admin_api_keys \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"New Admin Key\",\n \"expires_in_seconds\": 2592000\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/admin_api_keys/{key_id}", "name": "Retrieve admin API key", "operation_id": "admin-api-keys-get", "tags": [], "description": "Retrieve a single organization API key", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "AdminApiKey", "object": "organization.admin_api_key", "fields": [ "object", "id", "name", "redacted_value", "created_at", "expires_at", "last_used_at", "owner" ], "example": "{\n \"object\": \"organization.admin_api_key\",\n \"id\": \"key_abc\",\n \"name\": \"Main Admin Key\",\n \"redacted_value\": \"sk-admin...xyz\",\n \"created_at\": 1711471533,\n \"last_used_at\": 1711471534,\n \"owner\": {\n \"type\": \"user\",\n \"object\": \"organization.user\",\n \"id\": \"user_123\",\n \"name\": \"John Doe\",\n \"created_at\": 1711471533,\n \"role\": \"owner\"\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.admin_api_keys.retrieve(key_id) -> AdminAPIKey", "node": "client.admin.organization.adminAPIKeys.retrieve(keyID) -> AdminAPIKey" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/admin_api_keys/key_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/admin_api_keys/{key_id}", "name": "Delete admin API key", "operation_id": "admin-api-keys-delete", "tags": [], "description": "Delete an organization admin API key", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": null, "object": "organization.admin_api_key.deleted", "fields": [ "id", "object", "deleted" ], "example": "{\n \"id\": \"key_abc\",\n \"object\": \"organization.admin_api_key.deleted\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.admin_api_keys.delete(key_id) -> AdminAPIKeyDeleteResponse", "node": "client.admin.organization.adminAPIKeys.delete(keyID) -> AdminAPIKeyDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/admin_api_keys/key_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/audit_logs", "name": "List audit logs", "operation_id": "list-audit-logs", "tags": [ "Audit Logs" ], "description": "List user actions and configuration changes within this organization.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.audit_logs.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ListAuditLogsResponse", "object": "list", "fields": [ "object", "data", "first_id", "last_id", "has_more" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"audit_log-xxx_yyyymmdd\",\n \"type\": \"project.archived\",\n \"effective_at\": 1722461446,\n \"actor\": {\n \"type\": \"api_key\",\n \"api_key\": {\n \"type\": \"user\",\n \"user\": {\n \"id\": \"user-xxx\",\n \"email\": \"user@example.com\"\n }\n }\n },\n \"project.archived\": {\n \"id\": \"proj_abc\"\n },\n },\n {\n \"id\": \"audit_log-yyy__20240101\",\n \"type\": \"api_key.updated\",\n \"effective_at\": 1720804190,\n \"actor\": {\n \"type\": \"session\",\n \"session\": {\n \"user\": {\n \"id\": \"user-xxx\",\n \"email\": \"user@example.com\"\n },\n \"ip_address\": \"127.0.0.1\",\n \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36\",\n \"ja3\": \"a497151ce4338a12c4418c44d375173e\",\n \"ja4\": \"q13d0313h3_55b375c5d22e_c7319ce65786\",\n \"ip_address_details\": {\n \"country\": \"US\",\n \"city\": \"San Francisco\",\n \"region\": \"California\",\n \"region_code\": \"CA\",\n \"asn\": \"1234\",\n \"latitude\": \"37.77490\",\n \"longitude\": \"-122.41940\"\n }\n }\n },\n \"api_key.updated\": {\n \"id\": \"key_xxxx\",\n \"data\": {\n \"scopes\": [\"resource_2.operation_2\"]\n }\n },\n }\n ],\n \"first_id\": \"audit_log-xxx__20240101\",\n \"last_id\": \"audit_log_yyy__20240101\",\n \"has_more\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "before" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.audit_logs.list(**params) -> SyncConversationCursorPage[AuditLogListResponse]", "node": "client.admin.organization.auditLogs.list({ ...params }) -> AuditLogListResponsesPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/audit_logs \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "project key -> 401: You have insufficient permissions for this operation. Missing scopes: api.audit_logs.read. Check that you have the correct role in your organization, and if you're using a restricted API key, that it has the necessary scopes." }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/certificates", "name": "List organization certificates", "operation_id": "listOrganizationCertificates", "tags": [ "Certificates" ], "description": "List uploaded certificates for this organization.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.mtls.read" ], "documented_scopes": [ "api.mtls.read" ], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ListCertificatesResponse", "object": "list", "fields": [ "data", "first_id", "last_id", "has_more", "object" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"active\": true,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n ],\n \"first_id\": \"cert_abc\",\n \"last_id\": \"cert_abc\",\n \"has_more\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.certificates.list(**params) -> SyncConversationCursorPage[CertificateListResponse]", "node": "client.admin.organization.certificates.list({ ...params }) -> CertificateListResponsesPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/certificates \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\"\n" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "project key -> 403: You have insufficient permissions for this operation. Missing scopes: api.mtls.read. Check that you have the correct role in your organization (Owner), and if you're using a restricted API key, that it has the necessary scopes." }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/certificates", "name": "Upload certificate", "operation_id": "uploadCertificate", "tags": [ "Certificates" ], "description": "Upload a certificate to the organization. This does **not** automatically activate the certificate. Organizations can upload up to 50 certificates.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [ "api.mtls.write" ], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "UploadCertificateRequest" }, "response": { "status": 200, "schema_ref": "Certificate", "object": "certificate", "fields": [ "object", "id", "name", "created_at", "certificate_details", "active" ], "example": "{\n \"object\": \"certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.certificates.create(**params) -> Certificate", "node": "client.admin.organization.certificates.create({ ...params }) -> Certificate" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/certificates \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"name\": \"My Example Certificate\",\n \"certificate\": \"-----BEGIN CERTIFICATE-----\\\\nMIIDeT...\\\\n-----END CERTIFICATE-----\"\n}'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/certificates/activate", "name": "Activate certificates for organization", "operation_id": "activateOrganizationCertificates", "tags": [ "Certificates" ], "description": "Activate certificates at the organization level. You can atomically and idempotently activate up to 10 certificates at a time.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [ "api.mtls.write" ], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ToggleCertificatesRequest" }, "response": { "status": 200, "schema_ref": "OrganizationCertificateActivationResponse", "object": "organization.certificate.activation", "fields": [ "object", "data" ], "example": "{\n \"object\": \"organization.certificate.activation\",\n \"data\": [\n {\n \"object\": \"organization.certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"active\": true,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n {\n \"object\": \"organization.certificate\",\n \"id\": \"cert_def\",\n \"name\": \"My Example Certificate 2\",\n \"active\": true,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n ],\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.certificates.activate(**params) -> SyncPage[CertificateActivateResponse]", "node": "client.admin.organization.certificates.activate({ ...params }) -> CertificateActivateResponsesPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/certificates/activate \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"certificate_ids\": [\"cert_abc\", \"cert_def\"]\n}'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/certificates/deactivate", "name": "Deactivate certificates for organization", "operation_id": "deactivateOrganizationCertificates", "tags": [ "Certificates" ], "description": "Deactivate certificates at the organization level. You can atomically and idempotently deactivate up to 10 certificates at a time.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [ "api.mtls.write" ], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ToggleCertificatesRequest" }, "response": { "status": 200, "schema_ref": "OrganizationCertificateDeactivationResponse", "object": "organization.certificate.deactivation", "fields": [ "object", "data" ], "example": "{\n \"object\": \"organization.certificate.deactivation\",\n \"data\": [\n {\n \"object\": \"organization.certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"active\": false,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n {\n \"object\": \"organization.certificate\",\n \"id\": \"cert_def\",\n \"name\": \"My Example Certificate 2\",\n \"active\": false,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n ],\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.certificates.deactivate(**params) -> SyncPage[CertificateDeactivateResponse]", "node": "client.admin.organization.certificates.deactivate({ ...params }) -> CertificateDeactivateResponsesPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/certificates/deactivate \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"certificate_ids\": [\"cert_abc\", \"cert_def\"]\n}'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/certificates/{certificate_id}", "name": "Get certificate", "operation_id": "getCertificate", "tags": [ "Certificates" ], "description": "Get a certificate that has been uploaded to the organization. You can get a certificate regardless of whether it is active or not.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.mtls.read" ], "documented_scopes": [ "api.mtls.read" ], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "Certificate", "object": "certificate", "fields": [ "object", "id", "name", "created_at", "certificate_details", "active" ], "example": "{\n \"object\": \"certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 1234567,\n \"expires_at\": 12345678,\n \"content\": \"-----BEGIN CERTIFICATE-----MIIDeT...-----END CERTIFICATE-----\"\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.certificates.retrieve(certificate_id, **params) -> Certificate", "node": "client.admin.organization.certificates.retrieve(certificateID, { ...params }) -> Certificate" }, "examples": { "curl": "curl \"https://api.openai.com/v1/organization/certificates/cert_abc?include[]=content\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/certificates/{certificate_id}", "name": "Modify certificate", "operation_id": "modifyCertificate", "tags": [ "Certificates" ], "description": "Modify a certificate. Note that only the name can be modified.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [ "api.mtls.write" ], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ModifyCertificateRequest" }, "response": { "status": 200, "schema_ref": "Certificate", "object": "certificate", "fields": [ "object", "id", "name", "created_at", "certificate_details", "active" ], "example": "{\n \"object\": \"certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"Renamed Certificate\",\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.certificates.update(certificate_id, **params) -> Certificate", "node": "client.admin.organization.certificates.update(certificateID, { ...params }) -> Certificate" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/certificates/cert_abc \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"name\": \"Renamed Certificate\"\n}'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/certificates/{certificate_id}", "name": "Delete certificate", "operation_id": "deleteCertificate", "tags": [ "Certificates" ], "description": "Delete a certificate from the organization. The certificate must be inactive for the organization and all projects.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [ "api.mtls.write" ], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "DeleteCertificateResponse", "object": "certificate.deleted", "fields": [ "object", "id" ], "example": "{\n \"object\": \"certificate.deleted\",\n \"id\": \"cert_abc\"\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.certificates.delete(certificate_id) -> CertificateDeleteResponse", "node": "client.admin.organization.certificates.delete(certificateID) -> CertificateDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/certificates/cert_abc \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/costs", "name": "Costs", "operation_id": "usage-costs", "tags": [ "Usage" ], "description": "Get costs details for the organization.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.usage.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "UsageResponse", "object": "page", "fields": [ "object", "data", "has_more", "next_page" ], "example": "{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.costs.result\",\n \"amount\": {\n \"value\": 0.06,\n \"currency\": \"usd\"\n },\n \"line_item\": null,\n \"project_id\": null,\n \"api_key_id\": null,\n \"quantity\": null,\n \"quantity_unit\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "page" ], "response_fields": [ "next_page", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.usage.costs(**params) -> UsageCostsResponse", "node": "client.admin.organization.usage.costs({ ...params }) -> UsageCostsResponse" }, "examples": { "curl": "curl \"https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "project key -> 403: You have insufficient permissions for this operation. Missing scopes: api.usage.read. Check that you have the correct role in your organization, and if you're using a restricted API key, that it has the necessary scopes." }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/data_retention", "name": "Retrieve organization data retention", "operation_id": "retrieve-organization-data-retention", "tags": [ "Data retention" ], "description": "Retrieves organization data retention controls.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "OrganizationDataRetention", "object": "organization.data_retention", "fields": [ "object", "type" ], "example": "{\n \"object\": \"organization.data_retention\",\n \"type\": \"modified_abuse_monitoring\"\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.data_retention.retrieve() -> OrganizationDataRetention", "node": "client.admin.organization.dataRetention.retrieve() -> OrganizationDataRetention" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/data_retention \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "project key -> 403: You have insufficient permissions for this operation. Missing scopes: api.management.read. Check that you have the correct role in your organization, and if you're using a restricted API key, that it has the necessary scopes." }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/data_retention", "name": "Update organization data retention", "operation_id": "update-organization-data-retention", "tags": [ "Data retention" ], "description": "Updates organization data retention controls.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "UpdateOrganizationDataRetentionBody" }, "response": { "status": 200, "schema_ref": "OrganizationDataRetention", "object": "organization.data_retention", "fields": [ "object", "type" ], "example": "{\n \"object\": \"organization.data_retention\",\n \"type\": \"modified_abuse_monitoring\"\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.data_retention.update(**params) -> OrganizationDataRetention", "node": "client.admin.organization.dataRetention.update({ ...params }) -> OrganizationDataRetention" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/data_retention \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"retention_type\": \"modified_abuse_monitoring\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/groups", "name": "List groups", "operation_id": "list-groups", "tags": [ "Groups" ], "description": "Lists all groups in the organization.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.groups.read" ], "documented_scopes": [ "api.groups.read" ], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "GroupListResource", "object": "list", "fields": [ "object", "data", "has_more", "next" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"group\",\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Support Team\",\n \"created_at\": 1711471533,\n \"is_scim_managed\": false\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.groups.list(**params) -> SyncNextCursorPage[Group]", "node": "client.admin.organization.groups.list({ ...params }) -> GroupsPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/groups?limit=20&order=asc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "project key -> 403: You have insufficient permissions for this operation. Missing scopes: api.groups.read. Check that you have the correct role in your organization, and if you're using a restricted API key, that it has the necessary scopes." }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/groups", "name": "Create group", "operation_id": "create-group", "tags": [ "Groups" ], "description": "Creates a new group in the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [ "api.groups.write" ], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateGroupBody" }, "response": { "status": 200, "schema_ref": "GroupResponse", "object": null, "fields": [ "id", "name", "created_at", "is_scim_managed", "group_type" ], "example": "{\n \"object\": \"group\",\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Support Team\",\n \"created_at\": 1711471533,\n \"is_scim_managed\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.groups.create(**params) -> Group", "node": "client.admin.organization.groups.create({ ...params }) -> Group" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/groups \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Support Team\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/create", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/groups/{group_id}", "name": "Retrieve group", "operation_id": "retrieve-group", "tags": [ "Groups" ], "description": "Retrieves a group.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.groups.read" ], "documented_scopes": [ "api.groups.read" ], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "GroupResponse", "object": null, "fields": [ "id", "name", "created_at", "is_scim_managed", "group_type" ], "example": "{\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Support Team\",\n \"created_at\": 1711471533,\n \"is_scim_managed\": false,\n \"group_type\": \"group\"\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.groups.retrieve(group_id) -> Group", "node": "client.admin.organization.groups.retrieve(groupID) -> Group" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/groups/{group_id}", "name": "Update group", "operation_id": "update-group", "tags": [ "Groups" ], "description": "Updates a group's information.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [ "api.groups.write" ], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "UpdateGroupBody" }, "response": { "status": 200, "schema_ref": "GroupResourceWithSuccess", "object": null, "fields": [ "id", "name", "created_at", "is_scim_managed" ], "example": "{\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Escalations\",\n \"created_at\": 1711471533,\n \"is_scim_managed\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.groups.update(group_id, **params) -> GroupUpdateResponse", "node": "client.admin.organization.groups.update(groupID, { ...params }) -> GroupUpdateResponse" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Escalations\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/update", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/groups/{group_id}", "name": "Delete group", "operation_id": "delete-group", "tags": [ "Groups" ], "description": "Deletes a group from the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [ "api.groups.write" ], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "GroupDeletedResource", "object": "group.deleted", "fields": [ "object", "id", "deleted" ], "example": "{\n \"object\": \"group.deleted\",\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.groups.delete(group_id) -> GroupDeleteResponse", "node": "client.admin.organization.groups.delete(groupID) -> GroupDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/delete", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/groups/{group_id}/roles", "name": "List group organization role assignments", "operation_id": "list-group-role-assignments", "tags": [ "Group organization role assignments" ], "description": "Lists the organization roles assigned to a group within the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.roles.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "RoleListResource", "object": "list", "fields": [ "object", "data", "has_more", "next" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false,\n \"description\": \"Allows managing organization groups\",\n \"created_at\": 1711471533,\n \"updated_at\": 1711472599,\n \"created_by\": \"user_abc123\",\n \"created_by_user_obj\": {\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\"\n },\n \"metadata\": {}\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.groups.roles.list(group_id, **params) -> SyncNextCursorPage[RoleListResponse]", "node": "client.admin.organization.groups.roles.list(groupID, { ...params }) -> RoleListResponsesPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/groups/{group_id}/roles", "name": "Assign organization role to group", "operation_id": "assign-group-role", "tags": [ "Group organization role assignments" ], "description": "Assigns an organization role to a group within the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "PublicAssignOrganizationGroupRoleBody" }, "response": { "status": 200, "schema_ref": "GroupRoleAssignment", "object": "group.role", "fields": [ "object", "group", "role" ], "example": "{\n \"object\": \"group.role\",\n \"group\": {\n \"object\": \"group\",\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Support Team\",\n \"created_at\": 1711471533,\n \"scim_managed\": false\n },\n \"role\": {\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.groups.roles.create(group_id, **params) -> RoleCreateResponse", "node": "client.admin.organization.groups.roles.create(groupID, { ...params }) -> RoleCreateResponse" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_id\": \"role_01J1F8ROLE01\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/groups/{group_id}/roles/{role_id}", "name": "Retrieve group organization role", "operation_id": "retrieve-group-role", "tags": [ "Group organization role assignments" ], "description": "Retrieves an organization role assigned to a group.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.roles.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "AssignedRoleDetails", "object": null, "fields": [ "id", "name", "permissions", "resource_type", "predefined_role", "description", "created_at", "updated_at", "created_by", "created_by_user_obj", "metadata", "assignment_sources" ], "example": "{\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false,\n \"description\": \"Allows managing organization groups\",\n \"created_at\": 1711471533,\n \"updated_at\": 1711472599,\n \"created_by\": \"user_abc123\",\n \"created_by_user_obj\": null,\n \"metadata\": {},\n \"assignment_sources\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.groups.roles.retrieve(role_id, *, group_id) -> RoleRetrieveResponse", "node": "client.admin.organization.groups.roles.retrieve(roleID, { ...params }) -> RoleRetrieveResponse" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/roles/role_01J1F8ROLE01 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/groups/{group_id}/roles/{role_id}", "name": "Unassign organization role from group", "operation_id": "unassign-group-role", "tags": [ "Group organization role assignments" ], "description": "Unassigns an organization role from a group within the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "DeletedRoleAssignmentResource", "object": null, "fields": [ "object", "deleted" ], "example": "{\n \"object\": \"group.role.deleted\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.groups.roles.delete(role_id, *, group_id) -> RoleDeleteResponse", "node": "client.admin.organization.groups.roles.delete(roleID, { ...params }) -> RoleDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/roles/role_01J1F8ROLE01 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/groups/{group_id}/users", "name": "List group users", "operation_id": "list-group-users", "tags": [ "Group users" ], "description": "Lists the users assigned to a group.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.groups.read" ], "documented_scopes": [ "api.groups.read" ], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "UserListResource", "object": "list", "fields": [ "object", "data", "has_more", "next" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\"\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.groups.users.list(group_id, **params) -> SyncNextCursorPage[OrganizationGroupUser]", "node": "client.admin.organization.groups.users.list(groupID, { ...params }) -> OrganizationGroupUsersPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/users?limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/groups/{group_id}/users", "name": "Add group user", "operation_id": "add-group-user", "tags": [ "Group users" ], "description": "Adds a user to a group.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [ "api.groups.write" ], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateGroupUserBody" }, "response": { "status": 200, "schema_ref": "GroupUserAssignment", "object": "group.user", "fields": [ "object", "user_id", "group_id" ], "example": "{\n \"object\": \"group.user\",\n \"user_id\": \"user_abc123\",\n \"group_id\": \"group_01J1F8ABCDXYZ\"\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.groups.users.create(group_id, **params) -> UserCreateResponse", "node": "client.admin.organization.groups.users.create(groupID, { ...params }) -> UserCreateResponse" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/users \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"user_id\": \"user_abc123\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/create", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/groups/{group_id}/users/{user_id}", "name": "Retrieve group user", "operation_id": "retrieve-group-user", "tags": [ "Group users" ], "description": "Retrieves a user in a group.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.groups.read" ], "documented_scopes": [ "api.groups.read" ], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "GroupMemberUser", "object": null, "fields": [ "id", "name", "email", "picture", "is_service_account", "user_type" ], "example": "{\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"picture\": null,\n \"is_service_account\": false,\n \"user_type\": \"user\"\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.groups.users.retrieve(user_id, *, group_id) -> UserRetrieveResponse", "node": "client.admin.organization.groups.users.retrieve(userID, { ...params }) -> UserRetrieveResponse" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/users/user_abc123 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/groups/{group_id}/users/{user_id}", "name": "Remove group user", "operation_id": "remove-group-user", "tags": [ "Group users" ], "description": "Removes a user from a group.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [ "api.groups.write" ], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "GroupUserDeletedResource", "object": "group.user.deleted", "fields": [ "object", "deleted" ], "example": "{\n \"object\": \"group.user.deleted\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.groups.users.delete(user_id, *, group_id) -> UserDeleteResponse", "node": "client.admin.organization.groups.users.delete(userID, { ...params }) -> UserDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/users/user_abc123 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/delete", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/invites", "name": "List invites", "operation_id": "list-invites", "tags": [ "Invites" ], "description": "Returns a list of invites in the organization.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "InviteListResponse", "object": "list", "fields": [ "object", "data", "first_id", "last_id", "has_more" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.invite\",\n \"id\": \"invite-abc\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"status\": \"accepted\",\n \"created_at\": 1711471533,\n \"expires_at\": 1711471533,\n \"accepted_at\": 1711471533\n }\n ],\n \"first_id\": \"invite-abc\",\n \"last_id\": \"invite-abc\",\n \"has_more\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.invites.list(**params) -> SyncConversationCursorPage[Invite]", "node": "client.admin.organization.invites.list({ ...params }) -> InvitesPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/invites?after=invite-abc&limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "project key -> 403: You have insufficient permissions for this operation. Missing scopes: api.management.read. Check that you have the correct role in your organization, and if you're using a restricted API key, that it has the necessary scopes." }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/invites", "name": "Create invite", "operation_id": "inviteUser", "tags": [ "Invites" ], "description": "Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "InviteRequest" }, "response": { "status": 200, "schema_ref": "Invite", "object": "organization.invite", "fields": [ "object", "id", "email", "role", "status", "created_at", "expires_at", "accepted_at", "projects" ], "example": "{\n \"object\": \"organization.invite\",\n \"id\": \"invite-def\",\n \"email\": \"anotheruser@example.com\",\n \"role\": \"reader\",\n \"status\": \"pending\",\n \"created_at\": 1711471533,\n \"expires_at\": 1711471533,\n \"accepted_at\": null,\n \"projects\": [\n {\n \"id\": \"project-xyz\",\n \"role\": \"member\"\n },\n {\n \"id\": \"project-abc\",\n \"role\": \"owner\"\n }\n ]\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.invites.create(**params) -> Invite", "node": "client.admin.organization.invites.create({ ...params }) -> Invite" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/invites \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"anotheruser@example.com\",\n \"role\": \"reader\",\n \"projects\": [\n {\n \"id\": \"project-xyz\",\n \"role\": \"member\"\n },\n {\n \"id\": \"project-abc\",\n \"role\": \"owner\"\n }\n ]\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/create", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/invites/{invite_id}", "name": "Retrieve invite", "operation_id": "retrieve-invite", "tags": [ "Invites" ], "description": "Retrieves an invite.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "Invite", "object": "organization.invite", "fields": [ "object", "id", "email", "role", "status", "created_at", "expires_at", "accepted_at", "projects" ], "example": "{\n \"object\": \"organization.invite\",\n \"id\": \"invite-abc\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"status\": \"accepted\",\n \"created_at\": 1711471533,\n \"expires_at\": 1711471533,\n \"accepted_at\": 1711471533\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.invites.retrieve(invite_id) -> Invite", "node": "client.admin.organization.invites.retrieve(inviteID) -> Invite" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/invites/invite-abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/retrieve", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/invites/{invite_id}", "name": "Delete invite", "operation_id": "delete-invite", "tags": [ "Invites" ], "description": "Delete an invite. If the invite has already been accepted, it cannot be deleted.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "InviteDeleteResponse", "object": "organization.invite.deleted", "fields": [ "object", "id", "deleted" ], "example": "{\n \"object\": \"organization.invite.deleted\",\n \"id\": \"invite-abc\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.invites.delete(invite_id) -> InviteDeleteResponse", "node": "client.admin.organization.invites.delete(inviteID) -> InviteDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/invites/invite-abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/delete", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects", "name": "List projects", "operation_id": "list-projects", "tags": [ "Projects" ], "description": "Returns a list of projects.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectListResponse", "object": "list", "fields": [ "object", "data", "first_id", "last_id", "has_more" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"proj_abc\",\n \"object\": \"organization.project\",\n \"name\": \"Project example\",\n \"created_at\": 1711471533,\n \"archived_at\": null,\n \"status\": \"active\"\n }\n ],\n \"first_id\": \"proj-abc\",\n \"last_id\": \"proj-xyz\",\n \"has_more\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.list(**params) -> SyncConversationCursorPage[Project]", "node": "client.admin.organization.projects.list({ ...params }) -> ProjectsPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects?after=proj_abc&limit=20&include_archived=false \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "project key -> 403: You have insufficient permissions for this operation. Missing scopes: api.management.read. Check that you have the correct role in your organization, and if you're using a restricted API key, that it has the necessary scopes." }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects", "name": "Create project", "operation_id": "create-project", "tags": [ "Projects" ], "description": "Create a new project in the organization. Projects can be created and archived, but cannot be deleted.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ProjectCreateRequest" }, "response": { "status": 200, "schema_ref": "Project", "object": "organization.project", "fields": [ "id", "object", "name", "created_at", "archived_at", "status", "external_key_id", "residency" ], "example": "{\n \"id\": \"proj_abc\",\n \"object\": \"organization.project\",\n \"name\": \"Project ABC\",\n \"created_at\": 1711471533,\n \"archived_at\": null,\n \"status\": \"active\"\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.create(**params) -> Project", "node": "client.admin.organization.projects.create({ ...params }) -> Project" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Project ABC\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/create", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}", "name": "Retrieve project", "operation_id": "retrieve-project", "tags": [ "Projects" ], "description": "Retrieves a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "Project", "object": "organization.project", "fields": [ "id", "object", "name", "created_at", "archived_at", "status", "external_key_id", "residency" ], "example": "{\n \"id\": \"proj_abc\",\n \"object\": \"organization.project\",\n \"name\": \"Project example\",\n \"created_at\": 1711471533,\n \"archived_at\": null,\n \"status\": \"active\"\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.retrieve(project_id) -> Project", "node": "client.admin.organization.projects.retrieve(projectID) -> Project" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/retrieve", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}", "name": "Modify project", "operation_id": "modify-project", "tags": [ "Projects" ], "description": "Modifies a project in the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ProjectUpdateRequest" }, "response": { "status": 200, "schema_ref": "Project", "object": "organization.project", "fields": [ "id", "object", "name", "created_at", "archived_at", "status", "external_key_id", "residency" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.update(project_id, **params) -> Project", "node": "client.admin.organization.projects.update(projectID, { ...params }) -> Project" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Project DEF\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/update", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/api_keys", "name": "List project API keys", "operation_id": "list-project-api-keys", "tags": [ "Projects" ], "description": "Returns a list of API keys in the project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectApiKeyListResponse", "object": "list", "fields": [ "object", "data", "first_id", "last_id", "has_more" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.project.api_key\",\n \"redacted_value\": \"sk-abc...def\",\n \"name\": \"My API Key\",\n \"created_at\": 1711471533,\n \"last_used_at\": 1711471534,\n \"id\": \"key_abc\",\n \"owner_project_access\": \"active\",\n \"owner\": {\n \"type\": \"user\",\n \"user\": {\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"created_at\": 1711471533\n }\n }\n }\n ],\n \"first_id\": \"key_abc\",\n \"last_id\": \"key_xyz\",\n \"has_more\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.api_keys.list(project_id, **params) -> SyncConversationCursorPage[ProjectAPIKey]", "node": "client.admin.organization.projects.apiKeys.list(projectID, { ...params }) -> ProjectAPIKeysPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key_abc&limit=20&owner_project_access=any \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/api_keys/{api_key_id}", "name": "Retrieve project API key", "operation_id": "retrieve-project-api-key", "tags": [ "Projects" ], "description": "Retrieves an API key in the project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectApiKey", "object": "organization.project.api_key", "fields": [ "object", "redacted_value", "name", "created_at", "expires_at", "last_used_at", "id", "owner_project_access", "owner" ], "example": "{\n \"object\": \"organization.project.api_key\",\n \"redacted_value\": \"sk-abc...def\",\n \"name\": \"My API Key\",\n \"created_at\": 1711471533,\n \"last_used_at\": 1711471534,\n \"id\": \"key_abc\",\n \"owner_project_access\": \"active\",\n \"owner\": {\n \"type\": \"user\",\n \"user\": {\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"created_at\": 1711471533\n }\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.api_keys.retrieve(api_key_id, *, project_id) -> ProjectAPIKey", "node": "client.admin.organization.projects.apiKeys.retrieve(apiKeyID, { ...params }) -> ProjectAPIKey" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys/key_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/retrieve", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/projects/{project_id}/api_keys/{api_key_id}", "name": "Delete project API key", "operation_id": "delete-project-api-key", "tags": [ "Projects" ], "description": "Deletes an API key from the project. Returns confirmation of the key deletion, or an error if the key belonged to a service account.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectApiKeyDeleteResponse", "object": "organization.project.api_key.deleted", "fields": [ "object", "id", "deleted" ], "example": "{\n \"object\": \"organization.project.api_key.deleted\",\n \"id\": \"key_abc\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.projects.api_keys.delete(api_key_id, *, project_id) -> APIKeyDeleteResponse", "node": "client.admin.organization.projects.apiKeys.delete(apiKeyID, { ...params }) -> APIKeyDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/api_keys/key_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/delete", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/archive", "name": "Archive project", "operation_id": "archive-project", "tags": [ "Projects" ], "description": "Archives a project in the organization. Archived projects cannot be used or updated.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "Project", "object": "organization.project", "fields": [ "id", "object", "name", "created_at", "archived_at", "status", "external_key_id", "residency" ], "example": "{\n \"id\": \"proj_abc\",\n \"object\": \"organization.project\",\n \"name\": \"Project DEF\",\n \"created_at\": 1711471533,\n \"archived_at\": 1711471533,\n \"status\": \"archived\"\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.projects.archive(project_id) -> Project", "node": "client.admin.organization.projects.archive(projectID) -> Project" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/archive \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/certificates", "name": "List project certificates", "operation_id": "listProjectCertificates", "tags": [ "Certificates" ], "description": "List certificates for this project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.mtls.read" ], "documented_scopes": [ "api.mtls.read" ], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ListProjectCertificatesResponse", "object": "list", "fields": [ "data", "first_id", "last_id", "has_more", "object" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.project.certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"active\": true,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n ],\n \"first_id\": \"cert_abc\",\n \"last_id\": \"cert_abc\",\n \"has_more\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.certificates.list(project_id, **params) -> SyncConversationCursorPage[CertificateListResponse]", "node": "client.admin.organization.projects.certificates.list(projectID, { ...params }) -> CertificateListResponsesPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/certificates \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/certificates/activate", "name": "Activate certificates for project", "operation_id": "activateProjectCertificates", "tags": [ "Certificates" ], "description": "Activate certificates at the project level. You can atomically and idempotently activate up to 10 certificates at a time.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [ "api.mtls.write" ], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ToggleCertificatesRequest" }, "response": { "status": 200, "schema_ref": "OrganizationProjectCertificateActivationResponse", "object": "organization.project.certificate.activation", "fields": [ "object", "data" ], "example": "{\n \"object\": \"organization.project.certificate.activation\",\n \"data\": [\n {\n \"object\": \"organization.project.certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"active\": true,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n {\n \"object\": \"organization.project.certificate\",\n \"id\": \"cert_def\",\n \"name\": \"My Example Certificate 2\",\n \"active\": true,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n ],\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.certificates.activate(project_id, **params) -> SyncPage[CertificateActivateResponse]", "node": "client.admin.organization.projects.certificates.activate(projectID, { ...params }) -> CertificateActivateResponsesPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/certificates/activate \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"certificate_ids\": [\"cert_abc\", \"cert_def\"]\n}'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/certificates/deactivate", "name": "Deactivate certificates for project", "operation_id": "deactivateProjectCertificates", "tags": [ "Certificates" ], "description": "Deactivate certificates at the project level. You can atomically and idempotently deactivate up to 10 certificates at a time.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [ "api.mtls.write" ], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ToggleCertificatesRequest" }, "response": { "status": 200, "schema_ref": "OrganizationProjectCertificateDeactivationResponse", "object": "organization.project.certificate.deactivation", "fields": [ "object", "data" ], "example": "{\n \"object\": \"organization.project.certificate.deactivation\",\n \"data\": [\n {\n \"object\": \"organization.project.certificate\",\n \"id\": \"cert_abc\",\n \"name\": \"My Example Certificate\",\n \"active\": false,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n {\n \"object\": \"organization.project.certificate\",\n \"id\": \"cert_def\",\n \"name\": \"My Example Certificate 2\",\n \"active\": false,\n \"created_at\": 1234567,\n \"certificate_details\": {\n \"valid_at\": 12345667,\n \"expires_at\": 12345678\n }\n },\n ],\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.projects.certificates.deactivate(project_id, **params) -> SyncPage[CertificateDeactivateResponse]", "node": "client.admin.organization.projects.certificates.deactivate(projectID, { ...params }) -> CertificateDeactivateResponsesPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/certificates/deactivate \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"certificate_ids\": [\"cert_abc\", \"cert_def\"]\n}'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/data_retention", "name": "Retrieve project data retention", "operation_id": "retrieve-project-data-retention", "tags": [ "Data retention" ], "description": "Retrieves project data retention controls.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectDataRetention", "object": "project.data_retention", "fields": [ "object", "type" ], "example": "{\n \"object\": \"project.data_retention\",\n \"type\": \"organization_default\"\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.data_retention.retrieve(project_id) -> ProjectDataRetention", "node": "client.admin.organization.projects.dataRetention.retrieve(projectID) -> ProjectDataRetention" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/data_retention \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/data_retention", "name": "Update project data retention", "operation_id": "update-project-data-retention", "tags": [ "Data retention" ], "description": "Updates project data retention controls.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "UpdateProjectDataRetentionBody" }, "response": { "status": 200, "schema_ref": "ProjectDataRetention", "object": "project.data_retention", "fields": [ "object", "type" ], "example": "{\n \"object\": \"project.data_retention\",\n \"type\": \"modified_abuse_monitoring\"\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.data_retention.update(project_id, **params) -> ProjectDataRetention", "node": "client.admin.organization.projects.dataRetention.update(projectID, { ...params }) -> ProjectDataRetention" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/data_retention \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"retention_type\": \"modified_abuse_monitoring\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/groups", "name": "List project groups", "operation_id": "list-project-groups", "tags": [ "Project groups" ], "description": "Lists the groups that have access to a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.groups.read" ], "documented_scopes": [ "api.groups.read" ], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectGroupListResource", "object": "list", "fields": [ "object", "data", "has_more", "next" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"project.group\",\n \"project_id\": \"proj_abc123\",\n \"group_id\": \"group_01J1F8ABCDXYZ\",\n \"group_name\": \"Support Team\",\n \"created_at\": 1711471533\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.groups.list(project_id, **params) -> SyncNextCursorPage[ProjectGroup]", "node": "client.admin.organization.projects.groups.list(projectID, { ...params }) -> ProjectGroupsPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc123/groups?limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/groups", "name": "Add project group", "operation_id": "add-project-group", "tags": [ "Project groups" ], "description": "Grants a group access to a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [ "api.groups.write" ], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "InviteProjectGroupBody" }, "response": { "status": 200, "schema_ref": "ProjectGroup", "object": "project.group", "fields": [ "object", "project_id", "group_id", "group_name", "group_type", "created_at" ], "example": "{\n \"object\": \"project.group\",\n \"project_id\": \"proj_abc123\",\n \"group_id\": \"group_01J1F8ABCDXYZ\",\n \"group_name\": \"Support Team\",\n \"created_at\": 1711471533\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.groups.create(project_id, **params) -> ProjectGroup", "node": "client.admin.organization.projects.groups.create(projectID, { ...params }) -> ProjectGroup" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc123/groups \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"group_id\": \"group_01J1F8ABCDXYZ\",\n \"role\": \"role_01J1F8PROJ\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/groups/{group_id}", "name": "Retrieve project group", "operation_id": "retrieve-project-group", "tags": [ "Project groups" ], "description": "Retrieves a project's group.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.groups.read" ], "documented_scopes": [ "api.groups.read" ], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectGroup", "object": "project.group", "fields": [ "object", "project_id", "group_id", "group_name", "group_type", "created_at" ], "example": "{\n \"object\": \"project.group\",\n \"project_id\": \"proj_abc123\",\n \"group_id\": \"group_01J1F8ABCDXYZ\",\n \"group_name\": \"Support Team\",\n \"group_type\": \"group\",\n \"created_at\": 1711471533\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.groups.retrieve(group_id, *, project_id, **params) -> ProjectGroup", "node": "client.admin.organization.projects.groups.retrieve(groupID, { ...params }) -> ProjectGroup" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc123/groups/group_01J1F8ABCDXYZ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/projects/{project_id}/groups/{group_id}", "name": "Remove project group", "operation_id": "remove-project-group", "tags": [ "Project groups" ], "description": "Revokes a group's access to a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [ "api.groups.write" ], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectGroupDeletedResource", "object": "project.group.deleted", "fields": [ "object", "deleted" ], "example": "{\n \"object\": \"project.group.deleted\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.projects.groups.delete(group_id, *, project_id) -> GroupDeleteResponse", "node": "client.admin.organization.projects.groups.delete(groupID, { ...params }) -> GroupDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc123/groups/group_01J1F8ABCDXYZ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups/methods/delete", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/hosted_tool_permissions", "name": "Retrieve project hosted tool permissions", "operation_id": "retrieve-project-hosted-tool-permissions", "tags": [ "Hosted tools" ], "description": "Returns hosted tool permissions for a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectHostedToolPermissions", "object": null, "fields": [ "file_search", "web_search", "image_generation", "mcp", "code_interpreter" ], "example": "{\n \"file_search\": {\n \"enabled\": true\n },\n \"web_search\": {\n \"enabled\": true\n },\n \"image_generation\": {\n \"enabled\": true\n },\n \"mcp\": {\n \"enabled\": true\n },\n \"code_interpreter\": {\n \"enabled\": true\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.hosted_tool_permissions.retrieve(project_id) -> ProjectHostedToolPermissions", "node": "client.admin.organization.projects.hostedToolPermissions.retrieve(projectID) -> ProjectHostedToolPermissions" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/hosted_tool_permissions \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/hosted_tool_permissions", "name": "Modify project hosted tool permissions", "operation_id": "update-project-hosted-tool-permissions", "tags": [ "Hosted tools" ], "description": "Updates hosted tool permissions for a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ProjectHostedToolPermissionsUpdateRequest" }, "response": { "status": 200, "schema_ref": "ProjectHostedToolPermissions", "object": null, "fields": [ "file_search", "web_search", "image_generation", "mcp", "code_interpreter" ], "example": "{\n \"file_search\": {\n \"enabled\": true\n },\n \"web_search\": {\n \"enabled\": true\n },\n \"image_generation\": {\n \"enabled\": false\n },\n \"mcp\": {\n \"enabled\": true\n },\n \"code_interpreter\": {\n \"enabled\": true\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.hosted_tool_permissions.update(project_id, **params) -> ProjectHostedToolPermissions", "node": "client.admin.organization.projects.hostedToolPermissions.update(projectID, { ...params }) -> ProjectHostedToolPermissions" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/hosted_tool_permissions \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"file_search\": {\n \"enabled\": true\n },\n \"image_generation\": {\n \"enabled\": false\n }\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/model_permissions", "name": "Retrieve project model permissions", "operation_id": "retrieve-project-model-permissions", "tags": [ "Projects" ], "description": "Returns model permissions for a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectModelPermissions", "object": "project.model_permissions", "fields": [ "object", "mode", "model_ids" ], "example": "{\n \"object\": \"project.model_permissions\",\n \"mode\": \"allow_list\",\n \"model_ids\": [\n \"gpt-6-astra\",\n \"o3\"\n ]\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.model_permissions.retrieve(project_id) -> ProjectModelPermissions", "node": "client.admin.organization.projects.modelPermissions.retrieve(projectID) -> ProjectModelPermissions" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/model_permissions \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/model_permissions", "name": "Modify project model permissions", "operation_id": "update-project-model-permissions", "tags": [ "Projects" ], "description": "Updates model permissions for a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ProjectModelPermissionsUpdateRequest" }, "response": { "status": 200, "schema_ref": "ProjectModelPermissions", "object": "project.model_permissions", "fields": [ "object", "mode", "model_ids" ], "example": "{\n \"object\": \"project.model_permissions\",\n \"mode\": \"deny_list\",\n \"model_ids\": [\n \"o3\"\n ]\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.model_permissions.update(project_id, **params) -> ProjectModelPermissions", "node": "client.admin.organization.projects.modelPermissions.update(projectID, { ...params }) -> ProjectModelPermissions" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/model_permissions \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"mode\": \"deny_list\",\n \"model_ids\": [\n \"o3\"\n ]\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/projects/{project_id}/model_permissions", "name": "Delete project model permissions", "operation_id": "delete-project-model-permissions", "tags": [ "Projects" ], "description": "Deletes model permissions for a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectModelPermissionsDeleteResponse", "object": "project.model_permissions.deleted", "fields": [ "object", "deleted" ], "example": "{\n \"object\": \"project.model_permissions.deleted\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.projects.model_permissions.delete(project_id) -> ProjectModelPermissionsDeleted", "node": "client.admin.organization.projects.modelPermissions.delete(projectID) -> ProjectModelPermissionsDeleted" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/model_permissions \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/rate_limits", "name": "List project rate limits", "operation_id": "list-project-rate-limits", "tags": [ "Projects" ], "description": "Returns the rate limits per model for a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectRateLimitListResponse", "object": "list", "fields": [ "object", "data", "first_id", "last_id", "has_more" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"project.rate_limit\",\n \"id\": \"rl-ada\",\n \"model\": \"ada\",\n \"max_requests_per_1_minute\": 600,\n \"max_tokens_per_1_minute\": 150000,\n \"max_images_per_1_minute\": 10\n }\n ],\n \"first_id\": \"rl-ada\",\n \"last_id\": \"rl-ada\",\n \"has_more\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "before" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.rate_limits.list_rate_limits(project_id, **params) -> SyncConversationCursorPage[ProjectRateLimit]", "node": "client.admin.organization.projects.rateLimits.listRateLimits(projectID, { ...params }) -> ProjectRateLimitsPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/rate_limits?after=rl_xxx&limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/rate_limits/{rate_limit_id}", "name": "Modify project rate limit", "operation_id": "update-project-rate-limits", "tags": [ "Projects" ], "description": "Updates a project rate limit.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ProjectRateLimitUpdateRequest" }, "response": { "status": 200, "schema_ref": "ProjectRateLimit", "object": "project.rate_limit", "fields": [ "object", "id", "model", "max_requests_per_1_minute", "max_tokens_per_1_minute", "max_images_per_1_minute", "max_audio_megabytes_per_1_minute", "max_requests_per_1_day", "batch_1_day_max_input_tokens" ], "example": "{\n \"object\": \"project.rate_limit\",\n \"id\": \"rl-ada\",\n \"model\": \"ada\",\n \"max_requests_per_1_minute\": 600,\n \"max_tokens_per_1_minute\": 150000,\n \"max_images_per_1_minute\": 10\n }\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.rate_limits.update_rate_limit(rate_limit_id, *, project_id, **params) -> ProjectRateLimit", "node": "client.admin.organization.projects.rateLimits.updateRateLimit(rateLimitID, { ...params }) -> ProjectRateLimit" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/rate_limits/rl_xxx \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"max_requests_per_1_minute\": 500\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/service_accounts", "name": "List project service accounts", "operation_id": "list-project-service-accounts", "tags": [ "Projects" ], "description": "Returns a list of service accounts in the project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectServiceAccountListResponse", "object": "list", "fields": [ "object", "data", "first_id", "last_id", "has_more" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.project.service_account\",\n \"id\": \"svc_acct_abc\",\n \"name\": \"Service Account\",\n \"role\": \"owner\",\n \"created_at\": 1711471533\n }\n ],\n \"first_id\": \"svc_acct_abc\",\n \"last_id\": \"svc_acct_xyz\",\n \"has_more\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.service_accounts.list(project_id, **params) -> SyncConversationCursorPage[ProjectServiceAccount]", "node": "client.admin.organization.projects.serviceAccounts.list(projectID, { ...params }) -> ProjectServiceAccountsPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/service_accounts?after=custom_id&limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/service_accounts", "name": "Create project service account", "operation_id": "create-project-service-account", "tags": [ "Projects" ], "description": "Creates a new service account in the project. By default, this also returns an unredacted API key for the service account.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ProjectServiceAccountCreateRequest" }, "response": { "status": 200, "schema_ref": "ProjectServiceAccountCreateResponse", "object": "organization.project.service_account", "fields": [ "object", "id", "name", "role", "created_at", "api_key" ], "example": "{\n \"object\": \"organization.project.service_account\",\n \"id\": \"svc_acct_abc\",\n \"name\": \"Production App\",\n \"role\": \"member\",\n \"created_at\": 1711471533,\n \"api_key\": {\n \"object\": \"organization.project.service_account.api_key\",\n \"value\": \"sk-abcdefghijklmnop123\",\n \"name\": \"Secret Key\",\n \"created_at\": 1711471533,\n \"id\": \"key_abc\"\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.service_accounts.create(project_id, **params) -> ServiceAccountCreateResponse", "node": "client.admin.organization.projects.serviceAccounts.create(projectID, { ...params }) -> ServiceAccountCreateResponse" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/service_accounts \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Production App\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/create", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/service_accounts/{service_account_id}", "name": "Retrieve project service account", "operation_id": "retrieve-project-service-account", "tags": [ "Projects" ], "description": "Retrieves a service account in the project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectServiceAccount", "object": "organization.project.service_account", "fields": [ "object", "id", "name", "role", "created_at" ], "example": "{\n \"object\": \"organization.project.service_account\",\n \"id\": \"svc_acct_abc\",\n \"name\": \"Service Account\",\n \"role\": \"owner\",\n \"created_at\": 1711471533\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.service_accounts.retrieve(service_account_id, *, project_id) -> ProjectServiceAccount", "node": "client.admin.organization.projects.serviceAccounts.retrieve(serviceAccountID, { ...params }) -> ProjectServiceAccount" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/service_accounts/svc_acct_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/retrieve", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/service_accounts/{service_account_id}", "name": "Update project service account", "operation_id": "update-project-service-account", "tags": [ "Projects" ], "description": "Updates a service account in the project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "UpdateProjectServiceAccountBody" }, "response": { "status": 200, "schema_ref": "ProjectServiceAccount", "object": "organization.project.service_account", "fields": [ "object", "id", "name", "role", "created_at" ], "example": "{\n \"object\": \"organization.project.service_account\",\n \"id\": \"svc_acct_abc\",\n \"name\": \"Updated service account\",\n \"role\": \"member\",\n \"created_at\": 1711471533\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.service_accounts.update(service_account_id, *, project_id, **params) -> ProjectServiceAccount", "node": "client.admin.organization.projects.serviceAccounts.update(serviceAccountID, { ...params }) -> ProjectServiceAccount" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/service_accounts/svc_acct_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Updated service account\",\n \"role\": \"member\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/projects/{project_id}/service_accounts/{service_account_id}", "name": "Delete project service account", "operation_id": "delete-project-service-account", "tags": [ "Projects" ], "description": "Deletes a service account from the project. Returns confirmation of service account deletion, or an error if the project is archived (archived projects have no service accounts).", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectServiceAccountDeleteResponse", "object": "organization.project.service_account.deleted", "fields": [ "object", "id", "deleted" ], "example": "{\n \"object\": \"organization.project.service_account.deleted\",\n \"id\": \"svc_acct_abc\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.projects.service_accounts.delete(service_account_id, *, project_id) -> ServiceAccountDeleteResponse", "node": "client.admin.organization.projects.serviceAccounts.delete(serviceAccountID, { ...params }) -> ServiceAccountDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/service_accounts/svc_acct_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/delete", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/spend_alerts", "name": "List project spend alerts", "operation_id": "list-project-spend-alerts", "tags": [ "Spend alerts" ], "description": "Lists project spend alerts.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectSpendAlertListResource", "object": "list", "fields": [ "object", "data", "first_id", "last_id", "has_more" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"alert_abc123\",\n \"object\": \"project.spend_alert\",\n \"threshold_amount\": 100000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"notification_channel\": {\n \"type\": \"email\",\n \"recipients\": [\"finance@example.com\"],\n \"subject_prefix\": \"OpenAI spend alert\"\n }\n }\n ],\n \"first_id\": \"alert_abc123\",\n \"last_id\": \"alert_abc123\",\n \"has_more\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "before", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.spend_alerts.list(project_id, **params) -> SyncConversationCursorPage[ProjectSpendAlert]", "node": "client.admin.organization.projects.spendAlerts.list(projectID, { ...params }) -> ProjectSpendAlertsPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/spend_alerts?limit=20&order=asc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/spend_alerts", "name": "Create project spend alert", "operation_id": "create-project-spend-alert", "tags": [ "Spend alerts" ], "description": "Creates a project spend alert.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateSpendAlertBody" }, "response": { "status": 200, "schema_ref": "ProjectSpendAlert", "object": "project.spend_alert", "fields": [ "id", "object", "threshold_amount", "currency", "interval", "notification_channel" ], "example": "{\n \"id\": \"alert_abc123\",\n \"object\": \"project.spend_alert\",\n \"threshold_amount\": 100000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"notification_channel\": {\n \"type\": \"email\",\n \"recipients\": [\"finance@example.com\"],\n \"subject_prefix\": \"OpenAI spend alert\"\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.spend_alerts.create(project_id, **params) -> ProjectSpendAlert", "node": "client.admin.organization.projects.spendAlerts.create(projectID, { ...params }) -> ProjectSpendAlert" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/spend_alerts \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"threshold_amount\": 100000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"notification_channel\": {\n \"type\": \"email\",\n \"recipients\": [\"finance@example.com\"],\n \"subject_prefix\": \"OpenAI spend alert\"\n }\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/spend_alerts/{alert_id}", "name": "Retrieve project spend alert", "operation_id": "retrieve-project-spend-alert", "tags": [ "Spend alerts" ], "description": "Retrieves a project spend alert.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectSpendAlert", "object": "project.spend_alert", "fields": [ "id", "object", "threshold_amount", "currency", "interval", "notification_channel" ], "example": "{\n \"id\": \"alert_abc123\",\n \"object\": \"project.spend_alert\",\n \"threshold_amount\": 150000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"notification_channel\": {\n \"type\": \"email\",\n \"recipients\": [\"finance@example.com\"],\n \"subject_prefix\": \"OpenAI spend alert\"\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.spend_alerts.retrieve(alert_id, *, project_id) -> ProjectSpendAlert", "node": "client.admin.organization.projects.spendAlerts.retrieve(alertID, { ...params }) -> ProjectSpendAlert" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/spend_alerts/alert_abc123 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/spend_alerts/{alert_id}", "name": "Update project spend alert", "operation_id": "update-project-spend-alert", "tags": [ "Spend alerts" ], "description": "Updates a project spend alert.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateSpendAlertBody" }, "response": { "status": 200, "schema_ref": "ProjectSpendAlert", "object": "project.spend_alert", "fields": [ "id", "object", "threshold_amount", "currency", "interval", "notification_channel" ], "example": "{\n \"id\": \"alert_abc123\",\n \"object\": \"project.spend_alert\",\n \"threshold_amount\": 150000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"notification_channel\": {\n \"type\": \"email\",\n \"recipients\": [\"finance@example.com\"],\n \"subject_prefix\": \"OpenAI spend alert\"\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.spend_alerts.update(alert_id, *, project_id, **params) -> ProjectSpendAlert", "node": "client.admin.organization.projects.spendAlerts.update(alertID, { ...params }) -> ProjectSpendAlert" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/spend_alerts/alert_abc123 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"threshold_amount\": 150000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"notification_channel\": {\n \"type\": \"email\",\n \"recipients\": [\"finance@example.com\"],\n \"subject_prefix\": \"OpenAI spend alert\"\n }\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/projects/{project_id}/spend_alerts/{alert_id}", "name": "Delete project spend alert", "operation_id": "delete-project-spend-alert", "tags": [ "Spend alerts" ], "description": "Deletes a project spend alert.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectSpendAlertDeletedResource", "object": "project.spend_alert.deleted", "fields": [ "id", "object", "deleted" ], "example": "{\n \"id\": \"alert_abc123\",\n \"object\": \"project.spend_alert.deleted\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.projects.spend_alerts.delete(alert_id, *, project_id) -> ProjectSpendAlertDeleted", "node": "client.admin.organization.projects.spendAlerts.delete(alertID, { ...params }) -> ProjectSpendAlertDeleted" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/spend_alerts/alert_abc123 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/users", "name": "List project users", "operation_id": "list-project-users", "tags": [ "Projects" ], "description": "Returns a list of users in the project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectUserListResponse", "object": null, "fields": [ "object", "data", "first_id", "last_id", "has_more" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.project.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n }\n ],\n \"first_id\": \"user-abc\",\n \"last_id\": \"user-xyz\",\n \"has_more\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.users.list(project_id, **params) -> SyncConversationCursorPage[ProjectUser]", "node": "client.admin.organization.projects.users.list(projectID, { ...params }) -> ProjectUsersPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/users?after=user_abc&limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/users", "name": "Create project user", "operation_id": "create-project-user", "tags": [ "Projects" ], "description": "Adds a user to the project. Users must already be members of the organization to be added to a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ProjectUserCreateRequest" }, "response": { "status": 200, "schema_ref": "ProjectUser", "object": "organization.project.user", "fields": [ "object", "id", "name", "email", "role", "added_at" ], "example": "{\n \"object\": \"organization.project.user\",\n \"id\": \"user_abc\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.users.create(project_id, **params) -> ProjectUser", "node": "client.admin.organization.projects.users.create(projectID, { ...params }) -> ProjectUser" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/users \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"user_id\": \"user_abc\",\n \"role\": \"member\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/create", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/users/{user_id}", "name": "Retrieve project user", "operation_id": "retrieve-project-user", "tags": [ "Projects" ], "description": "Retrieves a user in the project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectUser", "object": "organization.project.user", "fields": [ "object", "id", "name", "email", "role", "added_at" ], "example": "{\n \"object\": \"organization.project.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.users.retrieve(user_id, *, project_id) -> ProjectUser", "node": "client.admin.organization.projects.users.retrieve(userID, { ...params }) -> ProjectUser" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/users/user_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/retrieve", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/users/{user_id}", "name": "Modify project user", "operation_id": "modify-project-user", "tags": [ "Projects" ], "description": "Modifies a user's role in the project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ProjectUserUpdateRequest" }, "response": { "status": 200, "schema_ref": "ProjectUser", "object": "organization.project.user", "fields": [ "object", "id", "name", "email", "role", "added_at" ], "example": "{\n \"object\": \"organization.project.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.users.update(user_id, *, project_id, **params) -> ProjectUser", "node": "client.admin.organization.projects.users.update(userID, { ...params }) -> ProjectUser" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/users/user_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role\": \"owner\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/update", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/projects/{project_id}/users/{user_id}", "name": "Delete project user", "operation_id": "delete-project-user", "tags": [ "Projects" ], "description": "Deletes a user from the project. Returns confirmation of project user deletion, or an error if the project is archived (archived projects have no users).", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectUserDeleteResponse", "object": "organization.project.user.deleted", "fields": [ "object", "id", "deleted" ], "example": "{\n \"object\": \"organization.project.user.deleted\",\n \"id\": \"user_abc\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.projects.users.delete(user_id, *, project_id) -> UserDeleteResponse", "node": "client.admin.organization.projects.users.delete(userID, { ...params }) -> UserDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/users/user_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/delete", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/roles", "name": "List organization roles", "operation_id": "list-roles", "tags": [ "Roles" ], "description": "Lists the roles configured for the organization.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.roles.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "PublicRoleListResource", "object": "list", "fields": [ "object", "data", "has_more", "next" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.roles.list(**params) -> SyncNextCursorPage[Role]", "node": "client.admin.organization.roles.list({ ...params }) -> RolesPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/roles?limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "project key -> 403: You have insufficient permissions for this operation. Missing scopes: api.roles.read. Check that you have the correct role in your organization, and if you're using a restricted API key, that it has the necessary scopes." }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/roles", "name": "Create organization role", "operation_id": "create-role", "tags": [ "Roles" ], "description": "Creates a custom role for the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "PublicCreateOrganizationRoleBody" }, "response": { "status": 200, "schema_ref": "Role", "object": "role", "fields": [ "object", "id", "name", "description", "permissions", "resource_type", "predefined_role" ], "example": "{\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.roles.create(**params) -> Role", "node": "client.admin.organization.roles.create({ ...params }) -> Role" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_name\": \"API Group Manager\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"description\": \"Allows managing organization groups\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/create", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/roles/{role_id}", "name": "Retrieve organization role", "operation_id": "retrieve-role", "tags": [ "Roles" ], "description": "Retrieves an organization role.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.roles.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "Role", "object": "role", "fields": [ "object", "id", "name", "description", "permissions", "resource_type", "predefined_role" ], "example": "{\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.roles.retrieve(role_id) -> Role", "node": "client.admin.organization.roles.retrieve(roleID) -> Role" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/roles/role_01J1F8ROLE01 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/roles/{role_id}", "name": "Update organization role", "operation_id": "update-role", "tags": [ "Roles" ], "description": "Updates an existing organization role.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "PublicUpdateOrganizationRoleBody" }, "response": { "status": 200, "schema_ref": "Role", "object": "role", "fields": [ "object", "id", "name", "description", "permissions", "resource_type", "predefined_role" ], "example": "{\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.roles.update(role_id, **params) -> Role", "node": "client.admin.organization.roles.update(roleID, { ...params }) -> Role" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/roles/role_01J1F8ROLE01 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_name\": \"API Group Manager\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"description\": \"Allows managing organization groups\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/update", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/roles/{role_id}", "name": "Delete organization role", "operation_id": "delete-role", "tags": [ "Roles" ], "description": "Deletes a custom role from the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "RoleDeletedResource", "object": "role.deleted", "fields": [ "object", "id", "deleted" ], "example": "{\n \"object\": \"role.deleted\",\n \"id\": \"role_01J1F8ROLE01\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.roles.delete(role_id) -> RoleDeleteResponse", "node": "client.admin.organization.roles.delete(roleID) -> RoleDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/roles/role_01J1F8ROLE01 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/delete", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/spend_alerts", "name": "List organization spend alerts", "operation_id": "list-organization-spend-alerts", "tags": [ "Spend alerts" ], "description": "Lists organization spend alerts.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "OrganizationSpendAlertListResource", "object": "list", "fields": [ "object", "data", "first_id", "last_id", "has_more" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"alert_abc123\",\n \"object\": \"organization.spend_alert\",\n \"threshold_amount\": 100000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"notification_channel\": {\n \"type\": \"email\",\n \"recipients\": [\"finance@example.com\"],\n \"subject_prefix\": \"OpenAI spend alert\"\n }\n }\n ],\n \"first_id\": \"alert_abc123\",\n \"last_id\": \"alert_abc123\",\n \"has_more\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "before", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.spend_alerts.list(**params) -> SyncConversationCursorPage[OrganizationSpendAlert]", "node": "client.admin.organization.spendAlerts.list({ ...params }) -> OrganizationSpendAlertsPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/spend_alerts?limit=20&order=asc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "project key -> 403: You have insufficient permissions for this operation. Missing scopes: api.management.read. Check that you have the correct role in your organization, and if you're using a restricted API key, that it has the necessary scopes." }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/spend_alerts", "name": "Create organization spend alert", "operation_id": "create-organization-spend-alert", "tags": [ "Spend alerts" ], "description": "Creates an organization spend alert.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateSpendAlertBody" }, "response": { "status": 200, "schema_ref": "OrganizationSpendAlert", "object": "organization.spend_alert", "fields": [ "id", "object", "threshold_amount", "currency", "interval", "notification_channel" ], "example": "{\n \"id\": \"alert_abc123\",\n \"object\": \"organization.spend_alert\",\n \"threshold_amount\": 100000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"notification_channel\": {\n \"type\": \"email\",\n \"recipients\": [\"finance@example.com\"],\n \"subject_prefix\": \"OpenAI spend alert\"\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.spend_alerts.create(**params) -> OrganizationSpendAlert", "node": "client.admin.organization.spendAlerts.create({ ...params }) -> OrganizationSpendAlert" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/spend_alerts \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"threshold_amount\": 100000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"notification_channel\": {\n \"type\": \"email\",\n \"recipients\": [\"finance@example.com\"],\n \"subject_prefix\": \"OpenAI spend alert\"\n }\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/spend_alerts/{alert_id}", "name": "Retrieve organization spend alert", "operation_id": "retrieve-organization-spend-alert", "tags": [ "Spend alerts" ], "description": "Retrieves an organization spend alert.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "OrganizationSpendAlert", "object": "organization.spend_alert", "fields": [ "id", "object", "threshold_amount", "currency", "interval", "notification_channel" ], "example": "{\n \"id\": \"alert_abc123\",\n \"object\": \"organization.spend_alert\",\n \"threshold_amount\": 150000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"notification_channel\": {\n \"type\": \"email\",\n \"recipients\": [\"finance@example.com\"],\n \"subject_prefix\": \"OpenAI spend alert\"\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.spend_alerts.retrieve(alert_id) -> OrganizationSpendAlert", "node": "client.admin.organization.spendAlerts.retrieve(alertID) -> OrganizationSpendAlert" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/spend_alerts/alert_abc123 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/spend_alerts/{alert_id}", "name": "Update organization spend alert", "operation_id": "update-organization-spend-alert", "tags": [ "Spend alerts" ], "description": "Updates an organization spend alert.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateSpendAlertBody" }, "response": { "status": 200, "schema_ref": "OrganizationSpendAlert", "object": "organization.spend_alert", "fields": [ "id", "object", "threshold_amount", "currency", "interval", "notification_channel" ], "example": "{\n \"id\": \"alert_abc123\",\n \"object\": \"organization.spend_alert\",\n \"threshold_amount\": 150000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"notification_channel\": {\n \"type\": \"email\",\n \"recipients\": [\"finance@example.com\"],\n \"subject_prefix\": \"OpenAI spend alert\"\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.spend_alerts.update(alert_id, **params) -> OrganizationSpendAlert", "node": "client.admin.organization.spendAlerts.update(alertID, { ...params }) -> OrganizationSpendAlert" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/spend_alerts/alert_abc123 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"threshold_amount\": 150000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"notification_channel\": {\n \"type\": \"email\",\n \"recipients\": [\"finance@example.com\"],\n \"subject_prefix\": \"OpenAI spend alert\"\n }\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/spend_alerts/{alert_id}", "name": "Delete organization spend alert", "operation_id": "delete-organization-spend-alert", "tags": [ "Spend alerts" ], "description": "Deletes an organization spend alert.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "OrganizationSpendAlertDeletedResource", "object": "organization.spend_alert.deleted", "fields": [ "id", "object", "deleted" ], "example": "{\n \"id\": \"alert_abc123\",\n \"object\": \"organization.spend_alert.deleted\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.spend_alerts.delete(alert_id) -> OrganizationSpendAlertDeleted", "node": "client.admin.organization.spendAlerts.delete(alertID) -> OrganizationSpendAlertDeleted" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/spend_alerts/alert_abc123 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/usage/audio_speeches", "name": "Audio speeches", "operation_id": "usage-audio-speeches", "tags": [ "Usage" ], "description": "Get audio speeches usage details for the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.usage.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "UsageResponse", "object": "page", "fields": [ "object", "data", "has_more", "next_page" ], "example": "{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.audio_speeches.result\",\n \"characters\": 45,\n \"num_model_requests\": 1,\n \"project_id\": null,\n \"user_id\": null,\n \"api_key_id\": null,\n \"model\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "page" ], "response_fields": [ "next_page", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.usage.audio_speeches(**params) -> UsageAudioSpeechesResponse", "node": "client.admin.organization.usage.audioSpeeches({ ...params }) -> UsageAudioSpeechesResponse" }, "examples": { "curl": "curl \"https://api.openai.com/v1/organization/usage/audio_speeches?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/usage/audio_transcriptions", "name": "Audio transcriptions", "operation_id": "usage-audio-transcriptions", "tags": [ "Usage" ], "description": "Get audio transcriptions usage details for the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.usage.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "UsageResponse", "object": "page", "fields": [ "object", "data", "has_more", "next_page" ], "example": "{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.audio_transcriptions.result\",\n \"seconds\": 20,\n \"num_model_requests\": 1,\n \"project_id\": null,\n \"user_id\": null,\n \"api_key_id\": null,\n \"model\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "page" ], "response_fields": [ "next_page", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.usage.audio_transcriptions(**params) -> UsageAudioTranscriptionsResponse", "node": "client.admin.organization.usage.audioTranscriptions({ ...params }) -> UsageAudioTranscriptionsResponse" }, "examples": { "curl": "curl \"https://api.openai.com/v1/organization/usage/audio_transcriptions?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/usage/code_interpreter_sessions", "name": "Code interpreter sessions", "operation_id": "usage-code-interpreter-sessions", "tags": [ "Usage" ], "description": "Get code interpreter sessions usage details for the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.usage.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "UsageResponse", "object": "page", "fields": [ "object", "data", "has_more", "next_page" ], "example": "{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.code_interpreter_sessions.result\",\n \"num_sessions\": 1,\n \"project_id\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "page" ], "response_fields": [ "next_page", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.usage.code_interpreter_sessions(**params) -> UsageCodeInterpreterSessionsResponse", "node": "client.admin.organization.usage.codeInterpreterSessions({ ...params }) -> UsageCodeInterpreterSessionsResponse" }, "examples": { "curl": "curl \"https://api.openai.com/v1/organization/usage/code_interpreter_sessions?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/usage/completions", "name": "Completions", "operation_id": "usage-completions", "tags": [ "Usage" ], "description": "Get completions usage details for the organization.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.usage.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "UsageResponse", "object": "page", "fields": [ "object", "data", "has_more", "next_page" ], "example": "{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.completions.result\",\n \"input_tokens\": 1000,\n \"input_cached_tokens\": 400,\n \"input_cache_write_tokens\": 100,\n \"input_uncached_tokens\": 500,\n \"output_tokens\": 500,\n \"input_text_tokens\": 400,\n \"output_text_tokens\": 400,\n \"input_cached_text_tokens\": 300,\n \"input_audio_tokens\": 50,\n \"input_cached_audio_tokens\": 50,\n \"output_audio_tokens\": 50,\n \"input_image_tokens\": 50,\n \"input_cached_image_tokens\": 50,\n \"output_image_tokens\": 50,\n \"num_model_requests\": 5,\n \"project_id\": null,\n \"user_id\": null,\n \"api_key_id\": null,\n \"model\": null,\n \"batch\": null,\n \"service_tier\": null\n }\n ]\n }\n ],\n \"has_more\": true,\n \"next_page\": \"page_AAAAAGdGxdEiJdKOAAAAAGcqsYA=\"\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "page" ], "response_fields": [ "next_page", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.usage.completions(**params) -> UsageCompletionsResponse", "node": "client.admin.organization.usage.completions({ ...params }) -> UsageCompletionsResponse" }, "examples": { "curl": "curl \"https://api.openai.com/v1/organization/usage/completions?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "project key -> 403: You have insufficient permissions for this operation. Missing scopes: api.usage.read. Check that you have the correct role in your organization, and if you're using a restricted API key, that it has the necessary scopes." }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/usage/embeddings", "name": "Embeddings", "operation_id": "usage-embeddings", "tags": [ "Usage" ], "description": "Get embeddings usage details for the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.usage.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "UsageResponse", "object": "page", "fields": [ "object", "data", "has_more", "next_page" ], "example": "{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.embeddings.result\",\n \"input_tokens\": 16,\n \"num_model_requests\": 2,\n \"project_id\": null,\n \"user_id\": null,\n \"api_key_id\": null,\n \"model\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "page" ], "response_fields": [ "next_page", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.usage.embeddings(**params) -> UsageEmbeddingsResponse", "node": "client.admin.organization.usage.embeddings({ ...params }) -> UsageEmbeddingsResponse" }, "examples": { "curl": "curl \"https://api.openai.com/v1/organization/usage/embeddings?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/usage/file_search_calls", "name": "File search calls", "operation_id": "usage-file-search-calls", "tags": [ "Usage" ], "description": "Get file search calls usage details for the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.usage.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "UsageResponse", "object": "page", "fields": [ "object", "data", "has_more", "next_page" ], "example": "{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.file_searches.result\",\n \"num_requests\": 2,\n \"project_id\": null,\n \"user_id\": null,\n \"api_key_id\": null,\n \"vector_store_id\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "page" ], "response_fields": [ "next_page", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.usage.file_search_calls(**params) -> UsageFileSearchCallsResponse", "node": "client.admin.organization.usage.fileSearchCalls({ ...params }) -> UsageFileSearchCallsResponse" }, "examples": { "curl": "curl \"https://api.openai.com/v1/organization/usage/file_search_calls?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/usage/images", "name": "Images", "operation_id": "usage-images", "tags": [ "Usage" ], "description": "Get images usage details for the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.usage.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "UsageResponse", "object": "page", "fields": [ "object", "data", "has_more", "next_page" ], "example": "{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.images.result\",\n \"images\": 2,\n \"num_model_requests\": 2,\n \"size\": null,\n \"source\": null,\n \"project_id\": null,\n \"user_id\": null,\n \"api_key_id\": null,\n \"model\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "page" ], "response_fields": [ "next_page", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.usage.images(**params) -> UsageImagesResponse", "node": "client.admin.organization.usage.images({ ...params }) -> UsageImagesResponse" }, "examples": { "curl": "curl \"https://api.openai.com/v1/organization/usage/images?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/usage/moderations", "name": "Moderations", "operation_id": "usage-moderations", "tags": [ "Usage" ], "description": "Get moderations usage details for the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.usage.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "UsageResponse", "object": "page", "fields": [ "object", "data", "has_more", "next_page" ], "example": "{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.moderations.result\",\n \"input_tokens\": 16,\n \"num_model_requests\": 2,\n \"project_id\": null,\n \"user_id\": null,\n \"api_key_id\": null,\n \"model\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "page" ], "response_fields": [ "next_page", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.usage.moderations(**params) -> UsageModerationsResponse", "node": "client.admin.organization.usage.moderations({ ...params }) -> UsageModerationsResponse" }, "examples": { "curl": "curl \"https://api.openai.com/v1/organization/usage/moderations?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/usage/vector_stores", "name": "Vector stores", "operation_id": "usage-vector-stores", "tags": [ "Usage" ], "description": "Get vector stores usage details for the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.usage.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "UsageResponse", "object": "page", "fields": [ "object", "data", "has_more", "next_page" ], "example": "{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.vector_stores.result\",\n \"usage_bytes\": 1024,\n \"project_id\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "page" ], "response_fields": [ "next_page", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.usage.vector_stores(**params) -> UsageVectorStoresResponse", "node": "client.admin.organization.usage.vectorStores({ ...params }) -> UsageVectorStoresResponse" }, "examples": { "curl": "curl \"https://api.openai.com/v1/organization/usage/vector_stores?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/usage/web_search_calls", "name": "Web search calls", "operation_id": "usage-web-search-calls", "tags": [ "Usage" ], "description": "Get web search calls usage details for the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.usage.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "UsageResponse", "object": "page", "fields": [ "object", "data", "has_more", "next_page" ], "example": "{\n \"object\": \"page\",\n \"data\": [\n {\n \"object\": \"bucket\",\n \"start_time\": 1730419200,\n \"end_time\": 1730505600,\n \"results\": [\n {\n \"object\": \"organization.usage.web_searches.result\",\n \"num_model_requests\": 2,\n \"num_requests\": 2,\n \"project_id\": null,\n \"user_id\": null,\n \"api_key_id\": null,\n \"model\": null,\n \"context_level\": null\n }\n ]\n }\n ],\n \"has_more\": false,\n \"next_page\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "page" ], "response_fields": [ "next_page", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.usage.web_search_calls(**params) -> UsageWebSearchCallsResponse", "node": "client.admin.organization.usage.webSearchCalls({ ...params }) -> UsageWebSearchCallsResponse" }, "examples": { "curl": "curl \"https://api.openai.com/v1/organization/usage/web_search_calls?start_time=1730419200&limit=1\" \\\n-H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n-H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/users", "name": "List users", "operation_id": "list-users", "tags": [ "Users" ], "description": "Lists all of the users in the organization.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "UserListResponse", "object": "list", "fields": [ "object", "data", "first_id", "last_id", "has_more" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n }\n ],\n \"first_id\": \"user-abc\",\n \"last_id\": \"user-xyz\",\n \"has_more\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.users.list(**params) -> SyncConversationCursorPage[OrganizationUser]", "node": "client.admin.organization.users.list({ ...params }) -> OrganizationUsersPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/users?after=user_abc&limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "project key -> 403: You have insufficient permissions for this operation. Missing scopes: api.management.read. Check that you have the correct role in your organization, and if you're using a restricted API key, that it has the necessary scopes." }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/users/{user_id}", "name": "Retrieve user", "operation_id": "retrieve-user", "tags": [ "Users" ], "description": "Retrieves a user by their identifier.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "User", "object": "organization.user", "fields": [ "object", "id", "name", "email", "role", "added_at", "is_default", "created", "user", "is_service_account", "is_scale_tier_authorized_purchaser", "is_scim_managed", "api_key_last_used_at", "technical_level", "developer_persona", "projects" ], "example": "{\n \"object\": \"organization.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.users.retrieve(user_id) -> OrganizationUser", "node": "client.admin.organization.users.retrieve(userID) -> OrganizationUser" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/users/user_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/retrieve", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/users/{user_id}", "name": "Modify user", "operation_id": "modify-user", "tags": [ "Users" ], "description": "Modifies a user's role in the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "UserRoleUpdateRequest" }, "response": { "status": 200, "schema_ref": "User", "object": "organization.user", "fields": [ "object", "id", "name", "email", "role", "added_at", "is_default", "created", "user", "is_service_account", "is_scale_tier_authorized_purchaser", "is_scim_managed", "api_key_last_used_at", "technical_level", "developer_persona", "projects" ], "example": "{\n \"object\": \"organization.user\",\n \"id\": \"user_abc\",\n \"name\": \"First Last\",\n \"email\": \"user@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711471533\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.users.update(user_id, **params) -> OrganizationUser", "node": "client.admin.organization.users.update(userID, { ...params }) -> OrganizationUser" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/users/user_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role\": \"owner\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/update", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/users/{user_id}", "name": "Delete user", "operation_id": "delete-user", "tags": [ "Users" ], "description": "Deletes a user from the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "UserDeleteResponse", "object": "organization.user.deleted", "fields": [ "object", "id", "deleted" ], "example": "{\n \"object\": \"organization.user.deleted\",\n \"id\": \"user_abc\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.users.delete(user_id) -> UserDeleteResponse", "node": "client.admin.organization.users.delete(userID) -> UserDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/users/user_abc \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/delete", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/users/{user_id}/roles", "name": "List user organization role assignments", "operation_id": "list-user-role-assignments", "tags": [ "User organization role assignments" ], "description": "Lists the organization roles assigned to a user within the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.roles.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "RoleListResource", "object": "list", "fields": [ "object", "data", "has_more", "next" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false,\n \"description\": \"Allows managing organization groups\",\n \"created_at\": 1711471533,\n \"updated_at\": 1711472599,\n \"created_by\": \"user_abc123\",\n \"created_by_user_obj\": {\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\"\n },\n \"metadata\": {}\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.users.roles.list(user_id, **params) -> SyncNextCursorPage[RoleListResponse]", "node": "client.admin.organization.users.roles.list(userID, { ...params }) -> RoleListResponsesPage" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/users/user_abc123/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/users/{user_id}/roles", "name": "Assign organization role to user", "operation_id": "assign-user-role", "tags": [ "User organization role assignments" ], "description": "Assigns an organization role to a user within the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "PublicAssignOrganizationGroupRoleBody" }, "response": { "status": 200, "schema_ref": "UserRoleAssignment", "object": "user.role", "fields": [ "object", "user", "role" ], "example": "{\n \"object\": \"user.role\",\n \"user\": {\n \"object\": \"organization.user\",\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711470000\n },\n \"role\": {\n \"object\": \"role\",\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"description\": \"Allows managing organization groups\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.users.roles.create(user_id, **params) -> RoleCreateResponse", "node": "client.admin.organization.users.roles.create(userID, { ...params }) -> RoleCreateResponse" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/users/user_abc123/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_id\": \"role_01J1F8ROLE01\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/create", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/users/{user_id}/roles/{role_id}", "name": "Retrieve user organization role", "operation_id": "retrieve-user-role", "tags": [ "User organization role assignments" ], "description": "Retrieves an organization role assigned to a user.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.roles.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "AssignedRoleDetails", "object": null, "fields": [ "id", "name", "permissions", "resource_type", "predefined_role", "description", "created_at", "updated_at", "created_by", "created_by_user_obj", "metadata", "assignment_sources" ], "example": "{\n \"id\": \"role_01J1F8ROLE01\",\n \"name\": \"API Group Manager\",\n \"permissions\": [\n \"api.groups.read\",\n \"api.groups.write\"\n ],\n \"resource_type\": \"api.organization\",\n \"predefined_role\": false,\n \"description\": \"Allows managing organization groups\",\n \"created_at\": 1711471533,\n \"updated_at\": 1711472599,\n \"created_by\": \"user_abc123\",\n \"created_by_user_obj\": null,\n \"metadata\": {},\n \"assignment_sources\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.users.roles.retrieve(role_id, *, user_id) -> RoleRetrieveResponse", "node": "client.admin.organization.users.roles.retrieve(roleID, { ...params }) -> RoleRetrieveResponse" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/users/user_abc123/roles/role_01J1F8ROLE01 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/users/{user_id}/roles/{role_id}", "name": "Unassign organization role from user", "operation_id": "unassign-user-role", "tags": [ "User organization role assignments" ], "description": "Unassigns an organization role from a user within the organization.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "DeletedRoleAssignmentResource", "object": null, "fields": [ "object", "deleted" ], "example": "{\n \"object\": \"user.role.deleted\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.users.roles.delete(role_id, *, user_id) -> RoleDeleteResponse", "node": "client.admin.organization.users.roles.delete(roleID, { ...params }) -> RoleDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/users/user_abc123/roles/role_01J1F8ROLE01 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/delete", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/projects/{project_id}/groups/{group_id}/roles", "name": "List project group role assignments", "operation_id": "list-project-group-role-assignments", "tags": [ "Project group role assignments" ], "description": "Lists the project roles assigned to a group within a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.roles.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "RoleListResource", "object": "list", "fields": [ "object", "data", "has_more", "next" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false,\n \"description\": \"Allows managing API keys for the project\",\n \"created_at\": 1711471533,\n \"updated_at\": 1711472599,\n \"created_by\": \"user_abc123\",\n \"created_by_user_obj\": {\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\"\n },\n \"metadata\": {}\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.groups.roles.list(group_id, *, project_id, **params) -> SyncNextCursorPage[RoleListResponse]", "node": "client.admin.organization.projects.groups.roles.list(groupID, { ...params }) -> RoleListResponsesPage" }, "examples": { "curl": "curl https://api.openai.com/v1/projects/proj_abc123/groups/group_01J1F8ABCDXYZ/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/projects/{project_id}/groups/{group_id}/roles", "name": "Assign project role to group", "operation_id": "assign-project-group-role", "tags": [ "Project group role assignments" ], "description": "Assigns a project role to a group within a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "PublicAssignOrganizationGroupRoleBody" }, "response": { "status": 200, "schema_ref": "GroupRoleAssignment", "object": "group.role", "fields": [ "object", "group", "role" ], "example": "{\n \"object\": \"group.role\",\n \"group\": {\n \"object\": \"group\",\n \"id\": \"group_01J1F8ABCDXYZ\",\n \"name\": \"Support Team\",\n \"created_at\": 1711471533,\n \"scim_managed\": false\n },\n \"role\": {\n \"object\": \"role\",\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"description\": \"Allows managing API keys for the project\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.groups.roles.create(group_id, *, project_id, **params) -> RoleCreateResponse", "node": "client.admin.organization.projects.groups.roles.create(groupID, { ...params }) -> RoleCreateResponse" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/projects/proj_abc123/groups/group_01J1F8ABCDXYZ/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_id\": \"role_01J1F8PROJ\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/create", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/projects/{project_id}/groups/{group_id}/roles/{role_id}", "name": "Retrieve project group role", "operation_id": "retrieve-project-group-role", "tags": [ "Project group role assignments" ], "description": "Retrieves a project role assigned to a group.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.roles.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "AssignedRoleDetails", "object": null, "fields": [ "id", "name", "permissions", "resource_type", "predefined_role", "description", "created_at", "updated_at", "created_by", "created_by_user_obj", "metadata", "assignment_sources" ], "example": "{\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false,\n \"description\": \"Allows managing API keys for the project\",\n \"created_at\": 1711471533,\n \"updated_at\": 1711472599,\n \"created_by\": \"user_abc123\",\n \"created_by_user_obj\": null,\n \"metadata\": {},\n \"assignment_sources\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.groups.roles.retrieve(role_id, *, project_id, group_id) -> RoleRetrieveResponse", "node": "client.admin.organization.projects.groups.roles.retrieve(roleID, { ...params }) -> RoleRetrieveResponse" }, "examples": { "curl": "curl https://api.openai.com/v1/projects/proj_abc123/groups/group_01J1F8ABCDXYZ/roles/role_01J1F8PROJ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/projects/{project_id}/groups/{group_id}/roles/{role_id}", "name": "Unassign project role from group", "operation_id": "unassign-project-group-role", "tags": [ "Project group role assignments" ], "description": "Unassigns a project role from a group within a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "DeletedRoleAssignmentResource", "object": null, "fields": [ "object", "deleted" ], "example": "{\n \"object\": \"group.role.deleted\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.projects.groups.roles.delete(role_id, *, project_id, group_id) -> RoleDeleteResponse", "node": "client.admin.organization.projects.groups.roles.delete(roleID, { ...params }) -> RoleDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/projects/proj_abc123/groups/group_01J1F8ABCDXYZ/roles/role_01J1F8PROJ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/delete", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/projects/{project_id}/roles", "name": "List project roles", "operation_id": "list-project-roles", "tags": [ "Roles" ], "description": "Lists the roles configured for a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.roles.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "PublicRoleListResource", "object": "list", "fields": [ "object", "data", "has_more", "next" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"role\",\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"description\": \"Allows managing API keys for the project\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.roles.list(project_id, **params) -> SyncNextCursorPage[Role]", "node": "client.admin.organization.projects.roles.list(projectID, { ...params }) -> RolesPage" }, "examples": { "curl": "curl https://api.openai.com/v1/projects/proj_abc123/roles?limit=20 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/projects/{project_id}/roles", "name": "Create project role", "operation_id": "create-project-role", "tags": [ "Roles" ], "description": "Creates a custom role for a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "PublicCreateOrganizationRoleBody" }, "response": { "status": 200, "schema_ref": "Role", "object": "role", "fields": [ "object", "id", "name", "description", "permissions", "resource_type", "predefined_role" ], "example": "{\n \"object\": \"role\",\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"description\": \"Allows managing API keys for the project\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.roles.create(project_id, **params) -> Role", "node": "client.admin.organization.projects.roles.create(projectID, { ...params }) -> Role" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/projects/proj_abc123/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_name\": \"API Project Key Manager\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"description\": \"Allows managing API keys for the project\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/create", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/projects/{project_id}/roles/{role_id}", "name": "Retrieve project role", "operation_id": "retrieve-project-role", "tags": [ "Roles" ], "description": "Retrieves a project role.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.roles.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "Role", "object": "role", "fields": [ "object", "id", "name", "description", "permissions", "resource_type", "predefined_role" ], "example": "{\n \"object\": \"role\",\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"description\": \"Allows managing API keys for the project\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.roles.retrieve(role_id, *, project_id) -> Role", "node": "client.admin.organization.projects.roles.retrieve(roleID, { ...params }) -> Role" }, "examples": { "curl": "curl https://api.openai.com/v1/projects/proj_abc123/roles/role_01J1F8PROJ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/projects/{project_id}/roles/{role_id}", "name": "Update project role", "operation_id": "update-project-role", "tags": [ "Roles" ], "description": "Updates an existing project role.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "PublicUpdateOrganizationRoleBody" }, "response": { "status": 200, "schema_ref": "Role", "object": "role", "fields": [ "object", "id", "name", "description", "permissions", "resource_type", "predefined_role" ], "example": "{\n \"object\": \"role\",\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"description\": \"Allows managing API keys for the project\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.roles.update(role_id, *, project_id, **params) -> Role", "node": "client.admin.organization.projects.roles.update(roleID, { ...params }) -> Role" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/projects/proj_abc123/roles/role_01J1F8PROJ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_name\": \"API Project Key Manager\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"description\": \"Allows managing API keys for the project\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/update", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/projects/{project_id}/roles/{role_id}", "name": "Delete project role", "operation_id": "delete-project-role", "tags": [ "Roles" ], "description": "Deletes a custom role from a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "RoleDeletedResource", "object": "role.deleted", "fields": [ "object", "id", "deleted" ], "example": "{\n \"object\": \"role.deleted\",\n \"id\": \"role_01J1F8PROJ\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.projects.roles.delete(role_id, *, project_id) -> RoleDeleteResponse", "node": "client.admin.organization.projects.roles.delete(roleID, { ...params }) -> RoleDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/projects/proj_abc123/roles/role_01J1F8PROJ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/delete", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/projects/{project_id}/users/{user_id}/roles", "name": "List project user role assignments", "operation_id": "list-project-user-role-assignments", "tags": [ "Project user role assignments" ], "description": "Lists the project roles assigned to a user within a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.roles.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "RoleListResource", "object": "list", "fields": [ "object", "data", "has_more", "next" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false,\n \"description\": \"Allows managing API keys for the project\",\n \"created_at\": 1711471533,\n \"updated_at\": 1711472599,\n \"created_by\": \"user_abc123\",\n \"created_by_user_obj\": {\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\"\n },\n \"metadata\": {}\n }\n ],\n \"has_more\": false,\n \"next\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.users.roles.list(user_id, *, project_id, **params) -> SyncNextCursorPage[RoleListResponse]", "node": "client.admin.organization.projects.users.roles.list(userID, { ...params }) -> RoleListResponsesPage" }, "examples": { "curl": "curl https://api.openai.com/v1/projects/proj_abc123/users/user_abc123/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/list", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/projects/{project_id}/users/{user_id}/roles", "name": "Assign project role to user", "operation_id": "assign-project-user-role", "tags": [ "Project user role assignments" ], "description": "Assigns a project role to a user within a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "PublicAssignOrganizationGroupRoleBody" }, "response": { "status": 200, "schema_ref": "UserRoleAssignment", "object": "user.role", "fields": [ "object", "user", "role" ], "example": "{\n \"object\": \"user.role\",\n \"user\": {\n \"object\": \"organization.user\",\n \"id\": \"user_abc123\",\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"role\": \"owner\",\n \"added_at\": 1711470000\n },\n \"role\": {\n \"object\": \"role\",\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"description\": \"Allows managing API keys for the project\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.users.roles.create(user_id, *, project_id, **params) -> RoleCreateResponse", "node": "client.admin.organization.projects.users.roles.create(userID, { ...params }) -> RoleCreateResponse" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/projects/proj_abc123/users/user_abc123/roles \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"role_id\": \"role_01J1F8PROJ\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/create", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/projects/{project_id}/users/{user_id}/roles/{role_id}", "name": "Retrieve project user role", "operation_id": "retrieve-project-user-role", "tags": [ "Project user role assignments" ], "description": "Retrieves a project role assigned to a user.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.roles.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "AssignedRoleDetails", "object": null, "fields": [ "id", "name", "permissions", "resource_type", "predefined_role", "description", "created_at", "updated_at", "created_by", "created_by_user_obj", "metadata", "assignment_sources" ], "example": "{\n \"id\": \"role_01J1F8PROJ\",\n \"name\": \"API Project Key Manager\",\n \"permissions\": [\n \"api.organization.projects.api_keys.read\",\n \"api.organization.projects.api_keys.write\"\n ],\n \"resource_type\": \"api.project\",\n \"predefined_role\": false,\n \"description\": \"Allows managing API keys for the project\",\n \"created_at\": 1711471533,\n \"updated_at\": 1711472599,\n \"created_by\": \"user_abc123\",\n \"created_by_user_obj\": null,\n \"metadata\": {},\n \"assignment_sources\": null\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.users.roles.retrieve(role_id, *, project_id, user_id) -> RoleRetrieveResponse", "node": "client.admin.organization.projects.users.roles.retrieve(roleID, { ...params }) -> RoleRetrieveResponse" }, "examples": { "curl": "curl https://api.openai.com/v1/projects/proj_abc123/users/user_abc123/roles/role_01J1F8PROJ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/projects/{project_id}/users/{user_id}/roles/{role_id}", "name": "Unassign project role from user", "operation_id": "unassign-project-user-role", "tags": [ "Project user role assignments" ], "description": "Unassigns a project role from a user within a project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "DeletedRoleAssignmentResource", "object": null, "fields": [ "object", "deleted" ], "example": "{\n \"object\": \"user.role.deleted\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.projects.users.roles.delete(role_id, *, project_id, user_id) -> RoleDeleteResponse", "node": "client.admin.organization.projects.users.roles.delete(roleID, { ...params }) -> RoleDeleteResponse" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/projects/proj_abc123/users/user_abc123/roles/role_01J1F8PROJ \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/delete", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/external_storage", "name": "List external storage configurations", "operation_id": "Listexternalstorageconfigurations", "tags": [], "description": "List the organization's customer-managed external storage configurations.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.external_storage.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ExternalStorageListResource", "object": "list", "fields": [ "object", "data", "first_id", "last_id", "has_more" ], "example": "{\n \"object\": \"list\",\n \"data\": [\n {\n \"object\": \"organization.external_storage\",\n \"id\": \"extstorage_abc123\",\n \"project_id\": \"proj_abc123\",\n \"provider\": {\n \"type\": \"aws\",\n \"account_id\": \"123456789012\",\n \"region\": \"us-east-1\",\n \"bucket\": \"customer-logs\",\n \"role_arn\": \"arn:aws:iam::123456789012:role/OpenAIExternalStorageRole\",\n \"external_id\": \"proj_abc123\"\n },\n \"geography\": \"US\",\n \"status\": \"validated\",\n \"created_at\": 1711471533\n },\n {\n \"object\": \"organization.external_storage\",\n \"id\": \"extstorage_azure123\",\n \"project_id\": \"proj_azure123\",\n \"provider\": {\n \"type\": \"azure\",\n \"tenant_id\": \"11111111-1111-1111-1111-111111111111\",\n \"subscription_id\": \"22222222-2222-2222-2222-222222222222\",\n \"resource_group\": \"customer-rg\",\n \"account_name\": \"customerstorage\",\n \"container\": \"openai-data\",\n \"region\": \"eastus\"\n },\n \"geography\": \"US\",\n \"status\": \"validated\",\n \"created_at\": 1711471500\n }\n ],\n \"first_id\": \"extstorage_abc123\",\n \"last_id\": \"extstorage_azure123\",\n \"has_more\": false\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": null, "node": null }, "examples": { "curl": "curl \"https://api.openai.com/v1/organization/external_storage?limit=20&order=desc\" \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "project key -> 403: You have insufficient permissions for this operation. Missing scopes: api.external_storage.read. Check that you have the correct role in your organization, and if you're using a restricted API key, that it has the necessary scopes." }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/external_storage", "name": "Create an external storage configuration", "operation_id": "Createanexternalstorageconfiguration", "tags": [], "description": "Register one customer-managed external storage configuration.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateExternalStorageBody" }, "response": { "status": 200, "schema_ref": "ExternalStorageResponse", "object": "organization.external_storage", "fields": [ "object", "id", "project_id", "provider", "geography", "status", "created_at" ], "example": "{\n \"object\": \"organization.external_storage\",\n \"id\": \"extstorage_abc123\",\n \"project_id\": \"proj_abc123\",\n \"provider\": {\n \"type\": \"aws\",\n \"account_id\": \"123456789012\",\n \"region\": \"us-east-1\",\n \"bucket\": \"customer-logs\",\n \"role_arn\": \"arn:aws:iam::123456789012:role/OpenAIExternalStorageRole\",\n \"external_id\": \"proj_abc123\"\n },\n \"geography\": \"US\",\n \"status\": \"pending\",\n \"created_at\": 1711471533\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": null, "node": null }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/external_storage \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"project_id\": \"proj_abc123\",\n \"provider\": {\n \"type\": \"aws\",\n \"bucket\": \"customer-logs\",\n \"role_arn\": \"arn:aws:iam::123456789012:role/OpenAIExternalStorageRole\"\n }\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/external_storage/{external_storage_id}", "name": "Get an external storage configuration", "operation_id": "Getanexternalstorageconfiguration", "tags": [], "description": "Get one customer-managed external storage configuration.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.external_storage.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ExternalStorageResponse", "object": "organization.external_storage", "fields": [ "object", "id", "project_id", "provider", "geography", "status", "created_at" ], "example": "{\n \"object\": \"organization.external_storage\",\n \"id\": \"extstorage_azure123\",\n \"project_id\": \"proj_azure123\",\n \"provider\": {\n \"type\": \"azure\",\n \"tenant_id\": \"11111111-1111-1111-1111-111111111111\",\n \"subscription_id\": \"22222222-2222-2222-2222-222222222222\",\n \"resource_group\": \"customer-rg\",\n \"account_name\": \"customerstorage\",\n \"container\": \"openai-data\",\n \"region\": \"eastus\"\n },\n \"geography\": \"US\",\n \"status\": \"validated\",\n \"created_at\": 1711471533\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": null, "node": null }, "examples": { "curl": "curl https://api.openai.com/v1/organization/external_storage/extstorage_azure123 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/external_storage/{external_storage_id}", "name": "Delete an external storage configuration", "operation_id": "Deleteanexternalstorageconfiguration", "tags": [], "description": "Soft-delete one customer-managed external storage configuration.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ExternalStorageDeletedResource", "object": "organization.external_storage.deleted", "fields": [ "object", "id", "deleted" ], "example": "{\n \"object\": \"organization.external_storage.deleted\",\n \"id\": \"extstorage_abc123\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": null, "node": null }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/external_storage/extstorage_abc123 \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/external_storage/{external_storage_id}/validate", "name": "Validate an external storage configuration", "operation_id": "Validateanexternalstorageconfiguration", "tags": [], "description": "Validate one customer-managed external storage configuration.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ExternalStorageResponse", "object": "organization.external_storage", "fields": [ "object", "id", "project_id", "provider", "geography", "status", "created_at" ], "example": "{\n \"object\": \"organization.external_storage\",\n \"id\": \"extstorage_azure123\",\n \"project_id\": \"proj_azure123\",\n \"provider\": {\n \"type\": \"azure\",\n \"tenant_id\": \"11111111-1111-1111-1111-111111111111\",\n \"subscription_id\": \"22222222-2222-2222-2222-222222222222\",\n \"resource_group\": \"customer-rg\",\n \"account_name\": \"customerstorage\",\n \"container\": \"openai-data\",\n \"region\": \"eastus\"\n },\n \"geography\": \"US\",\n \"status\": \"validated\",\n \"created_at\": 1711471533\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": null, "node": null }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/external_storage/extstorage_azure123/validate \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/spend_limit", "name": "Get organization spend limit", "operation_id": "Getorganizationspendlimit", "tags": [], "description": "Get the organization's hard spend limit.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "OrganizationSpendLimitResource", "object": "organization.spend_limit", "fields": [ "object", "threshold_amount", "currency", "interval", "enforcement" ], "example": "{\n \"object\": \"organization.spend_limit\",\n \"threshold_amount\": 10000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"enforcement\": {\n \"status\": \"enforcing\"\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.spend_limit.retrieve() -> OrganizationSpendLimit", "node": "client.admin.organization.spendLimit.retrieve() -> OrganizationSpendLimit" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/spend_limit \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "project key -> 403: You have insufficient permissions for this operation. Missing scopes: api.management.read. Check that you have the correct role in your organization, and if you're using a restricted API key, that it has the necessary scopes." }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/spend_limit", "name": "Update organization spend limit", "operation_id": "Updateorganizationspendlimit", "tags": [], "description": "Create or replace the organization's hard spend limit.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "UpdateOrganizationSpendLimitBody" }, "response": { "status": 200, "schema_ref": "OrganizationSpendLimitResource", "object": "organization.spend_limit", "fields": [ "object", "threshold_amount", "currency", "interval", "enforcement" ], "example": "{\n \"object\": \"organization.spend_limit\",\n \"threshold_amount\": 10000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"enforcement\": {\n \"status\": \"enforcing\"\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.spend_limit.update(**params) -> OrganizationSpendLimit", "node": "client.admin.organization.spendLimit.update({ ...params }) -> OrganizationSpendLimit" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/spend_limit \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"threshold_amount\": 10000,\n \"currency\": \"USD\",\n \"interval\": \"month\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/spend_limit", "name": "Delete organization spend limit", "operation_id": "Deleteorganizationspendlimit", "tags": [], "description": "Delete the organization's hard spend limit.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "OrganizationSpendLimitDeletedResource", "object": "organization.spend_limit.deleted", "fields": [ "object", "deleted" ], "example": "{\n \"object\": \"organization.spend_limit.deleted\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.spend_limit.delete() -> OrganizationSpendLimitDeleted", "node": "client.admin.organization.spendLimit.delete() -> OrganizationSpendLimitDeleted" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/spend_limit \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "GET", "path": "/v1/organization/projects/{project_id}/spend_limit", "name": "Get project spend limit", "operation_id": "Getprojectspendlimit", "tags": [], "description": "Get a project's hard spend limit.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [ "api.management.read" ], "documented_scopes": [], "note": null, "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectSpendLimitResource", "object": "project.spend_limit", "fields": [ "object", "threshold_amount", "currency", "interval", "enforcement" ], "example": "{\n \"object\": \"project.spend_limit\",\n \"threshold_amount\": 10000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"enforcement\": {\n \"status\": \"enforcing\"\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.spend_limit.retrieve(project_id) -> ProjectSpendLimit", "node": "client.admin.organization.projects.spendLimit.retrieve(projectID) -> ProjectSpendLimit" }, "examples": { "curl": "curl https://api.openai.com/v1/organization/projects/proj_abc/spend_limit \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/spend_limit", "name": "Update project spend limit", "operation_id": "Updateprojectspendlimit", "tags": [], "description": "Create or replace a project's hard spend limit.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "UpdateProjectSpendLimitBody" }, "response": { "status": 200, "schema_ref": "ProjectSpendLimitResource", "object": "project.spend_limit", "fields": [ "object", "threshold_amount", "currency", "interval", "enforcement" ], "example": "{\n \"object\": \"project.spend_limit\",\n \"threshold_amount\": 10000,\n \"currency\": \"USD\",\n \"interval\": \"month\",\n \"enforcement\": {\n \"status\": \"enforcing\"\n }\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.spend_limit.update(project_id, **params) -> ProjectSpendLimit", "node": "client.admin.organization.projects.spendLimit.update(projectID, { ...params }) -> ProjectSpendLimit" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/spend_limit \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"threshold_amount\": 10000,\n \"currency\": \"USD\",\n \"interval\": \"month\"\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "DELETE", "path": "/v1/organization/projects/{project_id}/spend_limit", "name": "Delete project spend limit", "operation_id": "Deleteprojectspendlimit", "tags": [], "description": "Delete a project's hard spend limit.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "ProjectSpendLimitDeletedResource", "object": "project.spend_limit.deleted", "fields": [ "object", "deleted" ], "example": "{\n \"object\": \"project.spend_limit.deleted\",\n \"deleted\": true\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": "client.admin.organization.projects.spend_limit.delete(project_id) -> ProjectSpendLimitDeleted", "node": "client.admin.organization.projects.spendLimit.delete(projectID) -> ProjectSpendLimitDeleted" }, "examples": { "curl": "curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/spend_limit \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\"\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "admin", "method": "POST", "path": "/v1/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys", "name": "Create an API key for a service account", "operation_id": "CreateanAPIkeyforaserviceaccount", "tags": [], "description": "Creates an API key for a service account in the project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "admin_api_key", "observed_read_scope": [], "documented_scopes": [], "note": "Write scope not observed (we never call mutating admin endpoints); the corresponding *.write scope (or api.management.write) is expected.", "note_admin": "Admin API keys are created at platform.openai.com/settings/organization/admin-keys; they cannot call non-admin endpoints. Workload-identity access tokens cannot call Admin endpoints." }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateProjectServiceAccountApiKeyBody" }, "response": { "status": 200, "schema_ref": "ServiceAccountApiKeyBody", "object": "organization.project.service_account.api_key", "fields": [ "object", "value", "name", "created_at", "expires_at", "id" ], "example": "{\n \"object\": \"organization.project.service_account.api_key\",\n \"value\": \"sk-abcdefghijklmnop123\",\n \"name\": \"Production App\",\n \"created_at\": 1711471533,\n \"id\": \"key_abc\"\n}\n" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": "client.admin.organization.projects.service_accounts.api_keys.create(service_account_id, *, project_id, **params) -> APIKeyCreateResponse", "node": "client.admin.organization.projects.serviceAccounts.apiKeys.create(serviceAccountID, { ...params }) -> APIKeyCreateResponse" }, "examples": { "curl": "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/service_accounts/svc_acct_abc/api_keys \\\n -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Production App\",\n \"scopes\": [\"api.responses.write\"]\n }'\n" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/admin-apis", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/administration/overview", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-admin.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "GET", "path": "/v1/assistants", "name": "listAssistants", "summary": "List assistants", "description": "Returns a list of assistants.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "limit", "order", "after", "before" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ListAssistantsResponse", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after", "before" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.assistants.list()", "node": "client.beta.assistants.list()" }, "relations": [], "deprecated_in_spec": true, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "GET /v1/assistants?limit=1 and GET /v1/threads/thread_doesnotexist with OpenAI-Beta: assistants=v2 -> HTTP 404 with EMPTY body (no JSON error). API sunset 2026-08-26." }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "POST", "path": "/v1/assistants", "name": "createAssistant", "summary": "Create assistant", "description": "Create an assistant with a model and instructions.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": "application/json", "body_ref": "CreateAssistantRequest", "path_params": [], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "AssistantObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.assistants.create()", "node": "client.beta.assistants.create()" }, "relations": [], "deprecated_in_spec": true, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "GET", "path": "/v1/assistants/{assistant_id}", "name": "getAssistant", "summary": "Retrieve assistant", "description": "Retrieves an assistant.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": null, "body_ref": null, "path_params": [ "assistant_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "AssistantObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.assistants.retrieve()", "node": "client.beta.assistants.retrieve()" }, "relations": [], "deprecated_in_spec": true, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "POST", "path": "/v1/assistants/{assistant_id}", "name": "modifyAssistant", "summary": "Modify assistant", "description": "Modifies an assistant.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": "application/json", "body_ref": "ModifyAssistantRequest", "path_params": [ "assistant_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "AssistantObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.assistants.update()", "node": "client.beta.assistants.update()" }, "relations": [], "deprecated_in_spec": true, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "DELETE", "path": "/v1/assistants/{assistant_id}", "name": "deleteAssistant", "summary": "Delete assistant", "description": "Delete an assistant.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": null, "body_ref": null, "path_params": [ "assistant_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "DeleteAssistantResponse", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.assistants.delete()", "node": "client.beta.assistants.delete()" }, "relations": [], "deprecated_in_spec": true, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "POST", "path": "/v1/threads", "name": "createThread", "summary": "Create thread", "description": "Create a thread.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": "application/json", "body_ref": "CreateThreadRequest", "path_params": [], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ThreadObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.create()", "node": "client.beta.threads.create()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "POST", "path": "/v1/threads/runs", "name": "createThreadAndRun", "summary": "Create thread and run", "description": "Create a thread and run it in one request.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": "application/json", "body_ref": "CreateThreadAndRunRequest", "path_params": [], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "RunObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.create_and_run()", "node": "client.beta.threads.createAndRun()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "GET", "path": "/v1/threads/{thread_id}", "name": "getThread", "summary": "Retrieve thread", "description": "Retrieves a thread.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": null, "body_ref": null, "path_params": [ "thread_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ThreadObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.retrieve()", "node": "client.beta.threads.retrieve()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "GET /v1/assistants?limit=1 and GET /v1/threads/thread_doesnotexist with OpenAI-Beta: assistants=v2 -> HTTP 404 with EMPTY body (no JSON error). API sunset 2026-08-26." }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "POST", "path": "/v1/threads/{thread_id}", "name": "modifyThread", "summary": "Modify thread", "description": "Modifies a thread.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": "application/json", "body_ref": "ModifyThreadRequest", "path_params": [ "thread_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ThreadObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.update()", "node": "client.beta.threads.update()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "DELETE", "path": "/v1/threads/{thread_id}", "name": "deleteThread", "summary": "Delete thread", "description": "Delete a thread.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": null, "body_ref": null, "path_params": [ "thread_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "DeleteThreadResponse", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.delete()", "node": "client.beta.threads.delete()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "GET", "path": "/v1/threads/{thread_id}/messages", "name": "listMessages", "summary": "List messages", "description": "Returns a list of messages for a given thread.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": null, "body_ref": null, "path_params": [ "thread_id" ], "query_params": [ "limit", "order", "after", "before", "run_id" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ListMessagesResponse", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after", "before", "run_id" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.threads.messages.list()", "node": "client.beta.threads.messages.list()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "POST", "path": "/v1/threads/{thread_id}/messages", "name": "createMessage", "summary": "Create message", "description": "Create a message.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": "application/json", "body_ref": "CreateMessageRequest", "path_params": [ "thread_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "MessageObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.messages.create()", "node": "client.beta.threads.messages.create()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "GET", "path": "/v1/threads/{thread_id}/messages/{message_id}", "name": "getMessage", "summary": "Retrieve message", "description": "Retrieve a message.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": null, "body_ref": null, "path_params": [ "thread_id", "message_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "MessageObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.messages.retrieve()", "node": "client.beta.threads.messages.retrieve()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "POST", "path": "/v1/threads/{thread_id}/messages/{message_id}", "name": "modifyMessage", "summary": "Modify message", "description": "Modifies a message.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": "application/json", "body_ref": "ModifyMessageRequest", "path_params": [ "thread_id", "message_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "MessageObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.messages.update()", "node": "client.beta.threads.messages.update()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "DELETE", "path": "/v1/threads/{thread_id}/messages/{message_id}", "name": "deleteMessage", "summary": "Delete message", "description": "Deletes a message.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": null, "body_ref": null, "path_params": [ "thread_id", "message_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "DeleteMessageResponse", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.messages.delete()", "node": "client.beta.threads.messages.delete()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "GET", "path": "/v1/threads/{thread_id}/runs", "name": "listRuns", "summary": "List runs", "description": "Returns a list of runs belonging to a thread.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": null, "body_ref": null, "path_params": [ "thread_id" ], "query_params": [ "limit", "order", "after", "before" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ListRunsResponse", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after", "before" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.threads.runs.list()", "node": "client.beta.threads.runs.list()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "POST", "path": "/v1/threads/{thread_id}/runs", "name": "createRun", "summary": "Create run", "description": "Create a run.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": "application/json", "body_ref": "CreateRunRequest", "path_params": [ "thread_id" ], "query_params": [ "include[]" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "RunObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.runs.create()", "node": "client.beta.threads.runs.create()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "GET", "path": "/v1/threads/{thread_id}/runs/{run_id}", "name": "getRun", "summary": "Retrieve run", "description": "Retrieves a run.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": null, "body_ref": null, "path_params": [ "thread_id", "run_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "RunObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.runs.retrieve()", "node": "client.beta.threads.runs.retrieve()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "POST", "path": "/v1/threads/{thread_id}/runs/{run_id}", "name": "modifyRun", "summary": "Modify run", "description": "Modifies a run.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": "application/json", "body_ref": "ModifyRunRequest", "path_params": [ "thread_id", "run_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "RunObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.runs.update()", "node": "client.beta.threads.runs.update()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "POST", "path": "/v1/threads/{thread_id}/runs/{run_id}/cancel", "name": "cancelRun", "summary": "Cancel a run", "description": "Cancels a run that is `in_progress`.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": null, "body_ref": null, "path_params": [ "thread_id", "run_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "RunObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.runs.cancel()", "node": "client.beta.threads.runs.cancel()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "GET", "path": "/v1/threads/{thread_id}/runs/{run_id}/steps", "name": "listRunSteps", "summary": "List run steps", "description": "Returns a list of run steps belonging to a run.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": null, "body_ref": null, "path_params": [ "thread_id", "run_id" ], "query_params": [ "limit", "order", "after", "before", "include[]" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ListRunStepsResponse", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after", "before", "include[]" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.threads.runs.steps.list()", "node": "client.beta.threads.runs.steps.list()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "GET", "path": "/v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}", "name": "getRunStep", "summary": "Retrieve run step", "description": "Retrieves a run step.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": null, "body_ref": null, "path_params": [ "thread_id", "run_id", "step_id" ], "query_params": [ "include[]" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "RunStepObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.runs.steps.retrieve()", "node": "client.beta.threads.runs.steps.retrieve()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/assistants", "method": "POST", "path": "/v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs", "name": "submitToolOuputsToRun", "summary": "Submit tool outputs to run", "description": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.", "status": [ "RETIRED", "DOCUMENTED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: assistants=v2 (historical)", "beta_gating": "n/a (retired)", "request": { "content_type": "application/json", "body_ref": "SubmitToolOutputsRunRequest", "path_params": [ "thread_id", "run_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "RunObject", "error_statuses": [ 429 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.threads.runs.submit_tool_outputs()", "node": "client.beta.threads.runs.submitToolOutputs()" }, "relations": [], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "failure", "http_status": null, "request_note": "not called; sibling probes returned 404 empty body — API retired 2026-08-26" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/assistants", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/assistants/migration", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/deprecations#2025-08-20-assistants-api", "retrieved_at": "2026-09-18T00:00:00Z" } ], "retirement": { "announced": "2025-08-26", "retired": "2026-08-26", "replacement": "Responses API (+ Conversations API); Prompts replace Assistants; Items replace Run steps", "live_observation": "HTTP 404, empty body" }, "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/chatkit", "method": "POST", "path": "/v1/chatkit/sessions/{session_id}/cancel", "name": "CancelChatSessionMethod", "summary": "Cancel a ChatKit session", "description": "Cancel an active ChatKit session and return its most recent metadata.\n\nCancelling prevents new requests from using the issued client secret.", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: chatkit_beta=v1", "beta_gating": "Required per spec x-oaiMeta beta=true", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ChatSessionResource", "error_statuses": [] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.chatkit.sessions.cancel()", "node": "client.beta.chatkit.sessions.cancel()" }, "relations": [ "references: Agent Builder workflow (workflow.id) — Agent Builder shuts down 2026-11-30" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/chatkit", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/chatkit", "method": "POST", "path": "/v1/chatkit/sessions", "name": "CreateChatSessionMethod", "summary": "Create a ChatKit session", "description": "Create a ChatKit session.", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: chatkit_beta=v1", "beta_gating": "Required per spec x-oaiMeta beta=true", "request": { "content_type": "application/json", "body_ref": "CreateChatSessionBody", "path_params": [], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ChatSessionResource", "error_statuses": [] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.chatkit.sessions.create()", "node": "client.beta.chatkit.sessions.create()" }, "relations": [ "references: Agent Builder workflow (workflow.id) — Agent Builder shuts down 2026-11-30" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/chatkit", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/chatkit", "method": "GET", "path": "/v1/chatkit/threads/{thread_id}/items", "name": "ListThreadItemsMethod", "summary": "List ChatKit thread items", "description": "List items that belong to a ChatKit thread.", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: chatkit_beta=v1", "beta_gating": "Required per spec x-oaiMeta beta=true", "request": { "content_type": null, "body_ref": null, "path_params": [ "thread_id" ], "query_params": [ "limit", "order", "after", "before" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ThreadItemListResource", "error_statuses": [] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after", "before" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.chatkit.threads.list_items()", "node": "client.beta.chatkit.threads.listItems()" }, "relations": [ "belongs_to: chatkit.session scope (user); thread has_many chatkit.thread_item" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/chatkit", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/chatkit", "method": "GET", "path": "/v1/chatkit/threads/{thread_id}", "name": "GetThreadMethod", "summary": "Retrieve a ChatKit thread", "description": "Retrieve a ChatKit thread by its identifier.", "status": [ "DOCUMENTED", "BETA", "LIVE_DISCOVERED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: chatkit_beta=v1", "beta_gating": "Required per spec x-oaiMeta beta=true", "request": { "content_type": null, "body_ref": null, "path_params": [ "thread_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ThreadResource", "error_statuses": [] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.chatkit.threads.retrieve()", "node": "client.beta.chatkit.threads.retrieve()" }, "relations": [ "belongs_to: chatkit.session scope (user); thread has_many chatkit.thread_item" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 404, "request_note": "bogus id -> invalid_request_error \"ChatKit Thread with id 'cthr_doesnotexist' not found.\" (route exists)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/chatkit", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/chatkit", "method": "DELETE", "path": "/v1/chatkit/threads/{thread_id}", "name": "DeleteThreadMethod", "summary": "Delete a ChatKit thread", "description": "Delete a ChatKit thread along with its items and stored attachments.", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: chatkit_beta=v1", "beta_gating": "Required per spec x-oaiMeta beta=true", "request": { "content_type": null, "body_ref": null, "path_params": [ "thread_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "DeletedThreadResource", "error_statuses": [] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.chatkit.threads.delete()", "node": "client.beta.chatkit.threads.delete()" }, "relations": [ "belongs_to: chatkit.session scope (user); thread has_many chatkit.thread_item" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/chatkit", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/chatkit", "method": "GET", "path": "/v1/chatkit/threads", "name": "ListThreadsMethod", "summary": "List ChatKit threads", "description": "List ChatKit threads with optional pagination and user filters.", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key", "beta_header": "OpenAI-Beta: chatkit_beta=v1", "beta_gating": "Required per spec x-oaiMeta beta=true", "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "limit", "order", "after", "before", "user" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "ThreadListResource", "error_statuses": [] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after", "before", "user" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.chatkit.threads.list()", "node": "client.beta.chatkit.threads.list()" }, "relations": [ "belongs_to: chatkit.session scope (user); thread has_many chatkit.thread_item" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "empty list with OpenAI-Beta: chatkit_beta=v1" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/chatkit", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/environments/{environment_id}", "name": "retrieveAgentEnvironment", "summary": "Retrieve an agent environment", "description": "Retrieves an execution environment's connection status and safe installed metadata. See [environment lifecycle](https://developers.openai.com/api/docs/guides/agents-api/environments/lifecycle).", "status": [ "DOCUMENTED", "BETA", "LIVE_DISCOVERED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "environment_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "PublicEnvironmentResource", "error_statuses": [ 400, 401, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.environments.retrieve()", "node": "client.beta.agents.environments.retrieve()" }, "relations": [ "belongs_to: agent.session (session.environment.id); file operations require status connected" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 404, "request_note": "bogus id -> not_found_error \"No managed agent resource found: env_doesnotexist\" (route exists)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/environments/{environment_id}/files", "name": "listAgentEnvironmentFiles", "summary": "List agent environment files", "description": "Lists live files on a connected execution environment with optional directory filtering and opaque cursor pagination. See [environment files](https://developers.openai.com/api/docs/guides/agents-api/environments/files).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "environment_id" ], "query_params": [ "path", "limit", "order", "page" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "EnvironmentFileListResource", "error_statuses": [ 400, 401, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "path", "limit", "order", "page" ], "response_fields": [ "data", "next", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.agents.environments.files.list()", "node": "client.beta.agents.environments.files.list()" }, "relations": [ "belongs_to: agent.session (session.environment.id); file operations require status connected" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "POST", "path": "/v1/agents/environments/{environment_id}/files", "name": "createAgentEnvironmentFile", "summary": "Create an agent environment file", "description": "Copies inline bytes or a Files API file into a connected execution environment. See [environment files](https://developers.openai.com/api/docs/guides/agents-api/environments/files).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": "application/json", "body_ref": "HostedEnvironmentFileParam", "path_params": [ "environment_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 201, "content_type": "application/json", "body_ref": "EnvironmentFileResource", "error_statuses": [ 400, 401, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.environments.files.create()", "node": "client.beta.agents.environments.files.create()" }, "relations": [ "belongs_to: agent.session (session.environment.id); file operations require status connected" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}/subagents", "name": "listAgentSessionSubagents", "summary": "List session subagents", "description": "Lists subagents in a session, including nested and closed subagents. See [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [ "limit", "order", "after" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "inline", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.subagents.list()", "node": "client.beta.agents.sessions.subagents.list()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "empty list (multi_agent disabled)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}/subagents/{subagent_id}", "name": "retrieveAgentSessionSubagent", "summary": "Retrieve a session subagent", "description": "Retrieves a subagent belonging to this session. See [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "subagent_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "SubagentResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.subagents.retrieve()", "node": "client.beta.agents.sessions.subagents.retrieve()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})", "belongs_to: agent.session.subagent" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}/subagents/{subagent_id}/items", "name": "listAgentSessionSubagentItems", "summary": "List subagent items", "description": "Lists this subagent's own items across all of its turns. See [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "subagent_id" ], "query_params": [ "limit", "order", "after" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "SessionItemListResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.subagents.items.list()", "node": "client.beta.agents.sessions.subagents.items.list()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})", "belongs_to: agent.session.subagent" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns", "name": "listAgentSessionSubagentTurns", "summary": "List subagent turns", "description": "Lists all turns of this subagent, including turns after a resume. See [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "subagent_id" ], "query_params": [ "limit", "order", "after" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "SessionTurnListResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.subagents.turns.list()", "node": "client.beta.agents.sessions.subagents.turns.list()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})", "belongs_to: agent.session.subagent" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}", "name": "retrieveAgentSessionSubagentTurn", "summary": "Retrieve a subagent turn", "description": "Retrieves a turn belonging to this subagent. See [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "subagent_id", "turn_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "TurnResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.subagents.turns.retrieve()", "node": "client.beta.agents.sessions.subagents.turns.retrieve()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})", "belongs_to: agent.session.subagent", "belongs_to: agent.session.turn" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}/items", "name": "listAgentSessionSubagentTurnItems", "summary": "List subagent turn items", "description": "Lists items belonging to one turn of this subagent. See [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "subagent_id", "turn_id" ], "query_params": [ "limit", "order", "after" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "SessionItemListResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.subagents.turns.items.list()", "node": "client.beta.agents.sessions.subagents.turns.items.list()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})", "belongs_to: agent.session.subagent", "belongs_to: agent.session.turn" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents", "name": "listAgents", "summary": "List agents", "description": "Lists reusable agents in the current project. See [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "limit", "order", "after" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "AgentListResource", "error_statuses": [ 400, 401, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.agents.list()", "node": "client.beta.agents.list()" }, "relations": [ "used_by: POST /agents/sessions (agent_id); sessions copy the config at creation" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "list agents with OpenAI-Beta: agents=v1 (empty list). Without the header: 400 invalid_beta" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "POST", "path": "/v1/agents", "name": "createAgent", "summary": "Create an agent", "description": "Creates a reusable agent without storing credentials. See [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": "application/json", "body_ref": "CreateAgentParams", "path_params": [], "query_params": [], "header_params": [] }, "response": { "success_status": 201, "content_type": "application/json", "body_ref": "AgentResource", "error_statuses": [ 400, 401, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.create()", "node": "client.beta.agents.create()" }, "relations": [ "used_by: POST /agents/sessions (agent_id); sessions copy the config at creation" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 201, "request_note": "created agent gpt-5.6-luna, instructions \"Reply with OK.\" (gpt-5.4-nano rejected: \"not supported by Managed Agents\")" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/{agent_id}", "name": "retrieveAgent", "summary": "Retrieve an agent", "description": "Retrieves a reusable agent by ID. See [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "agent_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "AgentResource", "error_statuses": [ 400, 401, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.retrieve()", "node": "client.beta.agents.retrieve()" }, "relations": [ "used_by: POST /agents/sessions (agent_id); sessions copy the config at creation" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "examples/create_agent.py: retrieved the agent just created" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "POST", "path": "/v1/agents/{agent_id}", "name": "updateAgent", "summary": "Update an agent", "description": "Updates a reusable agent. See [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": "application/json", "body_ref": "UpdateAgentParams", "path_params": [ "agent_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "AgentResource", "error_statuses": [ 400, 401, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.update()", "node": "client.beta.agents.update()" }, "relations": [ "used_by: POST /agents/sessions (agent_id); sessions copy the config at creation" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "DELETE", "path": "/v1/agents/{agent_id}", "name": "deleteAgent", "summary": "Delete an agent", "description": "Deletes a reusable agent. See [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "agent_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "DeletedAgentResource", "error_statuses": [ 400, 401, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.delete()", "node": "client.beta.agents.delete()" }, "relations": [ "used_by: POST /agents/sessions (agent_id); sessions copy the config at creation" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "deleted probe agent -> object agent.deleted" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/environments/templates", "name": "listAgentEnvironmentTemplates", "summary": "List agent environment templates", "description": "Lists reusable environment templates without returning confidential values. See [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "limit", "order", "after" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "EnvironmentTemplateListResource", "error_statuses": [ 400, 401, 403, 404, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.agents.environments.templates.list()", "node": "client.beta.agents.environments.templates.list()" }, "relations": [ "used_by: POST /agents/sessions (environment.environment_template_id, openai_hosted only)" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "empty list" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "POST", "path": "/v1/agents/environments/templates", "name": "createAgentEnvironmentTemplate", "summary": "Create an agent environment template", "description": "Creates reusable environment configuration without returning confidential setup commands or environment values. See [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": "application/json", "body_ref": "CreateEnvironmentTemplateParams", "path_params": [], "query_params": [], "header_params": [] }, "response": { "success_status": 201, "content_type": "application/json", "body_ref": "EnvironmentTemplateResource", "error_statuses": [ 400, 401, 403, 404, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.environments.templates.create()", "node": "client.beta.agents.environments.templates.create()" }, "relations": [ "used_by: POST /agents/sessions (environment.environment_template_id, openai_hosted only)" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 201, "request_note": "examples/environment_template_create.*: created template (packages.python, setup_commands, network restricted + allowed_domains, env, inline file) -> envtmpl_…; setup_commands/env not echoed; inline file returned as {type,path,size_bytes}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/environments/templates/{environment_template_id}", "name": "retrieveAgentEnvironmentTemplate", "summary": "Retrieve an agent environment template", "description": "Retrieves reusable environment configuration without returning confidential values. See [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "environment_template_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "EnvironmentTemplateResource", "error_statuses": [ 400, 401, 403, 404, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.environments.templates.retrieve()", "node": "client.beta.agents.environments.templates.retrieve()" }, "relations": [ "used_by: POST /agents/sessions (environment.environment_template_id, openai_hosted only)" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "examples/environment_template_create.*: retrieved template" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "POST", "path": "/v1/agents/environments/templates/{environment_template_id}", "name": "updateAgentEnvironmentTemplate", "summary": "Update an agent environment template", "description": "Updates reusable environment configuration without returning confidential values. See [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": "application/json", "body_ref": "UpdateEnvironmentTemplateParams", "path_params": [ "environment_template_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "EnvironmentTemplateResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.environments.templates.update()", "node": "client.beta.agents.environments.templates.update()" }, "relations": [ "used_by: POST /agents/sessions (environment.environment_template_id, openai_hosted only)" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "examples/environment_template_create.py: updated name only; network preserved" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "DELETE", "path": "/v1/agents/environments/templates/{environment_template_id}", "name": "deleteAgentEnvironmentTemplate", "summary": "Delete an agent environment template", "description": "Deletes reusable environment configuration and all confidential template inputs. See [reusing a hosted setup](https://developers.openai.com/api/docs/guides/agents-api/tools#reuse-a-hosted-plugin-setup).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "environment_template_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "DeletedEnvironmentTemplateResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.environments.templates.delete()", "node": "client.beta.agents.environments.templates.delete()" }, "relations": [ "used_by: POST /agents/sessions (environment.environment_template_id, openai_hosted only)" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "examples/environment_template_create.*: -> object agent.environment.template.deleted" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions", "name": "listAgentSessions", "summary": "List agent sessions", "description": "Lists managed agent sessions using ID-based pagination and the requested sort order. See [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "limit", "order", "agent_id", "after" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "SessionListResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "agent_id", "after" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.list()", "node": "client.beta.agents.sessions.list()" }, "relations": [ "references: agent (agent_id, optional)", "references: agent.environment.template (environment.environment_template_id, optional)", "references: vault (vault_ids[])", "has_many: agent.session.turn, agent.session.item, agent.session.subagent, agent.session.artifact, events" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "list sessions (empty list)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "POST", "path": "/v1/agents/sessions", "name": "createAgentSession", "summary": "Create an agent session", "description": "Creates a managed agent session, optionally submits initial input, and returns the session or streams its events when stream is true. See [running sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": "application/json", "body_ref": "CreateAgentSessionParams", "path_params": [], "query_params": [], "header_params": [] }, "response": { "success_status": 201, "content_type": "application/json", "body_ref": "SessionResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": true, "events_ref": "generated/fragments/streaming-events/openai-agents.json", "note": "POST /agents/sessions with \"stream\": true returns text/event-stream for the first turn; otherwise JSON SessionResource" }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.create()", "node": "client.beta.agents.sessions.create()" }, "relations": [ "references: agent (agent_id, optional)", "references: agent.environment.template (environment.environment_template_id, optional)", "references: vault (vault_ids[])", "has_many: agent.session.turn, agent.session.item, agent.session.subagent, agent.session.artifact, events" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 201, "request_note": "created session env=none, agent_id, input \"Reply with OK.\", stream=true; SSE with 13 events ending agent.session.turn.completed; output \"OK.\"" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}", "name": "retrieveAgentSession", "summary": "Retrieve an agent session", "description": "Retrieves the current state of a managed agent session. See [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "SessionResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.retrieve()", "node": "client.beta.agents.sessions.retrieve()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "retrieved session (status idle, usage null)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "POST", "path": "/v1/agents/sessions/{session_id}", "name": "updateAgentSession", "summary": "Update an agent session", "description": "Updates session metadata, model, reasoning effort, or service tier. Model settings apply to subsequent turns. Omitted fields are unchanged. See [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": "application/json", "body_ref": "UpdateAgentSessionParams", "path_params": [ "session_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "SessionResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.update()", "node": "client.beta.agents.sessions.update()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "updated metadata only" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "DELETE", "path": "/v1/agents/sessions/{session_id}", "name": "deleteAgentSession", "summary": "Delete an agent session", "description": "Removes a managed agent session from the public API and returns a deletion confirmation. If backend execution has ended, deletion can cancel a still-open public turn and abandon unpublished outputs. Running execution must be cancelled first. Physical cleanup may continue asynchronously. See [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "DeletedSessionResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "Idempotent delete; may return 409 while setup/execution is in progress — retry with a limit", "sdk": { "python": "client.beta.agents.sessions.delete()", "node": "client.beta.agents.sessions.delete()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "deleted -> agent.session.deleted; later GET -> 404 not_found_error \"No managed agent session found\"" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}/artifacts", "name": "listAgentSessionArtifacts", "summary": "List agent session artifacts", "description": "Lists immutable artifacts published by completed hosted session turns. See [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [ "order", "environment_id", "limit", "after" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "SessionArtifactListResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "order", "environment_id", "limit", "after" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.artifacts.list()", "node": "client.beta.agents.sessions.artifacts.list()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "empty list for environment.type none" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}/artifacts/{artifact_id}", "name": "retrieveAgentSessionArtifact", "summary": "Retrieve an agent session artifact", "description": "Retrieves immutable metadata for one durable session artifact. See [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "artifact_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "SessionArtifactResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.artifacts.retrieve()", "node": "client.beta.agents.sessions.artifacts.retrieve()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})", "belongs_to: agent.session.artifact" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "DELETE", "path": "/v1/agents/sessions/{session_id}/artifacts/{artifact_id}", "name": "deleteAgentSessionArtifact", "summary": "Delete an agent session artifact", "description": "Deletes an immutable session artifact without deleting its live environment file or original Files API object. See [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "artifact_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "DeletedSessionArtifactResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.artifacts.delete()", "node": "client.beta.agents.sessions.artifacts.delete()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})", "belongs_to: agent.session.artifact" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}/artifacts/{artifact_id}/content", "name": "retrieveAgentSessionArtifactContent", "summary": "Retrieve agent session artifact content", "description": "Downloads immutable session artifact bytes after the execution environment expires. See [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "artifact_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/octet-stream", "body_ref": "inline", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.artifacts.content()", "node": "client.beta.agents.sessions.artifacts.content()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})", "belongs_to: agent.session.artifact" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}/events", "name": "listAgentSessionEvents", "summary": "Stream agent session events", "description": "Streams live events for an agent session. See [session events](https://developers.openai.com/api/docs/guides/agents-api/sessions/events).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "text/event-stream", "body_ref": "SessionEvent", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": true, "events_ref": "generated/fragments/streaming-events/openai-agents.json", "note": "GET ...?stream=true with Accept: text/event-stream; no replay of missed events; subagent turn events do not end the stream" }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.events.stream()", "node": "client.beta.agents.sessions.events.stream()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "GET ...?stream=true opened before follow-up input; received 12 events for the second turn" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "POST", "path": "/v1/agents/sessions/{session_id}/events", "name": "createAgentSessionEvents", "summary": "Create agent session input events", "description": "Submits message, cancellation, or tool-result events to a managed agent session. Cancellation can recover a still-open turn whose backend execution has ended by marking it cancelled and abandoning unpublished outputs. Saved results, published files, and existing terminal outcomes are preserved. HTTP 202 confirms acceptance, not durable completion. See [session events](https://developers.openai.com/api/docs/guides/agents-api/sessions/events).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": "application/json", "body_ref": "CreateSessionEventsParams", "path_params": [ "session_id" ], "query_params": [], "header_params": [ "Idempotency-Key" ] }, "response": { "success_status": 202, "content_type": null, "body_ref": null, "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "Idempotency-Key request header (optional) makes retries of submitted input events idempotent", "sdk": { "python": "client.beta.agents.sessions.events.create()", "node": "client.beta.agents.sessions.events.create()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 202, "request_note": "agent.session.input.message with Idempotency-Key -> 202 empty body; agent.session.input.cancel on idle session -> 202 empty body" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}/items", "name": "listAgentSessionItems", "summary": "List agent session items", "description": "Lists items produced by the session's root agent, including its interactions with subagents. Each subagent has its own item history. See [inspecting agent output](https://developers.openai.com/api/docs/guides/agents-api/observability).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [ "limit", "order", "after" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "SessionItemListResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.items.list()", "node": "client.beta.agents.sessions.items.list()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "2 items (user message + assistant message phase final_answer)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}/turns", "name": "listAgentSessionTurns", "summary": "List agent session turns", "description": "Lists turns by creation time and turn ID. The after cursor is exclusive in the selected order. See [session turns](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage#inspect-session-turns).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [ "limit", "order", "after" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "SessionTurnListResource", "error_statuses": [ 400, 401, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.turns.list()", "node": "client.beta.agents.sessions.turns.list()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "1 turn, status completed, usage null in list" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}/turns/{turn_id}", "name": "retrieveAgentSessionTurn", "summary": "Retrieve an agent session turn", "description": "Retrieves a turn's current status, timestamps, usage, and error. Returns 404 if the turn does not belong to the session. See [session turns](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage#inspect-session-turns).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.agents.read, api.agents.write, api.responses.write (inference)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id", "turn_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "TurnResource", "error_statuses": [ 400, 401, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.sessions.turns.retrieve()", "node": "client.beta.agents.sessions.turns.retrieve()" }, "relations": [ "belongs_to: agent.session (GET /agents/sessions/{session_id})", "belongs_to: agent.session.turn" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "turn with usage input_tokens 6087 / output_tokens 6 (env none, no tools)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/quickstart", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/vaults", "method": "GET", "path": "/v1/vaults", "name": "listVaults", "summary": "List vaults", "description": "Lists vaults using ID-based pagination. See [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [ "order", "limit", "status", "after" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "VaultListResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "order", "limit", "status", "after" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.agents.vaults.list()", "node": "client.beta.agents.vaults.list()" }, "relations": [ "used_by: POST /agents/sessions (vault_ids[]) ; MCP tool credential_id" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "empty list" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/vaults", "method": "POST", "path": "/v1/vaults", "name": "createVault", "summary": "Create a vault", "description": "Creates a vault for the current project. See [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": "application/json", "body_ref": "CreateVaultParams", "path_params": [], "query_params": [], "header_params": [] }, "response": { "success_status": 201, "content_type": "application/json", "body_ref": "VaultResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.vaults.create()", "node": "client.beta.agents.vaults.create()" }, "relations": [ "used_by: POST /agents/sessions (vault_ids[]) ; MCP tool credential_id" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/vaults", "method": "GET", "path": "/v1/vaults/{vault_id}", "name": "retrieveVault", "summary": "Retrieve a vault", "description": "Retrieves a vault by its ID. See [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).", "status": [ "DOCUMENTED", "BETA", "LIVE_DISCOVERED" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "vault_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "VaultResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.vaults.retrieve()", "node": "client.beta.agents.vaults.retrieve()" }, "relations": [ "used_by: POST /agents/sessions (vault_ids[]) ; MCP tool credential_id" ], "deprecated_in_spec": false, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 404, "request_note": "bogus id -> not_found_error \"No vault resource found: vault_doesnotexist\" (route exists)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/vaults", "method": "DELETE", "path": "/v1/vaults/{vault_id}", "name": "deleteVault", "summary": "Delete a vault", "description": "Deletes a vault and all its credentials. See [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "vault_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "DeletedVaultResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.vaults.delete()", "node": "client.beta.agents.vaults.delete()" }, "relations": [ "used_by: POST /agents/sessions (vault_ids[]) ; MCP tool credential_id" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/vaults", "method": "GET", "path": "/v1/vaults/{vault_id}/credentials", "name": "listVaultCredentials", "summary": "List vault credentials", "description": "Lists a vault's credentials using ID-based pagination without returning secret values. See [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "vault_id" ], "query_params": [ "order", "limit", "status", "after" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "VaultCredentialListResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "order", "limit", "status", "after" ], "response_fields": [ "data", "first_id", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": "client.beta.agents.vaults.credentials.list()", "node": "client.beta.agents.vaults.credentials.list()" }, "relations": [ "belongs_to: vault", "used_by: POST /agents/sessions (vault_ids[]) ; MCP tool credential_id" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/vaults", "method": "POST", "path": "/v1/vaults/{vault_id}/credentials", "name": "createVaultCredential", "summary": "Create a vault credential", "description": "Creates a vault credential. Secret values are write-only and are never returned. See [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": "application/json", "body_ref": "CreateVaultCredentialParams", "path_params": [ "vault_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 201, "content_type": "application/json", "body_ref": "VaultCredentialResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.vaults.credentials.create()", "node": "client.beta.agents.vaults.credentials.create()" }, "relations": [ "belongs_to: vault", "used_by: POST /agents/sessions (vault_ids[]) ; MCP tool credential_id" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/vaults", "method": "GET", "path": "/v1/vaults/{vault_id}/credentials/{credential_id}", "name": "retrieveVaultCredential", "summary": "Retrieve a vault credential", "description": "Retrieves vault credential metadata without returning secret values. See [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "vault_id", "credential_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "VaultCredentialResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.vaults.credentials.retrieve()", "node": "client.beta.agents.vaults.credentials.retrieve()" }, "relations": [ "belongs_to: vault", "used_by: POST /agents/sessions (vault_ids[]) ; MCP tool credential_id" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/vaults", "method": "POST", "path": "/v1/vaults/{vault_id}/credentials/{credential_id}", "name": "rotateVaultCredential", "summary": "Rotate a vault credential", "description": "Rotates a vault credential's write-only secret and returns only credential metadata. See [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": "application/json", "body_ref": "RotateVaultCredentialParams", "path_params": [ "vault_id", "credential_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "VaultCredentialResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.vaults.credentials.update()", "node": "client.beta.agents.vaults.credentials.update()" }, "relations": [ "belongs_to: vault", "used_by: POST /agents/sessions (vault_ids[]) ; MCP tool credential_id" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/vaults", "method": "DELETE", "path": "/v1/vaults/{vault_id}/credentials/{credential_id}", "name": "deleteVaultCredential", "summary": "Delete a vault credential", "description": "Deletes a vault credential. See [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).", "status": [ "DOCUMENTED", "BETA" ], "auth": "Bearer API key (Authorization: Bearer $OPENAI_API_KEY); restricted keys need api.vaults.read, api.vaults.write", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required. Without the header the API returns 400 {\"type\":\"invalid_beta\",\"code\":\"invalid_beta\"}; the query string ?beta=true is NOT accepted (live-tested).", "request": { "content_type": null, "body_ref": null, "path_params": [ "vault_id", "credential_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "DeletedVaultCredentialResource", "error_statuses": [ 400, 401, 403, 404, 409, 500, 503 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.beta.agents.vaults.credentials.delete()", "node": "client.beta.agents.vaults.credentials.delete()" }, "relations": [ "belongs_to: vault", "used_by: POST /agents/sessions (vault_ids[]) ; MCP tool credential_id" ], "deprecated_in_spec": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/agents", "method": "GET", "path": "/v1/agents/sessions/{session_id}/traces", "name": "listAgentSessionTraces (docs-only)", "summary": "Export session traces (OTLP JSON)", "description": "Returns a page of traces for a session; each item carries `otlp.resourceSpans`. Trace export must be enabled for the organization; needs api.traces.read or api.agents.read. Traces are built after a turn ends.", "status": [ "DOCUMENTED", "BETA", "LIVE_DISCOVERED" ], "auth": "Bearer API key (api.traces.read or api.agents.read)", "beta_header": "OpenAI-Beta: agents=v1", "beta_gating": "Required (agents=v1)", "request": { "content_type": null, "body_ref": null, "path_params": [ "session_id" ], "query_params": [ "limit", "order", "after" ], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "inline: {object:\"list\", data:[{otlp:{resourceSpans:[...]}}], first_id, last_id, has_more}", "error_statuses": [ 404 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after" ], "response_fields": [ "data", "last_id", "has_more" ] }, "idempotency": null, "sdk": { "python": null, "node": null }, "relations": [ "belongs_to: agent.session" ], "deprecated_in_spec": false, "not_in_openapi_spec": true, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 404, "request_note": "GET on a deleted session id -> 404 not_found_error \"No managed agent resource found: sess_…\" (route exists; org trace export not confirmed)" }, "sources": [ { "url": "https://developers.openai.com/api/docs/guides/agents-api/tracing#export-session-traces", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/workspace-agents", "method": "POST", "path": "/v1/workspace_agents/{id}/trigger", "base_url": "https://api.chatgpt.com", "name": "triggerWorkspaceAgent", "summary": "triggerWorkspaceAgent", "description": "Durably queue a trigger event for a published ChatGPT workspace agent (API channel id agtch_…). Returns 202 Accepted with conversation_url; with OpenAI-Beta: workspace_agent_runs=v1 also agent_trigger_run_id (apirun_…). The agent response itself is not retrievable via API.", "status": [ "DOCUMENTED", "BETA", "UNVERIFIED" ], "auth": "Authorization: Bearer (ChatGPT Admin > Access tokens, scope \"Workspace Agents\"; NOT a platform API key)", "beta_header": "OpenAI-Beta: workspace_agent_runs=v1 (required to get agent_trigger_run_id / use runs polling)", "beta_gating": "Run polling is beta; trigger itself is GA-documented", "request": { "content_type": "application/json", "body_ref": "inline: {input (required), conversation_key (optional)}", "path_params": [ "id" ], "query_params": [], "header_params": [ "Idempotency-Key" ] }, "response": { "success_status": 202, "content_type": "application/json", "body_ref": "inline: {conversation_url, agent_trigger_run_id?}", "error_statuses": [ 401, 403, 404, 409 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": "Idempotency-Key header: same key on the same trigger returns the original accepted outcome", "sdk": { "python": null, "node": null }, "relations": [ "workspace agent (agt_…) has_many api triggers (agtch_…) has_many trigger runs (apirun_…)" ], "deprecated_in_spec": false, "not_in_openapi_spec": true, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Requires a ChatGPT Business/Enterprise/Edu workspace access token; not available with a platform API key — not attempted" }, "sources": [ { "url": "https://developers.openai.com/workspace-agents/trigger-runs", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/workspace-agents/authentication", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "agents-platform/workspace-agents", "method": "GET", "path": "/v1/workspace_agents/{id}/runs/{run_id}", "base_url": "https://api.chatgpt.com", "name": "retrieveWorkspaceAgentRun", "summary": "retrieveWorkspaceAgentRun", "description": "Poll a trigger run (beta): object workspace_agent.trigger_run with status queued|in_progress|suspended|completed|failed and error.code dispatch_failed|run_failed.", "status": [ "DOCUMENTED", "BETA", "UNVERIFIED" ], "auth": "Authorization: Bearer (ChatGPT Admin > Access tokens, scope \"Workspace Agents\"; NOT a platform API key)", "beta_header": "OpenAI-Beta: workspace_agent_runs=v1 (required to get agent_trigger_run_id / use runs polling)", "beta_gating": "Run polling is beta; trigger itself is GA-documented", "request": { "content_type": null, "body_ref": null, "path_params": [ "id", "run_id" ], "query_params": [], "header_params": [] }, "response": { "success_status": 200, "content_type": "application/json", "body_ref": "inline: workspace_agent.trigger_run", "error_statuses": [ 401, 403, 404, 409 ] }, "streaming": { "supported": false, "events_ref": null, "note": null }, "pagination": null, "idempotency": null, "sdk": { "python": null, "node": null }, "relations": [ "workspace agent (agt_…) has_many api triggers (agtch_…) has_many trigger runs (apirun_…)" ], "deprecated_in_spec": false, "not_in_openapi_spec": true, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "Requires a ChatGPT Business/Enterprise/Edu workspace access token; not available with a platform API key — not attempted" }, "sources": [ { "url": "https://developers.openai.com/workspace-agents/trigger-runs", "retrieved_at": "2026-09-18T00:00:00Z" }, { "url": "https://developers.openai.com/workspace-agents/authentication", "retrieved_at": "2026-09-18T00:00:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-agents.json" }, { "provider": "openai", "api_family": "containers", "method": "GET", "path": "/v1/containers", "name": "ListContainers", "description": "List containers — List Containers", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [ "limit", "order", "after", "name" ], "path_params": [] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "ContainerListResource" ], "schema": { "ContainerListResource": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ], "description": "The type of object returned, must be 'list'." }, "data": { "type": "array", "description": "A list of containers.", "items": { "type": "object", "title": "The container object", "properties": { "id": { "type": "string", "description": "Unique identifier for the container." }, "object": { "type": "string", "description": "The type of this object." }, "name": { "type": "string", "description": "Name of the container." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (in seconds) when the container was created." }, "status": { "type": "string", "description": "Status of the container (e.g., active, deleted)." }, "last_active_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (in seconds) when the container was last active." }, "expires_after": { "type": "object", "description": "The container will expire after this time period.\nThe anchor is the reference point for the expiration.\nThe minutes is the number of minutes after the anchor before the container expires.\n", "properties": { "anchor": { "type": "string", "description": "The reference point for the expiration.", "enum": [ "last_active_at" ] }, "minutes": { "type": "integer", "description": "The number of minutes after the anchor before the container expires." } } }, "memory_limit": { "type": "string", "description": "The memory limit configured for the container.", "enum": [ "1g", "4g", "16g", "64g" ] }, "network_policy": { "description": "Network access policy for the container.", "type": "object", "properties": { "type": { "type": "string", "description": "The network policy mode.", "enum": [ "allowlist", "disabled" ] }, "allowed_domains": { "type": "array", "description": "Allowed outbound domains when `type` is `allowlist`.", "items": { "type": "string" } } }, "required": [ "type" ] } }, "required": [ "id", "object", "name", "created_at", "status", "id", "name", "created_at", "status" ] } }, "first_id": { "type": "string", "description": "The ID of the first container in the list." }, "last_id": { "type": "string", "description": "The ID of the last container in the list." }, "has_more": { "type": "boolean", "description": "Whether there are more containers available." } }, "required": [ "object", "data", "first_id", "last_id", "has_more" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": "cursor (limit, order, after)", "idempotency": null, "sdk": { "python": "client.containers.list()", "node": "client.containers.list()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "?limit=2 -> list with data[] of container objects" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/containers", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "containers", "method": "POST", "path": "/v1/containers", "name": "CreateContainer", "description": "Create container — Create Container", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": [ "application/json" ], "body_ref": [ "CreateContainerBody" ], "query": [], "path_params": [] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "ContainerResource" ], "schema": { "ContainerResource": { "type": "object", "title": "The container object", "properties": { "id": { "type": "string", "description": "Unique identifier for the container." }, "object": { "type": "string", "description": "The type of this object." }, "name": { "type": "string", "description": "Name of the container." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (in seconds) when the container was created." }, "status": { "type": "string", "description": "Status of the container (e.g., active, deleted)." }, "last_active_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (in seconds) when the container was last active." }, "expires_after": { "type": "object", "description": "The container will expire after this time period.\nThe anchor is the reference point for the expiration.\nThe minutes is the number of minutes after the anchor before the container expires.\n", "properties": { "anchor": { "type": "string", "description": "The reference point for the expiration.", "enum": [ "last_active_at" ] }, "minutes": { "type": "integer", "description": "The number of minutes after the anchor before the container expires." } } }, "memory_limit": { "type": "string", "description": "The memory limit configured for the container.", "enum": [ "1g", "4g", "16g", "64g" ] }, "network_policy": { "description": "Network access policy for the container.", "type": "object", "properties": { "type": { "type": "string", "description": "The network policy mode.", "enum": [ "allowlist", "disabled" ] }, "allowed_domains": { "type": "array", "description": "Allowed outbound domains when `type` is `allowlist`.", "items": { "type": "string" } } }, "required": [ "type" ] } }, "required": [ "id", "object", "name", "created_at", "status", "id", "name", "created_at", "status" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.containers.create()", "node": "client.containers.create()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "{name:'atlas-tools-agent', memory_limit:'1g', expires_after:{anchor:last_active_at, minutes:5}} -> container {id cntr_…, object:'container', status:'running', memory_limit, expires_after, last_active_at}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/containers", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "containers", "method": "GET", "path": "/v1/containers/{container_id}", "name": "RetrieveContainer", "description": "Retrieve container — Retrieve Container", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [], "path_params": [ "container_id" ] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "ContainerResource" ], "schema": { "ContainerResource": { "type": "object", "title": "The container object", "properties": { "id": { "type": "string", "description": "Unique identifier for the container." }, "object": { "type": "string", "description": "The type of this object." }, "name": { "type": "string", "description": "Name of the container." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (in seconds) when the container was created." }, "status": { "type": "string", "description": "Status of the container (e.g., active, deleted)." }, "last_active_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (in seconds) when the container was last active." }, "expires_after": { "type": "object", "description": "The container will expire after this time period.\nThe anchor is the reference point for the expiration.\nThe minutes is the number of minutes after the anchor before the container expires.\n", "properties": { "anchor": { "type": "string", "description": "The reference point for the expiration.", "enum": [ "last_active_at" ] }, "minutes": { "type": "integer", "description": "The number of minutes after the anchor before the container expires." } } }, "memory_limit": { "type": "string", "description": "The memory limit configured for the container.", "enum": [ "1g", "4g", "16g", "64g" ] }, "network_policy": { "description": "Network access policy for the container.", "type": "object", "properties": { "type": { "type": "string", "description": "The network policy mode.", "enum": [ "allowlist", "disabled" ] }, "allowed_domains": { "type": "array", "description": "Allowed outbound domains when `type` is `allowlist`.", "items": { "type": "string" } } }, "required": [ "type" ] } }, "required": [ "id", "object", "name", "created_at", "status", "id", "name", "created_at", "status" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.containers.retrieve()", "node": "client.containers.retrieve()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "auto container from code_interpreter -> status running, expires_after {last_active_at, 20}, memory_limit 1g, name 'auto'" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/containers", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "containers", "method": "DELETE", "path": "/v1/containers/{container_id}", "name": "DeleteContainer", "description": "Delete a container — Delete Container", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [], "path_params": [ "container_id" ] }, "response": { "content_type": null, "schema_ref": null, "schema": {} }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.containers.delete()", "node": "client.containers.delete()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "-> {id, object:'container.deleted', deleted:true}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/containers", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "containers", "method": "POST", "path": "/v1/containers/{container_id}/files", "name": "CreateContainerFile", "description": "Create container file — Create a Container File\n\nYou can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": [ "application/json", "multipart/form-data" ], "body_ref": [ "CreateContainerFileBody", "CreateContainerFileBody" ], "query": [], "path_params": [ "container_id" ] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "ContainerFileResource" ], "schema": { "ContainerFileResource": { "type": "object", "title": "The container file object", "properties": { "id": { "type": "string", "description": "Unique identifier for the file." }, "object": { "type": "string", "description": "The type of this object (`container.file`)." }, "container_id": { "type": "string", "description": "The container this file belongs to." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (in seconds) when the file was created." }, "bytes": { "type": "integer", "description": "Size of the file in bytes." }, "path": { "type": "string", "description": "Path of the file in the container." }, "source": { "type": "string", "description": "Source of the file (e.g., `user`, `assistant`)." } }, "required": [ "id", "object", "created_at", "bytes", "container_id", "path", "source" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.containers.files.create()", "node": "client.containers.files.create()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "multipart file=hello.txt -> {id cfile_…, object:'container.file', bytes 11, path '/mnt/data/-hello.txt', source 'user'}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/containers", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "containers", "method": "GET", "path": "/v1/containers/{container_id}/files", "name": "ListContainerFiles", "description": "List container files — List Container files", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [ "limit", "order", "after" ], "path_params": [ "container_id" ] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "ContainerFileListResource" ], "schema": { "ContainerFileListResource": { "type": "object", "properties": { "object": { "type": "string", "enum": [ "list" ], "description": "The type of object returned, must be 'list'." }, "data": { "type": "array", "description": "A list of container files.", "items": { "type": "object", "title": "The container file object", "properties": { "id": { "type": "string", "description": "Unique identifier for the file." }, "object": { "type": "string", "description": "The type of this object (`container.file`)." }, "container_id": { "type": "string", "description": "The container this file belongs to." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (in seconds) when the file was created." }, "bytes": { "type": "integer", "description": "Size of the file in bytes." }, "path": { "type": "string", "description": "Path of the file in the container." }, "source": { "type": "string", "description": "Source of the file (e.g., `user`, `assistant`)." } }, "required": [ "id", "object", "created_at", "bytes", "container_id", "path", "source" ] } }, "first_id": { "type": "string", "description": "The ID of the first file in the list." }, "last_id": { "type": "string", "description": "The ID of the last file in the list." }, "has_more": { "type": "boolean", "description": "Whether there are more files available." } }, "required": [ "object", "data", "first_id", "last_id", "has_more" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": "cursor (limit, order, after)", "idempotency": null, "sdk": { "python": "client.containers.files.list()", "node": "client.containers.files.list()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "-> {object:list, data:[], first_id, last_id, has_more}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/containers", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "containers", "method": "GET", "path": "/v1/containers/{container_id}/files/{file_id}", "name": "RetrieveContainerFile", "description": "Retrieve container file — Retrieve Container File", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [], "path_params": [ "container_id", "file_id" ] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "ContainerFileResource" ], "schema": { "ContainerFileResource": { "type": "object", "title": "The container file object", "properties": { "id": { "type": "string", "description": "Unique identifier for the file." }, "object": { "type": "string", "description": "The type of this object (`container.file`)." }, "container_id": { "type": "string", "description": "The container this file belongs to." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (in seconds) when the file was created." }, "bytes": { "type": "integer", "description": "Size of the file in bytes." }, "path": { "type": "string", "description": "Path of the file in the container." }, "source": { "type": "string", "description": "Source of the file (e.g., `user`, `assistant`)." } }, "required": [ "id", "object", "created_at", "bytes", "container_id", "path", "source" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.containers.files.retrieve()", "node": "client.containers.files.retrieve()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "-> container.file object" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/containers", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "containers", "method": "DELETE", "path": "/v1/containers/{container_id}/files/{file_id}", "name": "DeleteContainerFile", "description": "Delete a container file — Delete Container File", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [], "path_params": [ "container_id", "file_id" ] }, "response": { "content_type": null, "schema_ref": null, "schema": {} }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.containers.files.delete()", "node": "client.containers.files.delete()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "-> {id, object:'container.file.deleted', deleted:true}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/containers", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "containers", "method": "GET", "path": "/v1/containers/{container_id}/files/{file_id}/content", "name": "RetrieveContainerFileContent", "description": "Retrieve container file content — Retrieve Container File Content", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [], "path_params": [ "container_id", "file_id" ] }, "response": { "content_type": null, "schema_ref": null, "schema": {} }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.containers.files.content.retrieve()", "node": "client.containers.files.content.retrieve()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "-> raw bytes 'hello atlas'" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/containers", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "skills", "method": "POST", "path": "/v1/skills", "name": "CreateSkill", "description": "Create Skill — Create a new skill.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": [ "multipart/form-data", "application/json" ], "body_ref": [ "CreateSkillBody", "CreateSkillBody" ], "query": [], "path_params": [] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "SkillResource" ], "schema": { "SkillResource": { "properties": { "id": { "type": "string", "description": "Unique identifier for the skill." }, "object": { "type": "string", "enum": [ "skill" ], "description": "The object type, which is `skill`.", "default": "skill", "x-stainless-const": true }, "name": { "type": "string", "description": "Name of the skill." }, "description": { "type": "string", "description": "Description of the skill." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (seconds) for when the skill was created." }, "default_version": { "type": "string", "description": "Default version for the skill." }, "latest_version": { "type": "string", "description": "Latest version for the skill." } }, "type": "object", "required": [ "id", "object", "name", "description", "created_at", "default_version", "latest_version" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.skills.create()", "node": "client.skills.create()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "multipart files= -> skill {id skill_…, object:'skill', name, description, default_version:'1', latest_version:'1'}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/skills", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "skills", "method": "GET", "path": "/v1/skills", "name": "ListSkills", "description": "List Skills — List all skills for the current project.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [ "limit", "order", "after" ], "path_params": [] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "SkillListResource" ], "schema": { "SkillListResource": { "properties": { "object": { "type": "string", "enum": [ "list" ], "description": "The type of object returned, must be `list`.", "default": "list", "x-stainless-const": true }, "data": { "items": { "properties": { "id": { "type": "string", "description": "Unique identifier for the skill." }, "object": { "type": "string", "enum": [ "skill" ], "description": "The object type, which is `skill`.", "default": "skill", "x-stainless-const": true }, "name": { "type": "string", "description": "Name of the skill." }, "description": { "type": "string", "description": "Description of the skill." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (seconds) for when the skill was created." }, "default_version": { "type": "string", "description": "Default version for the skill." }, "latest_version": { "type": "string", "description": "Latest version for the skill." } }, "type": "object", "required": [ "id", "object", "name", "description", "created_at", "default_version", "latest_version" ] }, "type": "array", "description": "A list of items" }, "first_id": { "anyOf": [ { "type": "string", "description": "The ID of the first item in the list." }, { "type": "null" } ] }, "last_id": { "anyOf": [ { "type": "string", "description": "The ID of the last item in the list." }, { "type": "null" } ] }, "has_more": { "type": "boolean", "description": "Whether there are more items available." } }, "type": "object", "required": [ "object", "data", "first_id", "last_id", "has_more" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": "cursor (limit, order, after)", "idempotency": null, "sdk": { "python": "client.skills.list()", "node": "client.skills.list()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "?limit=5 -> {object:list, data:[], first_id:null, last_id:null, has_more:false}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/skills", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "skills", "method": "DELETE", "path": "/v1/skills/{skill_id}", "name": "DeleteSkill", "description": "Delete Skill — Delete a skill by its ID.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [], "path_params": [ "skill_id" ] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "DeletedSkillResource" ], "schema": { "DeletedSkillResource": { "properties": { "object": { "type": "string", "enum": [ "skill.deleted" ], "default": "skill.deleted", "x-stainless-const": true }, "deleted": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object", "required": [ "object", "deleted", "id" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.skills.delete()", "node": "client.skills.delete()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "-> {id, object:'skill.deleted', deleted:true}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/skills", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "skills", "method": "GET", "path": "/v1/skills/{skill_id}", "name": "GetSkill", "description": "Get Skill — Get a skill by its ID.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [], "path_params": [ "skill_id" ] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "SkillResource" ], "schema": { "SkillResource": { "properties": { "id": { "type": "string", "description": "Unique identifier for the skill." }, "object": { "type": "string", "enum": [ "skill" ], "description": "The object type, which is `skill`.", "default": "skill", "x-stainless-const": true }, "name": { "type": "string", "description": "Name of the skill." }, "description": { "type": "string", "description": "Description of the skill." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (seconds) for when the skill was created." }, "default_version": { "type": "string", "description": "Default version for the skill." }, "latest_version": { "type": "string", "description": "Latest version for the skill." } }, "type": "object", "required": [ "id", "object", "name", "description", "created_at", "default_version", "latest_version" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.skills.retrieve()", "node": "client.skills.retrieve()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "-> skill object" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/skills", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "skills", "method": "POST", "path": "/v1/skills/{skill_id}", "name": "UpdateSkillDefaultVersion", "description": "Update Skill Default Version — Update the default version pointer for a skill.", "status": [ "DOCUMENTED", "FAILED_VERIFICATION" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": [ "application/json" ], "body_ref": [ "SetDefaultSkillVersionBody" ], "query": [], "path_params": [ "skill_id" ] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "SkillResource" ], "schema": { "SkillResource": { "properties": { "id": { "type": "string", "description": "Unique identifier for the skill." }, "object": { "type": "string", "enum": [ "skill" ], "description": "The object type, which is `skill`.", "default": "skill", "x-stainless-const": true }, "name": { "type": "string", "description": "Name of the skill." }, "description": { "type": "string", "description": "Description of the skill." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (seconds) for when the skill was created." }, "default_version": { "type": "string", "description": "Default version for the skill." }, "latest_version": { "type": "string", "description": "Latest version for the skill." } }, "type": "object", "required": [ "id", "object", "name", "description", "created_at", "default_version", "latest_version" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.skills.create()", "node": "client.skills.create()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "{default_version:'2'} right after creating version 2 -> 404 'Skill version 2 was not found' (param default_version) — versions appear not immediately addressable; possible eventual consistency or id-vs-number mismatch" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/skills", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "skills", "method": "GET", "path": "/v1/skills/{skill_id}/content", "name": "GetSkillContent", "description": "Get Skill Content — Download a skill zip bundle by its ID.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [], "path_params": [ "skill_id" ] }, "response": { "content_type": [ "application/zip", "application/json" ], "schema_ref": [ "", "" ], "schema": {} }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.skills.content.retrieve()", "node": "client.skills.content.retrieve()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "-> application/zip bytes (PK header)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/skills", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "skills", "method": "POST", "path": "/v1/skills/{skill_id}/versions", "name": "CreateSkillVersion", "description": "Create Skill Version — Create a new immutable skill version.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": [ "multipart/form-data", "application/json" ], "body_ref": [ "CreateSkillVersionBody", "CreateSkillVersionBody" ], "query": [], "path_params": [ "skill_id" ] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "SkillVersionResource" ], "schema": { "SkillVersionResource": { "properties": { "object": { "type": "string", "enum": [ "skill.version" ], "description": "The object type, which is `skill.version`.", "default": "skill.version", "x-stainless-const": true }, "id": { "type": "string", "description": "Unique identifier for the skill version." }, "skill_id": { "type": "string", "description": "Identifier of the skill for this version." }, "version": { "type": "string", "description": "Version number for this skill." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (seconds) for when the version was created." }, "name": { "type": "string", "description": "Name of the skill version." }, "description": { "type": "string", "description": "Description of the skill version." } }, "type": "object", "required": [ "object", "id", "skill_id", "version", "created_at", "name", "description" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.skills.versions.create()", "node": "client.skills.versions.create()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "multipart files= -> {id skillver_…, object:'skill.version', version:'2', skill_id, name, description}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/skills", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "skills", "method": "GET", "path": "/v1/skills/{skill_id}/versions", "name": "ListSkillVersions", "description": "List Skill Versions — List skill versions for a skill.", "status": [ "DOCUMENTED", "FAILED_VERIFICATION" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [ "limit", "order", "after" ], "path_params": [ "skill_id" ] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "SkillVersionListResource" ], "schema": { "SkillVersionListResource": { "properties": { "object": { "type": "string", "enum": [ "list" ], "description": "The type of object returned, must be `list`.", "default": "list", "x-stainless-const": true }, "data": { "items": { "properties": { "object": { "type": "string", "enum": [ "skill.version" ], "description": "The object type, which is `skill.version`.", "default": "skill.version", "x-stainless-const": true }, "id": { "type": "string", "description": "Unique identifier for the skill version." }, "skill_id": { "type": "string", "description": "Identifier of the skill for this version." }, "version": { "type": "string", "description": "Version number for this skill." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (seconds) for when the version was created." }, "name": { "type": "string", "description": "Name of the skill version." }, "description": { "type": "string", "description": "Description of the skill version." } }, "type": "object", "required": [ "object", "id", "skill_id", "version", "created_at", "name", "description" ] }, "type": "array", "description": "A list of items" }, "first_id": { "anyOf": [ { "type": "string", "description": "The ID of the first item in the list." }, { "type": "null" } ] }, "last_id": { "anyOf": [ { "type": "string", "description": "The ID of the last item in the list." }, { "type": "null" } ] }, "has_more": { "type": "boolean", "description": "Whether there are more items available." } }, "type": "object", "required": [ "object", "data", "first_id", "last_id", "has_more" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": "cursor (limit, order, after)", "idempotency": null, "sdk": { "python": "client.skills.versions.list()", "node": "client.skills.versions.list()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 200, "request_note": "-> data [] although version 1 (default) existed; list did not reflect versions (LIVE discrepancy)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/skills", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "skills", "method": "GET", "path": "/v1/skills/{skill_id}/versions/{version}", "name": "GetSkillVersion", "description": "Get Skill Version — Get a specific skill version.", "status": [ "DOCUMENTED", "FAILED_VERIFICATION" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [], "path_params": [ "skill_id", "version" ] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "SkillVersionResource" ], "schema": { "SkillVersionResource": { "properties": { "object": { "type": "string", "enum": [ "skill.version" ], "description": "The object type, which is `skill.version`.", "default": "skill.version", "x-stainless-const": true }, "id": { "type": "string", "description": "Unique identifier for the skill version." }, "skill_id": { "type": "string", "description": "Identifier of the skill for this version." }, "version": { "type": "string", "description": "Version number for this skill." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (seconds) for when the version was created." }, "name": { "type": "string", "description": "Name of the skill version." }, "description": { "type": "string", "description": "Description of the skill version." } }, "type": "object", "required": [ "object", "id", "skill_id", "version", "created_at", "name", "description" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.skills.versions.retrieve()", "node": "client.skills.versions.retrieve()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "/versions/1 -> 404 (version numbers not resolvable right after creation)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/skills", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "skills", "method": "DELETE", "path": "/v1/skills/{skill_id}/versions/{version}", "name": "DeleteSkillVersion", "description": "Delete Skill Version — Delete a skill version.", "status": [ "DOCUMENTED", "FAILED_VERIFICATION" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [], "path_params": [ "skill_id", "version" ] }, "response": { "content_type": [ "application/json" ], "schema_ref": [ "DeletedSkillVersionResource" ], "schema": { "DeletedSkillVersionResource": { "properties": { "object": { "type": "string", "enum": [ "skill.version.deleted" ], "default": "skill.version.deleted", "x-stainless-const": true }, "deleted": { "type": "boolean" }, "id": { "type": "string" }, "version": { "type": "string", "description": "The deleted skill version." } }, "type": "object", "required": [ "object", "deleted", "id", "version" ] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.skills.versions.delete()", "node": "client.skills.versions.delete()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "/versions/1 -> 404 'Skill version 1 was not found' (default version is also documented as non-deletable)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/skills", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "skills", "method": "GET", "path": "/v1/skills/{skill_id}/versions/{version}/content", "name": "GetSkillVersionContent", "description": "Get Skill Version Content — Download a skill version zip bundle.", "status": [ "DOCUMENTED" ], "auth": "Bearer API key (project key)", "beta_header": null, "request": { "content_type": null, "body_ref": null, "query": [], "path_params": [ "skill_id", "version" ] }, "response": { "content_type": [ "application/zip", "application/json" ], "schema_ref": [ "", "" ], "schema": {} }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": null, "sdk": { "python": "client.skills.versions.content.retrieve()", "node": "client.skills.versions.content.retrieve()" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "success", "http_status": 0, "request_note": "not called" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/skills", "retrieved_at": "2026-09-18" }, { "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-containers-skills.json" }, { "provider": "openai", "api_family": "responses", "method": "POST", "path": "/v1/responses", "name": "Responses: create", "description": "Create a model response from text/image/file/audio items with optional built-in or custom tools. Stored 30 days by default (store=true). stream=true switches to SSE; background=true returns immediately with status=queued.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateResponse (parameters/openai-responses.json)" }, "response": { "content_type": "application/json", "schema_ref": "Response" }, "streaming": { "supported": true, "events_ref": "streaming-events/openai-responses.json", "transport": "SSE (text/event-stream); `event:` name == `data.type`; every event carries sequence_number" }, "pagination": null, "idempotency": "Not idempotent (POST create). No Idempotency-Key header documented for these endpoints.", "sdk": { "python": "client.responses.create(**params) / client.responses.stream(...) / client.responses.parse(...)", "node": "client.responses.create(params) / client.responses.stream(params) / client.responses.parse(params)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "gpt-5.4-nano \"Reply with OK.\" max_output_tokens=32 -> status=completed, 16 total tokens; streaming, previous_response_id, store=false, json_schema, reasoning summary, background, conversation, logprobs all 200" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/responses/methods/create", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/text", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "live_observed_response_fields_not_in_spec": [ "billing.payer", "tool_usage.image_gen", "tool_usage.web_search.num_requests", "frequency_penalty", "presence_penalty", "output[].phase (message)" ], "rate_limit_headers_observed": [ "x-ratelimit-limit-requests", "x-ratelimit-limit-tokens", "x-ratelimit-remaining-requests", "x-ratelimit-remaining-tokens", "x-ratelimit-reset-requests", "x-ratelimit-reset-tokens", "openai-processing-ms", "x-request-id" ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "responses", "method": "POST", "path": "/v1/responses?beta=true", "name": "Responses: create (beta surface)", "description": "Same operation exposed with the beta OpenAPI schemas (BetaCreateResponse/BetaResponse) — adds beta-only fields such as `multi_agent`, `agent_message`, `multi_agent_call(_output)` items and the `openai-beta` request header (array of feature flags). Live: identical response keys to the GA call.", "status": [ "DOCUMENTED", "BETA", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": "openai-beta (optional, array of strings: \"Optional beta features to enable for this request\")", "request": { "content_type": "application/json", "body_ref": "BetaCreateResponse" }, "response": { "content_type": "application/json", "schema_ref": "BetaResponse" }, "streaming": { "supported": true, "events_ref": "streaming-events/openai-responses.json (BetaResponseStreamEvent == GA list)" }, "pagination": null, "idempotency": "Not idempotent (POST create). No Idempotency-Key header documented for these endpoints.", "sdk": { "python": "client.beta.responses.* (e.g. client.beta.responses.input_tokens.count)", "node": "client.beta.responses.*" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "POST /v1/responses?beta=true gpt-5.4-nano -> 200, same key set as GA" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/responses/methods/create", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "responses", "method": "GET", "path": "/v1/responses/{response_id}", "name": "Responses: retrieve", "description": "Retrieve a stored response. Query: include[] (extra fields), stream=true (+starting_after=) to (re)attach to the SSE stream of a background response created with stream=true, include_obfuscation.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "Response" }, "streaming": { "supported": true, "events_ref": "streaming-events/openai-responses.json", "note": "GET ?stream=true&starting_after=N resumes after sequence_number N (live j6: resumed at 1 -> events 2..9)" }, "pagination": null, "idempotency": "Idempotent (GET)", "sdk": { "python": "client.responses.retrieve(response_id, include=[...], stream=..., starting_after=...)", "node": "client.responses.retrieve(id, params)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "GET stored response -> 200; store=false id -> 404; deleted id -> 404; ?include[]=message.output_text.logprobs -> 200" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/responses/methods/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "responses", "method": "DELETE", "path": "/v1/responses/{response_id}", "name": "Responses: delete", "description": "Delete a stored response. Returns {id, object: \"response.deleted\", deleted: true}; 404 if unknown.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "{id, object: \"response.deleted\", deleted}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Idempotent in effect (second delete -> 404)", "sdk": { "python": "client.responses.delete(response_id)", "node": "client.responses.delete(id)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "DELETE child then parent of a previous_response_id chain -> 200 each; GET afterwards -> 404" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/responses/methods/delete", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "responses", "method": "POST", "path": "/v1/responses/{response_id}/cancel", "name": "Responses: cancel", "description": "Cancel a background response. Only responses created with background=true can be cancelled; returns the Response object (status cancelled). Repeating a cancel on a cancelled response returns the same object (idempotent) — but cancelling an already *completed* response fails with HTTP 400 \"Cannot cancel a completed response.\" (live, examples/openai/responses/background.ts first run).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "Response" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Idempotent while cancelled/in-flight; 400 once completed", "sdk": { "python": "client.responses.cancel(response_id)", "node": "client.responses.cancel(id)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "cancel immediately after background create -> status=cancelled (usage all zeros); second cancel -> 200 same object; cancel after completion -> 400 invalid_request_error \"Cannot cancel a completed response.\"" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/responses/methods/cancel", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/background", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "live_errors": [ { "http_status": 400, "type": "invalid_request_error", "code": null, "message": "Cannot cancel a completed response." } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "responses", "method": "GET", "path": "/v1/responses/{response_id}/input_items", "name": "Responses: list input items", "description": "List the input items of a stored response (cursor pagination: limit 1-100 default 20, order asc|desc default desc, after, include[]). For a previous_response_id chain the list contains the whole rendered context (prior turns + outputs).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ResponseItemList {object: \"list\", data[], first_id, last_id, has_more}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after", "include" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "Idempotent (GET)", "sdk": { "python": "client.responses.input_items.list(response_id, limit=..., order=...)", "node": "client.responses.inputItems.list(id, params)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "chain child -> 3 items (user msg, prior assistant msg, prior user msg), has_more=false" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/responses/subresources/input_items/methods/list", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "responses", "method": "POST", "path": "/v1/responses/input_tokens", "name": "Responses: count input tokens", "description": "Count the exact input tokens the model would receive for a Responses payload (input, instructions, tools, images, files, previous_response_id, conversation, text.format, reasoning). No model call, free.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "TokenCountsBody (parameters/openai-responses.json, endpoint POST /v1/responses/input_tokens)" }, "response": { "content_type": "application/json", "schema_ref": "TokenCountsResource {object: \"response.input_tokens\", input_tokens}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Safe to retry (no side effects)", "sdk": { "python": "client.responses.input_tokens.count(model=..., input=...)", "node": "client.responses.inputTokens.count(params)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "\"Reply with OK.\" -> 10 tokens (matches usage.input_tokens of the real call); with instructions + image + function tool -> 49; ?beta=true variant -> 200" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/token-counting", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "responses", "method": "POST", "path": "/v1/responses/compact", "name": "Responses: compact", "description": "Stateless compaction: send a full context window (input items and/or previous_response_id, instructions, tools) and receive a compacted window to use as the next `input`. Returns object \"response.compaction\" with output[] (retained items + one `compaction` item with encrypted_content) and usage.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CompactResponseMethodPublicBody" }, "response": { "content_type": "application/json", "schema_ref": "CompactResource {id, object: \"response.compaction\", created_at, output[], usage}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (billed model work)", "sdk": { "python": "client.responses.compact(model=..., input=...)", "node": "client.responses.compact(params)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "3-message input on gpt-5.4-nano -> output [message, message, compaction], usage 119 in / ~220 out; previous_response_id form -> 200 too" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/responses/methods/compact", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/compaction", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "responses", "method": "WS", "path": "wss://api.openai.com/v1/responses", "name": "Responses: WebSocket mode", "description": "Persistent connection; client sends `response.create` events (same body as POST /v1/responses plus stream_id, minus stream/background) and receives the same typed server events plus stream_id echo, response.steer.* and (beta) response.inject.*. Connection-local cache makes previous_response_id continuation cheap; up to 16 in-flight responses, 32 named lanes, 60-minute connection limit.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ResponsesClientEvent (streaming-events/openai-responses-websocket.json)" }, "response": { "content_type": "application/json", "schema_ref": "ResponsesServerEvent" }, "streaming": { "supported": true, "events_ref": "streaming-events/openai-responses-websocket.json" }, "pagination": null, "idempotency": "n/a", "sdk": { "python": "with client.responses.connect() as connection: connection.response.create(...); for event in connection: ... (pip install \"openai[realtime]\")", "node": "import { ResponsesWS } from \"openai/resources/responses/ws\"; const ws = new ResponsesWS(client); ws.send({type: \"response.create\", ...})" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "success", "http_status": null, "request_note": "Not exercised live (needs websocket client dependency); documented from guide + OpenAPI ResponsesClientEvent/ResponsesServerEvent" }, "sources": [ { "url": "https://developers.openai.com/api/docs/guides/websocket-mode", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/reference/resources/responses/websocket-events", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "chat_completions", "method": "POST", "path": "/v1/chat/completions", "name": "Chat Completions: create", "description": "Generate a chat completion from a messages[] array. Supports streaming chunks (chat.completion.chunk), response_format (json_schema / json_object), tools/functions, audio in/out (modalities), predicted outputs, logprobs, n choices. Stored only if store=true.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateChatCompletionRequest (parameters/openai-chat-completions.json)" }, "response": { "content_type": "application/json", "schema_ref": "CreateChatCompletionResponse (chat.completion)" }, "streaming": { "supported": true, "events_ref": "streaming-events/openai-chat-completions.json", "transport": "SSE data-only chunks (`data: {...}`), terminated by `data: [DONE]`" }, "pagination": null, "idempotency": "Not idempotent (POST create). No Idempotency-Key header documented for these endpoints.", "sdk": { "python": "client.chat.completions.create(**params) / .parse(...) / .stream(...)", "node": "client.chat.completions.create(params) / .parse(...) / .stream(...)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "gpt-4.1-nano minimal, stream(+usage), json_schema, store=true, image_url, legacy params (max_tokens/seed/logprobs/user), gpt-5.4-nano + reasoning_effort -> all 200" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/reference/chat-completions/overview", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "chat_completions", "method": "GET", "path": "/v1/chat/completions", "name": "Chat Completions: list", "description": "List stored chat completions (store=true). Query: model, metadata[key]=value, after, limit (default 20), order asc|desc (default asc).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ChatCompletionList {object: \"list\", data[], first_id, last_id, has_more}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "after", "limit", "order", "model", "metadata" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "Idempotent (GET)", "sdk": { "python": "client.chat.completions.list(limit=..., metadata=...)", "node": "client.chat.completions.list(params)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "?limit=1&metadata[atlas]=openai-core -> 1 item" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/list", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "chat_completions", "method": "GET", "path": "/v1/chat/completions/{completion_id}", "name": "Chat Completions: retrieve", "description": "Retrieve a stored chat completion. Live: the stored object carries extra fields not in the create response: request_id, input_user, seed, temperature, top_p, presence_penalty, frequency_penalty, tool_choice, tools, response_format, metadata.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "CreateChatCompletionResponse (+ stored-request fields)" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Idempotent (GET)", "sdk": { "python": "client.chat.completions.retrieve(completion_id)", "node": "client.chat.completions.retrieve(id)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "retrieved ~2 s after store=true create -> 200 (Python run); a Node run got 404 code=not_found after 2 s -> stored copy is eventually consistent, retry with backoff" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "live_observed_response_fields_not_in_spec": [ "request_id", "input_user", "seed", "temperature", "top_p", "presence_penalty", "frequency_penalty", "tool_choice", "tools", "response_format" ], "live_errors": [ { "http_status": 404, "type": "invalid_request_error", "code": "not_found", "message": "Completion chatcmpl-… not found", "when": "GET 2 s after a store=true create (eventual consistency)" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "chat_completions", "method": "POST", "path": "/v1/chat/completions/{completion_id}", "name": "Chat Completions: update", "description": "Replace the metadata of a stored chat completion (body: {metadata}). Returns the chat completion object.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "{metadata: map}" }, "response": { "content_type": "application/json", "schema_ref": "CreateChatCompletionResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Idempotent (same body -> same state)", "sdk": { "python": "client.chat.completions.update(completion_id, metadata={...})", "node": "client.chat.completions.update(id, {metadata})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "metadata updated and echoed" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/update", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "chat_completions", "method": "DELETE", "path": "/v1/chat/completions/{completion_id}", "name": "Chat Completions: delete", "description": "Delete a stored chat completion. Returns {object: \"chat.completion.deleted\", id, deleted: true}.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ChatCompletionDeleted" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Second delete -> 404", "sdk": { "python": "client.chat.completions.delete(completion_id)", "node": "client.chat.completions.delete(id)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "200" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/delete", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "chat_completions", "method": "GET", "path": "/v1/chat/completions/{completion_id}/messages", "name": "Chat Completions: list messages", "description": "List the request messages of a stored chat completion (after, limit default 20, order asc|desc default asc). Items: {id: \"-\", role, content, content_parts, name}.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ChatCompletionMessageList" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "after", "limit", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "Idempotent (GET)", "sdk": { "python": "client.chat.completions.messages.list(completion_id)", "node": "client.chat.completions.messages.list(id)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "1 user message returned, id suffix -0" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/subresources/messages/methods/list", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "completions", "method": "POST", "path": "/v1/completions", "name": "Completions (legacy): create", "description": "Legacy text completion for gpt-3.5-turbo-instruct / davinci-002 / babbage-002 (prompt string, token array, suffix, echo, best_of, logprobs<=5). Streamed and non-streamed objects share the same `text_completion` shape.", "status": [ "DOCUMENTED", "LEGACY", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateCompletionRequest (parameters/openai-completions.json)" }, "response": { "content_type": "application/json", "schema_ref": "CreateCompletionResponse (text_completion)" }, "streaming": { "supported": true, "events_ref": "streaming-events/openai-chat-completions.json (record text_completion.chunk)", "transport": "SSE data-only, `data: [DONE]` terminator; usage chunk when stream_options.include_usage" }, "pagination": null, "idempotency": "Not idempotent (POST create). No Idempotency-Key header documented for these endpoints.", "sdk": { "python": "client.completions.create(model=..., prompt=..., max_tokens=...)", "node": "client.completions.create(params)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "gpt-3.5-turbo-instruct \"Say OK.\" max_tokens=5 -> \"\\n\\nOK.\" 6 tokens; streaming -> 200" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/completions/methods/create", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "conversations", "method": "POST", "path": "/v1/conversations", "name": "Conversations: create", "description": "Create a durable conversation object (optional metadata, up to 20 initial items). Items attached to a conversation are not subject to the 30-day response TTL.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateConversationBody (parameters/openai-conversations.json)" }, "response": { "content_type": "application/json", "schema_ref": "ConversationResource {id, object: \"conversation\", created_at, metadata}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST create). No Idempotency-Key header documented for these endpoints.", "sdk": { "python": "client.conversations.create(metadata={...}, items=[...])", "node": "client.conversations.create(params)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "created with metadata -> 200" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/conversations/methods/create", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/conversation-state", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "conversations", "method": "GET", "path": "/v1/conversations/{conversation_id}", "name": "Conversations: retrieve", "description": "Retrieve a conversation object.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ConversationResource" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Idempotent (GET)", "sdk": { "python": "client.conversations.retrieve(conversation_id)", "node": "client.conversations.retrieve(id)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "200; after delete -> 404" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/conversations/methods/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "conversations", "method": "POST", "path": "/v1/conversations/{conversation_id}", "name": "Conversations: update", "description": "Replace conversation metadata (body {metadata} required).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "UpdateConversationBody" }, "response": { "content_type": "application/json", "schema_ref": "ConversationResource" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Idempotent", "sdk": { "python": "client.conversations.update(conversation_id, metadata={...})", "node": "client.conversations.update(id, {metadata})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "200 metadata echoed" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/conversations/methods/update", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "conversations", "method": "DELETE", "path": "/v1/conversations/{conversation_id}", "name": "Conversations: delete", "description": "Delete a conversation and its items. Returns {id, object: \"conversation.deleted\", deleted: true}.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "DeletedConversationResource" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Second delete -> 404", "sdk": { "python": "client.conversations.delete(conversation_id)", "node": "client.conversations.delete(id)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "200" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/conversations/methods/delete", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "conversations", "method": "POST", "path": "/v1/conversations/{conversation_id}/items", "name": "Conversations: create items", "description": "Append up to 20 items (messages, tool calls/outputs, item references) to a conversation. Body {items: [...]}; query include[]. Returns a ConversationItemList of the created items (server-assigned ids, status \"completed\").", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "{items: Item[]}" }, "response": { "content_type": "application/json", "schema_ref": "ConversationItemList {object: \"list\", data[], first_id, last_id, has_more}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST create). No Idempotency-Key header documented for these endpoints.", "sdk": { "python": "client.conversations.items.create(conversation_id, items=[...])", "node": "client.conversations.items.create(id, {items})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "1 user message -> list with 1 item (msg_...)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "conversations", "method": "GET", "path": "/v1/conversations/{conversation_id}/items", "name": "Conversations: list items", "description": "List items (limit 1-100 default 20, order asc|desc default desc, after, include[]). Responses created with `conversation` append both their input and output items.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ConversationItemList" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after", "include" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "Idempotent (GET)", "sdk": { "python": "client.conversations.items.list(conversation_id, order=\"asc\")", "node": "client.conversations.items.list(id, params)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "after one response: [user msg, user msg, assistant msg] in asc order" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "conversations", "method": "GET", "path": "/v1/conversations/{conversation_id}/items/{item_id}", "name": "Conversations: retrieve item", "description": "Retrieve a single conversation item (query include[]).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ConversationItem" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Idempotent (GET)", "sdk": { "python": "client.conversations.items.retrieve(item_id, conversation_id=...)", "node": "client.conversations.items.retrieve(itemId, {conversation_id})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "200 -> message item with input_text content" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/retrieve", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "conversations", "method": "DELETE", "path": "/v1/conversations/{conversation_id}/items/{item_id}", "name": "Conversations: delete item", "description": "Delete one item. NOTE: returns the parent ConversationResource (id, object: \"conversation\", created_at, metadata), not a *.deleted object.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (project or user key; Organization/Project headers optional)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ConversationResource" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Second delete -> 404 (expected, not tested)", "sdk": { "python": "client.conversations.items.delete(item_id, conversation_id=...)", "node": "client.conversations.items.delete(itemId, {conversation_id})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "200, body = conversation object" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/delete", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-core.json" }, { "provider": "openai", "api_family": "batches", "method": "GET", "path": "/v1/batches", "name": "listBatches", "description": "List batches", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "ListBatchesResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "after", "limit" ] }, "idempotency": "safe", "sdk": { "python": "client.batches.list(**params)", "node": "client.batches.list({ ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "limit=3" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/batches", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/batch", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "batches", "method": "POST", "path": "/v1/batches", "name": "createBatch", "description": "Create batch", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateBatchRequest" }, "response": { "content_type": "application/json", "body_ref": "Batch", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.batches.create(**params)", "node": "client.batches.create({ ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "1-request /v1/responses gpt-5.4-nano; status validating -> in_progress (2s) -> finalizing -> completed at 30s; usage populated; output file purpose batch_output with expires_at honoring output_expires_after. NOTE: a bogus input_file_id is accepted with 200 (fails later during validation)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/batches", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/batch", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "batches", "method": "GET", "path": "/v1/batches/{batch_id}", "name": "retrieveBatch", "description": "Retrieve batch", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "Batch", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "safe", "sdk": { "python": "client.batches.retrieve(batch_id)", "node": "client.batches.retrieve(batchID)" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "404 for bogus id" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/batches", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/batch", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "batches", "method": "POST", "path": "/v1/batches/{batch_id}/cancel", "name": "cancelBatch", "description": "Cancel batch", "status": [ "DOCUMENTED", "LIVE_DISCOVERED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "Batch", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.batches.cancel(batch_id)", "node": "client.batches.cancel(batchID)" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 409, "request_note": "cancel on a batch that had just transitioned validating -> failed returned 409 Conflict (behaviour not documented); cancel on an in-progress batch not exercised because the 1-request test batch completed in 30s" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/batches", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/batch", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "evals", "method": "GET", "path": "/v1/evals", "name": "listEvals", "description": "List evals", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "EvalList", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "after", "limit", "order", "order_by" ] }, "idempotency": "safe", "sdk": { "python": "client.evals.list(**params)", "node": "client.evals.list({ ...params })" }, "deprecation": "Evals platform deprecated 2026-06-03: read-only 2026-10-31, dashboard + API shut down 2026-11-30.", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "list is eventually consistent: empty right after create, present 3s later" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "evals", "method": "POST", "path": "/v1/evals", "name": "createEval", "description": "Create eval", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateEvalRequest" }, "response": { "content_type": "application/json", "body_ref": "Eval", "success_codes": [ 201 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.evals.create(**params)", "node": "client.evals.create({ ...params })" }, "deprecation": "Evals platform deprecated 2026-06-03: read-only 2026-10-31, dashboard + API shut down 2026-11-30.", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 201, "request_note": "custom data_source_config (item_schema + include_sample_schema) with string_check/text_similarity/python criteria -> 201; logs config + label_model criterion -> 201; returned schema wraps {item, sample} with sample.required=[model, choices]" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "evals", "method": "DELETE", "path": "/v1/evals/{eval_id}", "name": "deleteEval", "description": "Delete an eval", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "object", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent", "sdk": { "python": "client.evals.delete(eval_id)", "node": "client.evals.delete(evalID)" }, "deprecation": "Evals platform deprecated 2026-06-03: read-only 2026-10-31, dashboard + API shut down 2026-11-30.", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "{object:'eval.deleted', deleted:true, eval_id}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "evals", "method": "GET", "path": "/v1/evals/{eval_id}", "name": "getEval", "description": "Get an eval", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "Eval", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "safe", "sdk": { "python": "client.evals.retrieve(eval_id)", "node": "client.evals.retrieve(evalID)" }, "deprecation": "Evals platform deprecated 2026-06-03: read-only 2026-10-31, dashboard + API shut down 2026-11-30.", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "404 after delete" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "evals", "method": "POST", "path": "/v1/evals/{eval_id}", "name": "updateEval", "description": "Update an eval", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "Eval", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.evals.update(eval_id, **params)", "node": "client.evals.update(evalID, { ...params })" }, "deprecation": "Evals platform deprecated 2026-06-03: read-only 2026-10-31, dashboard + API shut down 2026-11-30.", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "rename + metadata" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "evals", "method": "GET", "path": "/v1/evals/{eval_id}/runs", "name": "getEvalRuns", "description": "Get eval runs", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "EvalRunList", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "after", "limit", "order", "status" ] }, "idempotency": "safe", "sdk": { "python": "client.evals.runs.list(eval_id, **params)", "node": "client.evals.runs.list(evalID, { ...params })" }, "deprecation": "Evals platform deprecated 2026-06-03: read-only 2026-10-31, dashboard + API shut down 2026-11-30.", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "?status=completed returned 0 items right after completion (index lag)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "evals", "method": "POST", "path": "/v1/evals/{eval_id}/runs", "name": "createEvalRun", "description": "Create eval run", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateEvalRunRequest" }, "response": { "content_type": "application/json", "body_ref": "EvalRun", "success_codes": [ 201 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.evals.runs.create(eval_id, **params)", "node": "client.evals.runs.create(evalID, { ...params })" }, "deprecation": "Evals platform deprecated 2026-06-03: read-only 2026-10-31, dashboard + API shut down 2026-11-30.", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 201, "request_note": "jsonl file_content and jsonl file_id (purpose evals) with pre-filled sample {model, choices, output_text} -> 201 queued; sample without model/choices -> 400 'model is a required property'; responses source without model/input_messages -> 400" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "evals", "method": "DELETE", "path": "/v1/evals/{eval_id}/runs/{run_id}", "name": "deleteEvalRun", "description": "Delete eval run", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "object", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent", "sdk": { "python": "client.evals.runs.delete(run_id, *, eval_id)", "node": "client.evals.runs.delete(runID, { ...params })" }, "deprecation": "Evals platform deprecated 2026-06-03: read-only 2026-10-31, dashboard + API shut down 2026-11-30.", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "{object:'eval.run.deleted', deleted:true, run_id}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "evals", "method": "GET", "path": "/v1/evals/{eval_id}/runs/{run_id}", "name": "getEvalRun", "description": "Get an eval run", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "EvalRun", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "safe", "sdk": { "python": "client.evals.runs.retrieve(run_id, *, eval_id)", "node": "client.evals.runs.retrieve(runID, { ...params })" }, "deprecation": "Evals platform deprecated 2026-06-03: read-only 2026-10-31, dashboard + API shut down 2026-11-30.", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "queued -> in_progress -> completed in ~4s for 3 items, no sampling; result_counts + per_testing_criteria_results (with testing_criteria_id) populated" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "evals", "method": "POST", "path": "/v1/evals/{eval_id}/runs/{run_id}", "name": "cancelEvalRun", "description": "Cancel eval run", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "EvalRun", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.evals.runs.cancel(run_id, *, eval_id)", "node": "client.evals.runs.cancel(runID, { ...params })" }, "deprecation": "Evals platform deprecated 2026-06-03: read-only 2026-10-31, dashboard + API shut down 2026-11-30.", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "cancel on a completed run -> 200, status stays completed" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "evals", "method": "GET", "path": "/v1/evals/{eval_id}/runs/{run_id}/output_items", "name": "getEvalRunOutputItems", "description": "Get eval run output items", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "EvalRunOutputItemList", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "after", "limit", "status", "order" ] }, "idempotency": "safe", "sdk": { "python": "client.evals.runs.output_items.list(run_id, *, eval_id, **params)", "node": "client.evals.runs.outputItems.list(runID, { ...params })" }, "deprecation": "Evals platform deprecated 2026-06-03: read-only 2026-10-31, dashboard + API shut down 2026-11-30.", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "3 items, status pass|fail, ?status=fail filter works; results[] {name(id), type:null, score, passed}; extra fields _datasource_item_content_hash, available_includes" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "evals", "method": "GET", "path": "/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}", "name": "getEvalRunOutputItem", "description": "Get an output item of an eval run", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "EvalRunOutputItem", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "safe", "sdk": { "python": "client.evals.runs.output_items.retrieve(output_item_id, *, eval_id, run_id)", "node": "client.evals.runs.outputItems.retrieve(outputItemID, { ...params })" }, "deprecation": "Evals platform deprecated 2026-06-03: read-only 2026-10-31, dashboard + API shut down 2026-11-30.", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "single item" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/evals", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "files", "method": "GET", "path": "/v1/files", "name": "listFiles", "description": "List files", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "ListFilesResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "purpose", "limit", "order", "after" ] }, "idempotency": "safe", "sdk": { "python": "client.files.list(**params)", "node": "client.files.list({ ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "?purpose=user_data&limit=5 -> list envelope {object,data,first_id,last_id,has_more}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/files", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/file-inputs", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "files", "method": "POST", "path": "/v1/files", "name": "createFile", "description": "Upload file", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "CreateFileRequest" }, "response": { "content_type": "application/json", "body_ref": "OpenAIFile", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.files.create(**params)", "node": "client.files.create({ ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "multipart purposes user_data (+expires_after 3600s -> expires_at set), batch (default expires_at = +30d), evals, assistants; 200-byte txt and 1-line jsonl" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/files", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/file-inputs", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "files", "method": "DELETE", "path": "/v1/files/{file_id}", "name": "deleteFile", "description": "Delete file", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "DeleteFileResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent", "sdk": { "python": "client.files.delete(file_id)", "node": "client.files.delete(fileID)" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "{object:'file', id, deleted:true} for all 7 created files" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/files", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/file-inputs", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "files", "method": "GET", "path": "/v1/files/{file_id}", "name": "retrieveFile", "description": "Retrieve file", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "OpenAIFile", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "safe", "sdk": { "python": "client.files.retrieve(file_id)", "node": "client.files.retrieve(fileID)" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "200 for own file; 404 'No such File object' after delete" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/files", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/file-inputs", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "files", "method": "GET", "path": "/v1/files/{file_id}/content", "name": "downloadFile", "description": "Retrieve file content", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "string", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "safe", "sdk": { "python": "client.files.retrieve_content(file_id)", "node": "client.files.content(fileID)" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "200 (raw jsonl) for purpose batch_output; 400 'Not allowed to download files of purpose: user_data' for user_data" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/files", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/file-inputs", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "fine_tuning", "method": "GET", "path": "/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions", "name": "listFineTuningCheckpointPermissions", "description": "List checkpoint permissions", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "ListFineTuningCheckpointPermissionResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "project_id", "after", "limit", "order" ] }, "idempotency": "safe", "sdk": { "python": "client.fine_tuning.checkpoints.permissions.list(fine_tuned_model_checkpoint, **params)", "node": "client.fineTuning.checkpoints.permissions.list(fineTunedModelCheckpoint, { ...params })" }, "deprecation": "Self-serve fine-tuning is winding down: no new orgs since 2026-05-07, job creation ends 2027-01-06 (inference on existing ft: models continues until base-model deprecation).", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "401 'Missing scopes: api.fine_tuning.checkpoints.read' (requires org Owner role / admin scope)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/fine_tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/supervised-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/direct-preference-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/model-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "fine_tuning", "method": "POST", "path": "/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions", "name": "createFineTuningCheckpointPermission", "description": "Create checkpoint permissions", "status": [ "DOCUMENTED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateFineTuningCheckpointPermissionRequest" }, "response": { "content_type": "application/json", "body_ref": "ListFineTuningCheckpointPermissionResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.fine_tuning.checkpoints.permissions.create(fine_tuned_model_checkpoint, **params)", "node": "client.fineTuning.checkpoints.permissions.create(fineTunedModelCheckpoint, { ...params })" }, "deprecation": "Self-serve fine-tuning is winding down: no new orgs since 2026-05-07, job creation ends 2027-01-06 (inference on existing ft: models continues until base-model deprecation).", "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "success", "http_status": null, "request_note": "not called (admin-level write)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/fine_tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/supervised-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/direct-preference-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/model-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "fine_tuning", "method": "DELETE", "path": "/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}", "name": "deleteFineTuningCheckpointPermission", "description": "Delete checkpoint permission", "status": [ "DOCUMENTED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "DeleteFineTuningCheckpointPermissionResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent", "sdk": { "python": "client.fine_tuning.checkpoints.permissions.delete(permission_id, *, fine_tuned_model_checkpoint)", "node": "client.fineTuning.checkpoints.permissions.delete(permissionID, { ...params })" }, "deprecation": "Self-serve fine-tuning is winding down: no new orgs since 2026-05-07, job creation ends 2027-01-06 (inference on existing ft: models continues until base-model deprecation).", "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "success", "http_status": null, "request_note": "not called (admin-level write)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/fine_tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/supervised-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/direct-preference-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/model-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "fine_tuning", "method": "GET", "path": "/v1/fine_tuning/jobs", "name": "listPaginatedFineTuningJobs", "description": "List fine-tuning jobs", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "ListPaginatedFineTuningJobsResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "after", "limit", "metadata" ] }, "idempotency": "safe", "sdk": { "python": "client.fine_tuning.jobs.list(**params)", "node": "client.fineTuning.jobs.list({ ...params })" }, "deprecation": "Self-serve fine-tuning is winding down: no new orgs since 2026-05-07, job creation ends 2027-01-06 (inference on existing ft: models continues until base-model deprecation).", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "empty list {object,data,has_more}; metadata[owner]=x filter accepted" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/fine_tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/supervised-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/direct-preference-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/model-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "fine_tuning", "method": "POST", "path": "/v1/fine_tuning/jobs", "name": "createFineTuningJob", "description": "Create fine-tuning job", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateFineTuningJobRequest" }, "response": { "content_type": "application/json", "body_ref": "FineTuningJob", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.fine_tuning.jobs.create(**params)", "node": "client.fineTuning.jobs.create({ ...params })" }, "deprecation": "Self-serve fine-tuning is winding down: no new orgs since 2026-05-07, job creation ends 2027-01-06 (inference on existing ft: models continues until base-model deprecation).", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "validation-only call with bogus training_file -> 403 code training_not_available: 'OpenAI is winding down the fine-tuning platform and your organization is no longer able to create new fine-tuning training jobs'" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/fine_tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/supervised-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/direct-preference-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/model-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "fine_tuning", "method": "GET", "path": "/v1/fine_tuning/jobs/{fine_tuning_job_id}", "name": "retrieveFineTuningJob", "description": "Retrieve fine-tuning job", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "FineTuningJob", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "safe", "sdk": { "python": "client.fine_tuning.jobs.retrieve(fine_tuning_job_id)", "node": "client.fineTuning.jobs.retrieve(fineTuningJobID)" }, "deprecation": "Self-serve fine-tuning is winding down: no new orgs since 2026-05-07, job creation ends 2027-01-06 (inference on existing ft: models continues until base-model deprecation).", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 404, "request_note": "bogus id -> 404 code fine_tune_not_found (endpoint reachable)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/fine_tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/supervised-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/direct-preference-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/model-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "fine_tuning", "method": "POST", "path": "/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel", "name": "cancelFineTuningJob", "description": "Cancel fine-tuning", "status": [ "DOCUMENTED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "FineTuningJob", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.fine_tuning.jobs.cancel(fine_tuning_job_id)", "node": "client.fineTuning.jobs.cancel(fineTuningJobID)" }, "deprecation": "Self-serve fine-tuning is winding down: no new orgs since 2026-05-07, job creation ends 2027-01-06 (inference on existing ft: models continues until base-model deprecation).", "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "success", "http_status": null, "request_note": "not called (no job)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/fine_tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/supervised-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/direct-preference-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/model-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "fine_tuning", "method": "GET", "path": "/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints", "name": "listFineTuningJobCheckpoints", "description": "List fine-tuning checkpoints", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "ListFineTuningJobCheckpointsResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "after", "limit" ] }, "idempotency": "safe", "sdk": { "python": "client.fine_tuning.jobs.checkpoints.list(fine_tuning_job_id, **params)", "node": "client.fineTuning.jobs.checkpoints.list(fineTuningJobID, { ...params })" }, "deprecation": "Self-serve fine-tuning is winding down: no new orgs since 2026-05-07, job creation ends 2027-01-06 (inference on existing ft: models continues until base-model deprecation).", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 404, "request_note": "bogus id -> 404 fine_tune_not_found" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/fine_tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/supervised-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/direct-preference-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/model-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "fine_tuning", "method": "GET", "path": "/v1/fine_tuning/jobs/{fine_tuning_job_id}/events", "name": "listFineTuningEvents", "description": "List fine-tuning events", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "ListFineTuningJobEventsResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "after", "limit" ] }, "idempotency": "safe", "sdk": { "python": "client.fine_tuning.jobs.list_events(fine_tuning_job_id, **params)", "node": "client.fineTuning.jobs.listEvents(fineTuningJobID, { ...params })" }, "deprecation": "Self-serve fine-tuning is winding down: no new orgs since 2026-05-07, job creation ends 2027-01-06 (inference on existing ft: models continues until base-model deprecation).", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 404, "request_note": "bogus id -> 404 fine_tune_not_found" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/fine_tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/supervised-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/direct-preference-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/model-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "fine_tuning", "method": "POST", "path": "/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause", "name": "pauseFineTuningJob", "description": "Pause fine-tuning", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "FineTuningJob", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.fine_tuning.jobs.pause(fine_tuning_job_id)", "node": "client.fineTuning.jobs.pause(fineTuningJobID)" }, "deprecation": "Self-serve fine-tuning is winding down: no new orgs since 2026-05-07, job creation ends 2027-01-06 (inference on existing ft: models continues until base-model deprecation).", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 404, "request_note": "bogus id -> 404 fine_tune_not_found" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/fine_tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/supervised-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/direct-preference-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/model-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "fine_tuning", "method": "POST", "path": "/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume", "name": "resumeFineTuningJob", "description": "Resume fine-tuning", "status": [ "DOCUMENTED", "DEPRECATED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "FineTuningJob", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.fine_tuning.jobs.resume(fine_tuning_job_id)", "node": "client.fineTuning.jobs.resume(fineTuningJobID)" }, "deprecation": "Self-serve fine-tuning is winding down: no new orgs since 2026-05-07, job creation ends 2027-01-06 (inference on existing ft: models continues until base-model deprecation).", "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "success", "http_status": null, "request_note": "not called (no job)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/fine_tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/supervised-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/direct-preference-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/model-optimization", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "graders", "method": "POST", "path": "/v1/fine_tuning/alpha/graders/run", "name": "runGrader", "description": "Run grader", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED", "BETA" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "RunGraderRequest" }, "response": { "content_type": "application/json", "body_ref": "RunGraderResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.fine_tuning.alpha.graders.run(**params)", "node": "client.fineTuning.alpha.graders.run({ ...params })" }, "deprecation": "Graders are deprecated together with the Evals platform (API shutdown 2026-11-30) and the fine-tuning platform (2027-01-06).", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "string_check reward 1.0 (0.4ms), text_similarity fuzzy_match 0.756, python 1.0 (2.3s sandbox), multi with calculate_output -> sub_rewards; no model grader run (cost)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/graders", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/graders", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "graders", "method": "POST", "path": "/v1/fine_tuning/alpha/graders/validate", "name": "validateGrader", "description": "Validate grader", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "DEPRECATED", "BETA" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ValidateGraderRequest" }, "response": { "content_type": "application/json", "body_ref": "ValidateGraderResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.fine_tuning.alpha.graders.validate(**params)", "node": "client.fineTuning.alpha.graders.validate({ ...params })" }, "deprecation": "Graders are deprecated together with the Evals platform (API shutdown 2026-11-30) and the fine-tuning platform (2027-01-06).", "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "string_check + python graders -> {grader}; invalid operation 'contains' -> 400 type invalid_value param operation" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/graders", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/graders", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "uploads", "method": "POST", "path": "/v1/uploads", "name": "createUpload", "description": "Create upload", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "LIVE_DISCOVERED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateUploadRequest" }, "response": { "content_type": "application/json", "body_ref": "Upload", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.uploads.create(**params)", "node": "client.uploads.create({ ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "purpose user_data accepted although the OpenAPI enum lists only assistants|batch|fine-tune|vision; status pending; expires_at = created_at + 3600" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/uploads", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "uploads", "method": "POST", "path": "/v1/uploads/{upload_id}/cancel", "name": "cancelUpload", "description": "Cancel upload", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "Upload", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.uploads.cancel(upload_id)", "node": "client.uploads.cancel(uploadID)" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "status cancelled" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/uploads", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "uploads", "method": "POST", "path": "/v1/uploads/{upload_id}/complete", "name": "completeUpload", "description": "Complete upload", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CompleteUploadRequest" }, "response": { "content_type": "application/json", "body_ref": "Upload", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.uploads.complete(upload_id, **params)", "node": "client.uploads.complete(uploadID, { ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "part_ids -> status completed, file.purpose user_data, file.bytes == declared bytes" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/uploads", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "uploads", "method": "POST", "path": "/v1/uploads/{upload_id}/parts", "name": "addUploadPart", "description": "Add upload part", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "AddUploadPartRequest" }, "response": { "content_type": "application/json", "body_ref": "UploadPart", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.uploads.parts.create(upload_id, **params)", "node": "client.uploads.parts.create(uploadID, { ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "multipart field 'data' -> {object:'upload.part'}; 400 after cancel: 'Upload status is already in a cancelled state'" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/uploads", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "GET", "path": "/v1/vector_stores", "name": "listVectorStores", "description": "List vector stores", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "ListVectorStoresResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after", "before" ] }, "idempotency": "safe", "sdk": { "python": "client.vector_stores.list(**params)", "node": "client.vectorStores.list({ ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "limit=5" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "POST", "path": "/v1/vector_stores", "name": "createVectorStore", "description": "Create vector store", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateVectorStoreRequest" }, "response": { "content_type": "application/json", "body_ref": "VectorStoreObject", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.vector_stores.create(**params)", "node": "client.vectorStores.create({ ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "name+description+metadata+expires_after(last_active_at,1d) -> status completed, usage_bytes 0" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "DELETE", "path": "/v1/vector_stores/{vector_store_id}", "name": "deleteVectorStore", "description": "Delete vector store", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "DeleteVectorStoreResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent", "sdk": { "python": "client.vector_stores.delete(vector_store_id)", "node": "client.vectorStores.delete(vectorStoreID)" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "{object:'vector_store.deleted', deleted:true}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "GET", "path": "/v1/vector_stores/{vector_store_id}", "name": "getVectorStore", "description": "Retrieve vector store", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "VectorStoreObject", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "safe", "sdk": { "python": "client.vector_stores.retrieve(vector_store_id)", "node": "client.vectorStores.retrieve(vectorStoreID)" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "usage_bytes 1203 after a 200-byte file (index overhead); 404 for bogus id" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "POST", "path": "/v1/vector_stores/{vector_store_id}", "name": "modifyVectorStore", "description": "Modify vector store", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "UpdateVectorStoreRequest" }, "response": { "content_type": "application/json", "body_ref": "VectorStoreObject", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.vector_stores.update(vector_store_id, **params)", "node": "client.vectorStores.update(vectorStoreID, { ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "rename + metadata replace" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "POST", "path": "/v1/vector_stores/{vector_store_id}/file_batches", "name": "createVectorStoreFileBatch", "description": "Create vector store file batch", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateVectorStoreFileBatchRequest" }, "response": { "content_type": "application/json", "body_ref": "VectorStoreFileBatchObject", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.vector_stores.file_batches.create(vector_store_id, **params)", "node": "client.vectorStores.fileBatches.create(vectorStoreID, { ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "files[] form with per-file attributes + chunking_strategy auto -> object 'vector_store.file_batch' (spec says vector_store.files_batch), in_progress -> completed ~4s" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "GET", "path": "/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}", "name": "getVectorStoreFileBatch", "description": "Retrieve vector store file batch", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "VectorStoreFileBatchObject", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "safe", "sdk": { "python": "client.vector_stores.file_batches.retrieve(batch_id, *, vector_store_id)", "node": "client.vectorStores.fileBatches.retrieve(batchID, { ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "polled to completed" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "POST", "path": "/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel", "name": "cancelVectorStoreFileBatch", "description": "Cancel vector store file batch", "status": [ "DOCUMENTED", "FAILED_VERIFICATION" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "VectorStoreFileBatchObject", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.vector_stores.file_batches.cancel(batch_id, *, vector_store_id)", "node": "client.vectorStores.fileBatches.cancel(batchID, { ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 500, "request_note": "cancel on an already-completed batch returned HTTP 500 'The server had an error processing your request' (not tested on an in-progress batch)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "GET", "path": "/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files", "name": "listFilesInVectorStoreBatch", "description": "List vector store files in a batch", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "ListVectorStoreFilesResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after", "before", "filter" ] }, "idempotency": "safe", "sdk": { "python": "client.vector_stores.file_batches.list_files(batch_id, *, vector_store_id, **params)", "node": "client.vectorStores.fileBatches.listFiles(batchID, { ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "returned chunking_strategy.type 'static' for a file added with type auto (auto resolves to static 800/400)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "GET", "path": "/v1/vector_stores/{vector_store_id}/files", "name": "listVectorStoreFiles", "description": "List vector store files", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "ListVectorStoreFilesResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after", "before", "filter" ] }, "idempotency": "safe", "sdk": { "python": "client.vector_stores.files.list(vector_store_id, **params)", "node": "client.vectorStores.files.list(vectorStoreID, { ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "?filter=completed" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "POST", "path": "/v1/vector_stores/{vector_store_id}/files", "name": "createVectorStoreFile", "description": "Create vector store file", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateVectorStoreFileRequest" }, "response": { "content_type": "application/json", "body_ref": "VectorStoreFileObject", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.vector_stores.files.create(vector_store_id, **params)", "node": "client.vectorStores.files.create(vectorStoreID, { ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "static chunking 100/20 + attributes {string,number,boolean} -> in_progress, completed after ~7.6s" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "DELETE", "path": "/v1/vector_stores/{vector_store_id}/files/{file_id}", "name": "deleteVectorStoreFile", "description": "Delete vector store file", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "DeleteVectorStoreFileResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "idempotent", "sdk": { "python": "client.vector_stores.files.delete(file_id, *, vector_store_id)", "node": "client.vectorStores.files.delete(fileID, { ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "{object:'vector_store.file.deleted', deleted:true}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "GET", "path": "/v1/vector_stores/{vector_store_id}/files/{file_id}", "name": "getVectorStoreFile", "description": "Retrieve vector store file", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "VectorStoreFileObject", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "safe", "sdk": { "python": "client.vector_stores.files.retrieve(file_id, *, vector_store_id)", "node": "client.vectorStores.files.retrieve(fileID, { ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "polled in_progress -> completed (7.6s)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "POST", "path": "/v1/vector_stores/{vector_store_id}/files/{file_id}", "name": "updateVectorStoreFileAttributes", "description": "Update vector store file attributes", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "UpdateVectorStoreFileAttributesRequest" }, "response": { "content_type": "application/json", "body_ref": "VectorStoreFileObject", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.vector_stores.files.update(file_id, *, vector_store_id, **params)", "node": "client.vectorStores.files.update(fileID, { ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "attributes replaced wholesale (not merged)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "GET", "path": "/v1/vector_stores/{vector_store_id}/files/{file_id}/content", "name": "retrieveVectorStoreFileContent", "description": "Retrieve vector store file content", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "VectorStoreFileContentResponse", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "safe", "sdk": { "python": "client.vector_stores.files.content(file_id, *, vector_store_id)", "node": "client.vectorStores.files.content(fileID, { ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "{object:'vector_store.file_content.page', data:[{type:'text',text}], has_more, next_page}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "vector_stores", "method": "POST", "path": "/v1/vector_stores/{vector_store_id}/search", "name": "searchVectorStore", "description": "Search vector store", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (project or user key)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "VectorStoreSearchRequest" }, "response": { "content_type": "application/json", "body_ref": "VectorStoreSearchResultsPage", "success_codes": [ 200 ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not idempotent", "sdk": { "python": "client.vector_stores.search(vector_store_id, **params)", "node": "client.vectorStores.search(vectorStoreID, { ...params })" }, "deprecation": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "string query + and/eq/gte filters + rewrite_query (search_query rewritten) + ranking_options; array query + ranker none; non-matching filter -> empty data" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/vector_stores", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/retrieval", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/tools-file-search", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/openai-files-vectorstores-batch-finetuning-evals.json" }, { "provider": "openai", "api_family": "images", "method": "POST", "path": "/v1/images/generations", "name": "Create image", "description": "Creates one or more images from a text prompt. GPT image models return base64 (b64_json) plus token usage; supports streaming of partial images (stream=true, partial_images 0-3).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateImageRequest" }, "response": { "content_type": "application/json", "object": "ImagesResponse", "live_note": "data[0] contained b64_json AND an undocumented generation_id (LIVE_DISCOVERED); usage present" }, "streaming": { "supported": true, "events_ref": "openai-images streaming events (image_generation.partial_image, image_generation.completed)", "transport": "SSE, `event:` + `data:` lines" }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.images.generate(**params)", "node": "client.images.generate({...})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "gpt-image-1-mini, 1024x1024, quality=low, output_format=jpeg, prompt 'a plain white square' -> 200 in 5.7 s; usage input 10 text tokens / output 272 image tokens; est. $0.0022. Invalid size -> 400 image_generation_user_error/invalid_value. style / response_format on gpt-image-1-mini -> 400 unknown_parameter. dall-e-3 -> 400 \"The model 'dall-e-3' does not exist.\"" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/images", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/image-generation", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "notes": "Defaults to dall-e-2 per docs unless a GPT-image-only parameter is used, but DALL-E models were removed 2026-05-12: always pass model explicitly. Org verification may be required for GPT Image models.", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "images", "method": "POST", "path": "/v1/images/edits", "name": "Create image edit", "description": "Creates an edited or extended image from 1-16 source images (multipart `image`/`image[]` or JSON `images[]` with file_id/image_url), an optional PNG mask (alpha=0 marks editable area, applied to the first image) and a prompt. Supports input_fidelity, streaming, background, output_format.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": "multipart/form-data | application/json", "body_ref": "CreateImageEditRequest" }, "response": { "content_type": "application/json", "object": "ImagesResponse" }, "streaming": { "supported": true, "events_ref": "openai-images streaming events (image_edit.partial_image, image_edit.completed)" }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.images.edit(**params)", "node": "client.images.edit({...})" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_run", "http_status": null, "request_note": "not called (paid); parameters cross-checked against OpenAPI CreateImageEditRequest and the JSON body documented in the reference page" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/images", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/image-generation", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "notes": "Spec default model = gpt-image-1.5. Mask must be PNG < 4 MB with alpha channel, same size as the first image (guide: image + mask < 50 MB). gpt-image-2 always processes inputs at high fidelity (input_fidelity not settable).", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "images", "method": "POST", "path": "/v1/images/variations", "name": "Create image variation (legacy)", "description": "Creates variations of a square PNG (< 4 MB). Only dall-e-2 was ever supported.", "status": [ "DOCUMENTED", "LEGACY", "RETIRED", "FAILED_VERIFICATION" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "CreateImageVariationRequest" }, "response": { "content_type": "application/json", "object": "ImagesResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.images.create_variation(**params)", "node": "client.images.createVariation({...})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "multipart model=dall-e-2 n=1 size=256x256 with a 1x1 PNG -> HTTP 404 with EMPTY body (no JSON error). Consistent with dall-e-2 removal on 2026-05-12." }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/images", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/image-generation", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "notes": "Still present in reference + OpenAPI, but non-functional for our key: treat as RETIRED.", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "videos", "method": "POST", "path": "/v1/videos", "name": "Create video", "description": "Starts an asynchronous Sora video render job (status queued -> in_progress -> completed|failed). Accepts JSON or multipart (multipart allows uploading input_reference bytes).", "status": [ "DOCUMENTED", "DEPRECATED", "UNVERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": "application/json | multipart/form-data", "body_ref": "CreateVideoJsonBody | CreateVideoMultipartBody" }, "response": { "content_type": "application/json", "object": "Video" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.videos.create(**params) / client.videos.create_and_poll(...)", "node": "client.videos.create({...})" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_run", "http_status": null, "request_note": "not called (cost $0.10-$0.70 per second). List/retrieve verified instead." }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/videos", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/video-generation", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "notes": "Videos API + all Sora 2 models: deprecation notice 2026-03-24, shutdown 2026-09-24 (deprecations page). Still reachable on 2026-09-18. Also supported through the Batch API (JSON only, url /v1/videos). Guide documents a `characters: [{id}]` array that is absent from the OpenAPI spec.", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "videos", "method": "GET", "path": "/v1/videos", "name": "List videos", "description": "Lists video jobs of the current project (cursor pagination).", "status": [ "DOCUMENTED", "DEPRECATED", "LIVE_VERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "list of Video", "live_note": "items carried undocumented `edited_from_video_id` and `extended_from_video_id` fields (LIVE_DISCOVERED)" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "after", "limit", "order" ], "fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "none documented", "sdk": { "python": "client.videos.list(**params)", "node": "client.videos.list({...})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "GET /v1/videos?limit=2 -> 200, 1 completed sora-2 job from 2026-07 (expired assets)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/videos", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/video-generation", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "notes": "Videos API + all Sora 2 models: deprecation notice 2026-03-24, shutdown 2026-09-24 (deprecations page). Still reachable on 2026-09-18.", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "videos", "method": "GET", "path": "/v1/videos/{video_id}", "name": "Retrieve video", "description": "Fetches the latest metadata/status of a video job.", "status": [ "DOCUMENTED", "DEPRECATED", "LIVE_VERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "Video" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.videos.retrieve(video_id)", "node": "client.videos.retrieve(videoID)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "existing id -> 200 (status completed, progress 100); unknown id -> 404 invalid_request_error \"Video with id '...' not found.\" (code null)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/videos", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/video-generation", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "notes": "Videos API + all Sora 2 models: deprecation notice 2026-03-24, shutdown 2026-09-24 (deprecations page). Still reachable on 2026-09-18.", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "videos", "method": "DELETE", "path": "/v1/videos/{video_id}", "name": "Delete video", "description": "Permanently deletes a completed or failed video and its stored assets.", "status": [ "DOCUMENTED", "DEPRECATED", "UNVERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "VideoDeleteResponse {id, deleted, object:'video.deleted'}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.videos.delete(video_id)", "node": "client.videos.delete(videoID)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_run", "http_status": null, "request_note": "destructive; not called" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/videos", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/video-generation", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "notes": "Videos API + all Sora 2 models: deprecation notice 2026-03-24, shutdown 2026-09-24 (deprecations page). Still reachable on 2026-09-18.", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "videos", "method": "GET", "path": "/v1/videos/{video_id}/content", "name": "Download video content", "description": "Streams the rendered MP4 (default) or a derived asset: ?variant=thumbnail (image/webp) | spritesheet (jpg).", "status": [ "DOCUMENTED", "DEPRECATED", "LIVE_VERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "video/mp4 | image/webp | image/jpeg | application/json (error)", "object": "binary" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.videos.download_content(video_id, variant=...)", "node": "client.videos.downloadContent(videoID, {variant})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "variant=thumbnail on a 2-month-old completed job -> 404 invalid_request_error \"The video is no longer available. Downloads expire after 48 hours.\" (endpoint reachable; asset expired)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/videos", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/video-generation", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "notes": "Assets expire (expires_at; live message says 48 h; batch guide says 24 h after batch completion). Videos API + all Sora 2 models: deprecation notice 2026-03-24, shutdown 2026-09-24 (deprecations page). Still reachable on 2026-09-18.", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "videos", "method": "POST", "path": "/v1/videos/{video_id}/remix", "name": "Create video remix (being replaced by edits)", "description": "Creates a new job re-rendering a completed video with a refreshed prompt. Changelog 2026-03-12: replaced by POST /v1/videos/edits, deprecated in 6 months.", "status": [ "DOCUMENTED", "DEPRECATED", "UNVERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "{prompt}" }, "response": { "content_type": "application/json", "object": "Video (remixed_from_video_id set)" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.videos.remix(video_id, prompt=...)", "node": "client.videos.remix(videoID, {prompt})" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_run", "http_status": null, "request_note": "documented only; not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/videos", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/video-generation", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/changelog", "retrieved_at": "2026-09-18" } ], "notes": "Videos API + all Sora 2 models: deprecation notice 2026-03-24, shutdown 2026-09-24 (deprecations page). Still reachable on 2026-09-18.", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "videos", "method": "POST", "path": "/v1/videos/edits", "name": "Create video edit", "description": "Edits an existing generated video (JSON `video: {id}`) or an uploaded MP4 (multipart `video` file + explicit `model`; upload path limited to eligible customers). Model is inferred from the source video id.", "status": [ "DOCUMENTED", "DEPRECATED", "UNVERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": "application/json | multipart/form-data", "body_ref": "CreateVideoEditJsonBody | CreateVideoEditMultipartBody" }, "response": { "content_type": "application/json", "object": "Video (live list shows edited_from_video_id)" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.videos.edit(**params)", "node": "client.videos.edit({...})" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_run", "http_status": null, "request_note": "documented only; not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/videos", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/video-generation", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "notes": "Videos API + all Sora 2 models: deprecation notice 2026-03-24, shutdown 2026-09-24 (deprecations page). Still reachable on 2026-09-18.", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "videos", "method": "POST", "path": "/v1/videos/extensions", "name": "Create video extension", "description": "Continues a completed video: generates the next segment (`seconds` 4-20 per extension, up to 6 extensions / 120 s total) stitched to the source. No characters or image references.", "status": [ "DOCUMENTED", "DEPRECATED", "UNVERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": "application/json | multipart/form-data", "body_ref": "CreateVideoExtendJsonBody | CreateVideoExtendMultipartBody" }, "response": { "content_type": "application/json", "object": "Video (seconds = stitched total; live list shows extended_from_video_id)" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.videos.extend(**params)", "node": "client.videos.extend({...})" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_run", "http_status": null, "request_note": "documented only; not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/videos", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/video-generation", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "notes": "Videos API + all Sora 2 models: deprecation notice 2026-03-24, shutdown 2026-09-24 (deprecations page). Still reachable on 2026-09-18.", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "videos", "method": "POST", "path": "/v1/videos/characters", "name": "Create character", "description": "Creates a reusable non-human character (cameo) from a short MP4 (2-4 s, 16:9 or 9:16, 720p-1080p). Human likeness blocked by default. Reference the returned id in `characters: [{id}]` and mention the name verbatim in the prompt (max 2 characters per video).", "status": [ "DOCUMENTED", "DEPRECATED", "UNVERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "CreateVideoCharacterBody" }, "response": { "content_type": "application/json", "object": "VideoCharacterResource {id, name, created_at}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.videos.create_character(video=..., name=...)", "node": "client.videos.createCharacter({...})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 400, "request_note": "GET /v1/videos/characters?limit=1 (probe for an undocumented list op) -> 400 invalid_value \"Invalid 'video_id': 'characters'. Expected an ID that begins with 'video'.\" => no list operation; path is routed as /videos/{video_id} for GET" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/videos", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/video-generation", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "notes": "Videos API + all Sora 2 models: deprecation notice 2026-03-24, shutdown 2026-09-24 (deprecations page). Still reachable on 2026-09-18.", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "videos", "method": "GET", "path": "/v1/videos/characters/{character_id}", "name": "Retrieve character", "description": "Fetches a character by id.", "status": [ "DOCUMENTED", "DEPRECATED", "UNVERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "VideoCharacterResource" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.videos.get_character(character_id)", "node": "client.videos.getCharacter(characterID)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_run", "http_status": null, "request_note": "documented only; not called in this run" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/videos", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/video-generation", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "notes": "Videos API + all Sora 2 models: deprecation notice 2026-03-24, shutdown 2026-09-24 (deprecations page). Still reachable on 2026-09-18.", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "embeddings", "method": "POST", "path": "/v1/embeddings", "name": "Create embeddings", "description": "Returns embedding vectors for a string, an array of up to 2048 strings, a token array or an array of token arrays. Max 8192 tokens per input and 300,000 tokens summed per request.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateEmbeddingRequest" }, "response": { "content_type": "application/json", "object": "CreateEmbeddingResponse {object:'list', data[Embedding], model, usage{prompt_tokens,total_tokens}}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.embeddings.create(**params)", "node": "client.embeddings.create({...})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "input 'OK': 3-small -> 1536 floats, 3-large -> 3072, ada-002 -> 1536 (response model 'text-embedding-ada-002-v2'); usage prompt_tokens=1 each; L2 norms ~1.000. dimensions=16 + encoding_format=base64 -> 88-char base64 = 64 bytes = 16 little-endian float32, still unit-norm. dimensions on ada-002 -> 400 'This model does not support specifying dimensions.' Token-array input [[11380]] -> 200." }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/embeddings", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/embeddings", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/pricing", "retrieved_at": "2026-09-18" } ], "notes": "Also available via Batch API (all three models) and regional endpoints. Observed header x-ratelimit-limit-requests: 10000 (account-specific).", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "moderations", "method": "POST", "path": "/v1/moderations", "name": "Create moderation", "description": "Classifies text and/or image inputs against 13 harm categories. Free of charge. omni-moderation accepts text + image_url (URL or data URL, images <= 20 MB); no audio.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateModerationRequest" }, "response": { "content_type": "application/json", "object": "CreateModerationResponse {id, model, results[Moderation]}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.moderations.create(**params)", "node": "client.moderations.create({...})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "omni-moderation-latest text 'Reply with OK.' -> 200 flagged=false, 13 categories, all category_applied_input_types=['text']. Multimodal text + 1x1 PNG data URL -> 200; image-capable categories reported ['text','image']. text-moderation-latest -> 400 invalid_request_error param=model (removed 2025-10-27)." }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/moderations", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/guides/moderation", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/pricing", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/docs/deprecations", "retrieved_at": "2026-09-18" } ], "notes": "Inline alternative: pass top-level `moderation: {model}` in /v1/responses or /v1/chat/completions to get scores for input and output (changelog).", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "safety", "method": "GET", "path": "/v1/safety/alerts/{id}", "name": "Get project safety alert", "description": "Returns a misalignment-monitoring alert (safety.alert object) belonging to the authenticated API project. Alert ids arrive via the `safety.alert.created` / `safety.org_alert.created` webhooks (pattern ^alert_[0-9a-f]{32}$).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "SafetyAlertResource" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.safety.alerts.retrieve(id)", "node": "client.safety.alerts.retrieve(id)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "GET /v1/safety/alerts/salert_atlasprobe -> 404 {type: invalid_request_error, code: safety_alert_not_found, message: 'Safety alert not found.'} => endpoint reachable with a standard project key; we simply have no alerts" }, "sources": [ { "url": "https://developers.openai.com/api/docs/guides/safety-checks/misalignment-monitoring", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "notes": "Reference page for this resource is not in the downloaded docs set; documented in the misalignment-monitoring guide and the OpenAPI spec (operationId Getprojectsafetyalert, group safety-alerts).", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "safety", "method": "GET", "path": "/v1/safety/cases/{id}", "name": "Get safety case", "description": "Returns a safety case (warning or deactivation issued for a safety identifier). Case ids arrive via `safety.warning_issued` / `safety.deactivation_issued` webhooks (example id 'C-abc123').", "status": [ "LIVE_DISCOVERED", "ACCOUNT_RESTRICTED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "object": "SafetyCaseResource" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "not in python-sdk-api.md (spec-only)", "node": "not in node-sdk-api.md (spec-only)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 403, "request_note": "GET /v1/safety/cases/C-atlasprobe -> 403 with a NON-standard body: {\"error\": \"You have insufficient permissions for this operation. Missing scopes: api.safety.read. ...\"} (error is a string, not an object). Requires scope api.safety.read." }, "sources": [ { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "notes": "Spec-only (operationId Getsafetycase, group safety-cases); no guide/reference page in the downloaded docs.", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "content_provenance", "method": "POST", "path": "/v1/content_provenance_checks", "name": "Create content provenance check", "description": "Synchronously checks an image (PNG/JPEG/WebP) or audio file (MP3/Opus/AAC/FLAC/WAV/PCM, <= 60 s) for OpenAI provenance signals: C2PA Content Credentials (images) and SynthID watermark (images + audio). One file per request, <= 50 MiB.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "CreateContentProvenanceBody {file}" }, "response": { "content_type": "application/json", "object": "ProvenanceResource {object:'content_provenance_check', created_at, results[C2PA|SynthID]}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "none documented", "sdk": { "python": "client.content_provenance_checks.create(file=...)", "node": "client.contentProvenanceChecks.create({file})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "fresh gpt-image-1-mini JPEG -> 200: c2pa outcome=detected validation_state=trusted issuer='OpenAI OpCo, LLC' model='API / gpt-image' generated_at set; synthid outcome=not_detected. 1x1 hand-made PNG -> c2pa not_detected/not_present, synthid not_detected." }, "sources": [ { "url": "https://developers.openai.com/api/docs/guides/content-provenance", "retrieved_at": "2026-09-18" }, { "url": "https://developers.openai.com/api/reference/resources/content_provenance_checks/methods/create", "retrieved_at": "2026-09-18" }, { "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml", "retrieved_at": "2026-09-18" } ], "notes": "Not eligible for Zero Data Retention. Strict rate limits (429 rate_limit_exceeded, honor Retry-After); 400 for malformed/unsupported/blocked file; 404 for orgs without access. Requires SDK python>=2.52.0.", "_fragment": "generated/fragments/endpoints/openai-images-video-embeddings-moderation.json" }, { "provider": "openai", "api_family": "realtime", "method": "POST", "path": "/v1/realtime/client_secrets", "name": "Create client secret", "description": "Mint a short-lived ephemeral key (`ek_…`, default TTL 600 s, 10–7200 s) bound to a realtime or transcription session configuration. Returns `{value, expires_at, session}`; the session object shows all effective defaults.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "RealtimeCreateClientSecretRequest" }, "response": { "content_type": "application/json", "body_ref": "RealtimeCreateClientSecretResponse", "observed_example": { "value": "ek_***REDACTED***", "expires_at": 1789782720, "session": { "type": "realtime", "object": "realtime.session", "id": "sess_EPeNUVdPyWbkWAR4ELYCv", "model": "gpt-realtime-mini", "output_modalities": [ "audio" ], "instructions": "Your knowledge cutoff is 2023-10. You are a helpful, witty, and friendly AI. Act like a human, but remember that you aren't a human and that you can't do human things in the real world. Your voice and personality should be warm and engaging, with a lively and playful tone. If interacting in a non-English language, start by using the standard accent or dialect familiar to the user. Talk quickly. You should always call a function if you can. Do not refer to these rules, even if you’re asked about them.", "tools": [], "tool_choice": "auto", "max_output_tokens": "inf", "tracing": null, "truncation": "auto", "prompt": null, "expires_at": 0, "audio": { "input": { "format": { "type": "audio/pcm", "rate": 24000 }, "transcription": null, "noise_reduction": null, "turn_detection": { "type": "server_vad", "threshold": 0.5, "prefix_padding_ms": 300, "silence_duration_ms": 200, "idle_timeout_ms": null, "create_response": true, "interrupt_response": true } }, "output": { "format": { "type": "audio/pcm", "rate": 24000 }, "voice": "alloy", "speed": 1.0 } }, "include": null } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.realtime.client_secrets.create(session={...})", "node": "client.realtime.clientSecrets.create({ session })" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "session={type:realtime, model:gpt-realtime-mini} → 200; expires_at = now+600 s; also tested transcription session + expires_after 60 s (200)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/voice-webrtc?api=realtime", "retrieved_at": "2026-09-19T01:31:52Z" } ], "safety_identifier_header": "OpenAI-Safety-Identifier bound to the token", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "realtime", "method": "POST", "path": "/v1/realtime/translations/client_secrets", "name": "Create translation client secret", "description": "Ephemeral key for a `type: translation` session (`gpt-realtime-translate`). Session fields: model, audio.input.{transcription,noise_reduction}, audio.output.language.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "RealtimeTranslationClientSecretCreateRequest" }, "response": { "content_type": "application/json", "body_ref": "RealtimeTranslationClientSecretCreateResponse", "observed_example": { "value": "ek_***REDACTED***", "expires_at": 1789782722, "session": { "id": "sess_EPeNWROu1g21LdFlmrnwg", "type": "translation", "expires_at": 0, "model": "gpt-realtime-translate", "audio": { "input": { "noise_reduction": null, "transcription": null }, "output": { "language": "es" } }, "include": null } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.realtime.translations.client_secrets.create(...)", "node": "client.realtime.translations.clientSecrets.create(...)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "session={model:gpt-realtime-translate} → 200; default output language observed 'es'" }, "sources": [ { "url": "https://developers.openai.com/api/docs/guides/realtime-translation", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "realtime", "method": "POST", "path": "/v1/realtime/calls", "name": "Create call (WebRTC unified interface)", "description": "Exchange a WebRTC SDP offer for the SDP answer. Body is either raw `application/sdp` (ephemeral-key flow from the browser) or `multipart/form-data` with `sdp` + optional `session` JSON part (server flow with standard key). Response 201 `application/sdp`; `Location` header carries the `call_id` (`rtc_…`) usable for a sideband WebSocket `wss://api.openai.com/v1/realtime?call_id=…`.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer ephemeral client secret `ek_…` (browser/mobile) OR standard API key (server)", "beta_header": null, "request": { "content_type": "application/sdp | multipart/form-data", "body_ref": "RealtimeCallCreateRequest" }, "response": { "content_type": "application/sdp", "status_code": 201, "headers": [ "Location: /v1/realtime/calls/rtc_…" ] }, "streaming": { "supported": false, "events_ref": "streaming-events/openai-realtime.json (data channel `oai-events`)" }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.realtime.calls.create(sdp=..., session=...)", "node": "client.realtime.calls.create({ sdp, session })" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "Needs a real WebRTC peer/SDP offer; not attempted." }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/voice-webrtc?api=realtime", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/voice-server-controls?api=realtime", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "webrtc", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "realtime", "method": "POST", "path": "/v1/realtime/calls/{call_id}/accept", "name": "Accept call (SIP)", "description": "Accept an inbound SIP call announced by the `realtime.call.incoming` webhook and configure the session (same fields as a client-secret `session`, sent at top level: type, model, instructions, audio, tools…). 200 with empty body once the SIP leg is ringing.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "RealtimeSessionCreateRequestGA" }, "response": { "content_type": null, "status_code": 200, "body": "empty" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.realtime.calls.accept(call_id, type='realtime', model=...)", "node": "client.realtime.calls.accept(callId, {...})" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "Requires a SIP trunk + webhook; not attempted." }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/voice-sip?api=realtime", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "sip", "webhook": "realtime.call.incoming", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "realtime", "method": "POST", "path": "/v1/realtime/calls/{call_id}/reject", "name": "Reject call (SIP)", "description": "Decline an inbound SIP call with an optional SIP `status_code` (default 603 Decline).", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "RealtimeCallRejectRequest" }, "response": { "content_type": null, "status_code": 200, "body": "empty" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.realtime.calls.reject(call_id, status_code=486)", "node": "client.realtime.calls.reject(callId, { status_code: 486 })" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not attempted" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/reject", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/voice-sip?api=realtime", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "sip", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "realtime", "method": "POST", "path": "/v1/realtime/calls/{call_id}/refer", "name": "Refer call (SIP transfer)", "description": "Transfer an active SIP call via SIP REFER; `target_uri` goes into the Refer-To header (`tel:+1…` or `sip:agent@example.com`).", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "RealtimeCallReferRequest" }, "response": { "content_type": null, "status_code": 200, "body": "empty" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.realtime.calls.refer(call_id, target_uri='tel:+1…')", "node": "client.realtime.calls.refer(callId, { target_uri })" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not attempted" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/refer", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "sip", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "realtime", "method": "POST", "path": "/v1/realtime/calls/{call_id}/hangup", "name": "Hang up call", "description": "End an active SIP or WebRTC call. No body. LIVE: bogus call_id → 404 `call_id_not_found` ('No session found for the provided call_id'), which confirms the route exists.", "status": [ "DOCUMENTED", "LIVE_DISCOVERED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": null, "status_code": 200, "body": "empty" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.realtime.calls.hangup(call_id)", "node": "client.realtime.calls.hangup(callId)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "POST with call_id=rtc_bogus error.message='No session found for the provided call_id' code='call_id_not_found' param=''" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/hangup", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "sip|webrtc", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "realtime", "method": "POST", "path": "/v1/realtime/sessions", "name": "Create session (LEGACY beta)", "description": "Beta-era endpoint returning an ephemeral `client_secret` for a realtime session. Still present in the OpenAPI spec but LIVE 2026-09-18 → 404 `Invalid URL (POST /v1/realtime/sessions)` even with `OpenAI-Beta: realtime=v1`. Use /v1/realtime/client_secrets.", "status": [ "DOCUMENTED", "LEGACY", "BETA", "FAILED_VERIFICATION" ], "auth": "Bearer standard API key (server-side)", "beta_header": "OpenAI-Beta: realtime=v1", "request": { "content_type": "application/json", "body_ref": "RealtimeSessionCreateRequest" }, "response": { "content_type": "application/json", "body_ref": "RealtimeSessionCreateResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.beta.realtime.sessions.create(...)", "node": "client.beta.realtime.sessions.create(...)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "body {model: gpt-realtime-mini} + OpenAI-Beta: realtime=v1 error.message='Invalid URL (POST /v1/realtime/sessions)' code=None param=None" }, "sources": [ { "url": "https://developers.openai.com/api/reference/realtime-beta/overview", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "realtime", "method": "POST", "path": "/v1/realtime/transcription_sessions", "name": "Create transcription session (LEGACY beta)", "description": "Beta-era ephemeral token for transcription-only sessions. LIVE 2026-09-18 → 404 `Invalid URL`. Use /v1/realtime/client_secrets with `session.type: transcription`. Note: model pages still label the route `v1/realtime/transcription_sessions` in their endpoint-support tables.", "status": [ "DOCUMENTED", "LEGACY", "BETA", "FAILED_VERIFICATION" ], "auth": "Bearer standard API key (server-side)", "beta_header": "OpenAI-Beta: realtime=v1", "request": { "content_type": "application/json", "body_ref": "RealtimeTranscriptionSessionCreateRequest" }, "response": { "content_type": "application/json", "body_ref": "RealtimeTranscriptionSessionCreateResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.beta.realtime.transcription_sessions.create(...)", "node": "client.beta.realtime.transcriptionSessions.create(...)" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "body {} + OpenAI-Beta: realtime=v1 error.message='Invalid URL (POST /v1/realtime/transcription_sessions)' code=None param=None" }, "sources": [ { "url": "https://developers.openai.com/api/reference/realtime-beta/overview", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "realtime", "method": "WS", "path": "wss://api.openai.com/v1/realtime?model={model}", "name": "Realtime WebSocket (new session)", "description": "Bidirectional JSON events. Server sends `session.created` first. Audio travels as base64 in `input_audio_buffer.append` / `response.output_audio.delta`. Max session 60 min. LIVE probe: gpt-realtime-mini, text-only → 14 server events in 3.6 s, usage 13 in / 3 out text tokens.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer ephemeral client secret `ek_…` (browser/mobile) OR standard API key (server); browser subprotocols: `realtime`, `openai-insecure-api-key.`, `openai-organization.`, `openai-project.`", "beta_header": null, "request": { "content_type": "websocket text frames (JSON client events)", "body_ref": "RealtimeClientEvent" }, "response": { "content_type": "websocket text frames (JSON server events)", "body_ref": "RealtimeServerEvent" }, "streaming": { "supported": true, "events_ref": "streaming-events/openai-realtime.json" }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.realtime.connect(model=...) (async with … as conn)", "node": "new OpenAIRealtimeWS({ model }, client) from 'openai/realtime/ws'" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 101, "request_note": "session.update(output_modalities=[text]) + conversation.item.create + response.create(max_output_tokens=16) → response.done; observed order: session.created, session.updated, conversation.item.added, conversation.item.done, response.created, response.output_item.added, conversation.item.added, response.content_part.added, response.output_text.delta, response.output_text.done, response.content_part.done, conversation.item.done, response.output_item.done, response.done" }, "sources": [ { "url": "https://developers.openai.com/api/docs/guides/voice-websockets?api=realtime", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/reference/resources/realtime/client-events", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/reference/resources/realtime/server-events", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "websocket", "headers": { "Authorization": "Bearer …", "OpenAI-Safety-Identifier": "optional", "OpenAI-Beta": "NOT needed for GA (beta only)" }, "query": { "model": "required unless call_id", "call_id": "attach to existing call" }, "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "realtime", "method": "WS", "path": "wss://api.openai.com/v1/realtime?call_id={call_id}", "name": "Realtime WebSocket sideband (existing WebRTC/SIP call)", "description": "Second connection to an existing call (call_id from the `Location` header of POST /v1/realtime/calls or from the `realtime.call.incoming` webhook). `model` is ignored. Used by the application server to monitor, update instructions and answer tool calls while the client keeps the media.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "websocket JSON", "body_ref": "RealtimeClientEvent" }, "response": { "content_type": "websocket JSON", "body_ref": "RealtimeServerEvent" }, "streaming": { "supported": true, "events_ref": "streaming-events/openai-realtime.json" }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.realtime.connect(call_id=...)", "node": "new OpenAIRealtimeWS({ callId })" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "needs an active call" }, "sources": [ { "url": "https://developers.openai.com/api/docs/guides/voice-server-controls?api=realtime", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/voice-sip?api=realtime", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "websocket-sideband", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "realtime", "method": "WS", "path": "wss://api.openai.com/v1/realtime/translations?model=gpt-realtime-translate", "name": "Realtime translation WebSocket", "description": "Dedicated continuous translation session: no conversation/response lifecycle, no `response.create`. Client: session.update{audio.output.language}, session.input_audio_buffer.append (24 kHz PCM16 base64), session.close. Server: session.created/updated, session.input_transcript.delta, session.output_transcript.delta, session.output_audio.delta, session.closed, error. WebRTC variant: POST /v1/realtime/translations/calls with the SDP offer + ek_ token.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer ephemeral client secret `ek_…` (browser/mobile) OR standard API key (server)", "beta_header": null, "request": { "content_type": "websocket JSON", "body_ref": "RealtimeTranslationClientEvent" }, "response": { "content_type": "websocket JSON", "body_ref": "RealtimeTranslationServerEvent" }, "streaming": { "supported": true, "events_ref": "streaming-events/openai-realtime.json (api=realtime-translation)" }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "not in SDK surface checked", "node": "not in SDK surface checked" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "billed $0.034/min; not opened" }, "sources": [ { "url": "https://developers.openai.com/api/docs/guides/realtime-translation", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/reference/resources/realtime/translation-server-events", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "websocket", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "realtime", "method": "POST", "path": "/v1/realtime/translations/calls", "name": "Create translation call (WebRTC)", "description": "WebRTC SDP exchange for a translation session (documented in the translation guide only; NOT present in openapi-master.yaml).", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer ephemeral client secret from /v1/realtime/translations/client_secrets", "beta_header": null, "request": { "content_type": "application/sdp", "body_ref": null }, "response": { "content_type": "application/sdp" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not attempted" }, "sources": [ { "url": "https://developers.openai.com/api/docs/guides/realtime-translation", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "webrtc", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "realtime", "method": "SIP", "path": "sip:{PROJECT_ID}@sip.api.openai.com;transport=tls", "name": "Realtime SIP endpoint", "description": "Point a SIP trunk (Twilio, Telnyx…) at this URI (EU residency: `sip-eu.api.openai.com`). Signaling TLS on TCP 5061; media SRTP/UDP from 13.79.45.80/28, 23.98.140.64/28, 40.67.149.176/28, 40.83.204.240/28. Inbound INVITE fires the `realtime.call.incoming` webhook (`data.call_id`, `data.sip_headers`); then accept/reject/refer/hangup via REST and attach a WebSocket with `call_id`.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "project webhook + standard API key for call control", "beta_header": null, "request": { "content_type": "SIP INVITE", "body_ref": null }, "response": { "content_type": "SIP", "body_ref": null }, "streaming": { "supported": true, "events_ref": "webhook realtime.call.incoming + streaming-events/openai-realtime.json" }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.webhooks.unwrap(...)", "node": "client.webhooks.unwrap(...)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "no SIP trunk available" }, "sources": [ { "url": "https://developers.openai.com/api/docs/guides/voice-sip?api=realtime", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "sip", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "live", "method": "POST", "path": "/v1/live/sessions", "name": "Create Live session (WebRTC)", "description": "Start a GPT-Live session from an SDP offer: body `{session:{model, instructions, audio.output.voice, delegation, store, input, client}, transport:{type:'webrtc', sdp}}` → 201 `{session:{id}, transport:{type, sdp}}`. Bills 15 s of voice at creation (credited later). LIVE: without transport → 400 `invalid_value` param `transport.type` 'Only the webrtc transport is supported.'; with a bogus SDP → 400 `invalid_offer` 'Offer did not have an audio media section.' — confirms the route and that our key has Live access.", "status": [ "DOCUMENTED", "LIVE_DISCOVERED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "LiveCreateRequest" }, "response": { "content_type": "application/json", "status_code": 201, "body_ref": "LiveCreateResponse" }, "streaming": { "supported": false, "events_ref": "streaming-events/openai-live.json (data channel `oai-events`)" }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.live.create(session=..., transport={'type':'webrtc','sdp':...})", "node": "client.live.create({ session, transport })" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 400, "request_note": "two probes: no transport → 400 transport.type; bogus sdp → 400 invalid_offer error.message='Offer did not have an audio media section.' code='invalid_offer' param=''" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/voice-webrtc?api=live", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "webrtc", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "live", "method": "POST", "path": "/v1/live/sessions/{session_id}/fork", "name": "Fork stored Live session (WebRTC)", "description": "New session continuing a finalized stored (`store: true`) session; overrides limited to store, delegation.responses, client permissions. 201 LiveCreateResponse.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "LiveForkRequest" }, "response": { "content_type": "application/json", "status_code": 201, "body_ref": "LiveCreateResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.live.fork(session_id, ...)", "node": "client.live.fork(sessionId, {...})" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "requires a stored session" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/live-conversations#store-and-fork-a-session", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "webrtc", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "live", "method": "POST", "path": "/v1/live/sessions/{session_id}/accept", "name": "Accept Live SIP call", "description": "Accept an inbound SIP call announced by the `live.transport.incoming` webhook (`data.type: sip`, `data.session_id`). Body `{session:{type:'live', model, instructions, audio.output.voice, delegation, store, input}}`; 200 empty.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "LiveCallAcceptRequest" }, "response": { "content_type": null, "status_code": 200, "body": "empty" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.live.accept(session_id, session={...})", "node": "client.live.accept(sessionId, { session })" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "requires SIP" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/voice-sip?api=live", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "sip", "webhook": "live.transport.incoming (deprecated alias live.call.incoming)", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "live", "method": "POST", "path": "/v1/live/sessions/{session_id}/reject", "name": "Reject Live SIP call", "description": "Reject with a required SIP `status_code` (300–699). First accept/reject wins; later → `decision_already_made`.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "LiveCallRejectRequest" }, "response": { "content_type": null, "status_code": 200, "body": "empty" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.live.reject(session_id, status_code=486)", "node": "client.live.reject(sessionId, { status_code: 486 })" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "requires SIP" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/reject", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "sip", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "live", "method": "POST", "path": "/v1/live/sessions/{session_id}/refer", "name": "Transfer Live SIP call", "description": "SIP REFER to `target_uri`.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "LiveCallReferRequest" }, "response": { "content_type": null, "status_code": 200, "body": "empty" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.live.refer(session_id, target_uri=...)", "node": "client.live.refer(sessionId, { target_uri })" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "requires SIP" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/refer", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "sip", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "live", "method": "POST", "path": "/v1/live/sessions/{session_id}/hangup", "name": "Hang up Live session", "description": "End a Live session (SIP or WebRTC). No body; 200 empty. `session.closed` reason `close_requested`.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": null, "status_code": 200, "body": "empty" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.live.hangup(session_id)", "node": "client.live.hangup(sessionId)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "no live session" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/hangup", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "live", "method": "GET", "path": "/v1/live/sessions/{session_id}/content", "name": "Download Live recording", "description": "Binary stereo WAV of a finalized stored session (left=input, right=output). Stored recordings kept 30 days; unavailable under ZDR.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "audio/wav" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.live.content(session_id)", "node": "client.live.content(sessionId)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "no stored session" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/content", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/live-conversations#download-a-recording", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "live", "method": "WS", "path": "wss://api.openai.com/v1/live/sessions", "name": "Live primary WebSocket", "description": "Server-side audio + events. No query params; first message MUST be `session.start` {session:{model:'gpt-live-1', instructions, audio.format, audio.output.voice, delegation, store, input}}; wait for `session.started`. Audio: `session.input_audio.append` (base64 raw, formats audio/pcm 24k|16k, audio/pcmu 8k, audio/pcma 8k) / `session.output_audio.delta`. Close with `session.close` → `session.closed` (final usage.seconds, reason).", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "websocket JSON", "body_ref": "LiveClientEvent" }, "response": { "content_type": "websocket JSON", "body_ref": "LiveServerEvent" }, "streaming": { "supported": true, "events_ref": "streaming-events/openai-live.json" }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.live.connect() (AsyncOpenAI)", "node": "new LiveWS(client) from 'openai/resources/live/ws'" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not opened: billed per second" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/voice-websockets?api=live", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "websocket", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "live", "method": "WS", "path": "wss://api.openai.com/v1/live/sessions/{session_id}/fork", "name": "Live fork WebSocket", "description": "Fork a stored session on a WebSocket; first message `session.start` with `{session: {}}` (or overrides: store, delegation.responses, audio.format); do not supply a new model.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "websocket JSON", "body_ref": "LiveForkClientEvent" }, "response": { "content_type": "websocket JSON", "body_ref": "LiveForkServerEvent" }, "streaming": { "supported": true, "events_ref": "streaming-events/openai-live.json" }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.live.connect(fork=session_id) (see SDK)", "node": "LiveWS fork (see SDK)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "requires stored session" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "websocket", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "live", "method": "WS", "path": "wss://api.openai.com/v1/live/sessions/{session_id}/attach", "name": "Live sideband WebSocket", "description": "Attach a backend to a running WebRTC/SIP session: receives all session events (incl. reflected `session.input_audio.append` and `session.output_audio.delta` as 24 kHz PCM16 with start_ms/end_ms per the guide) and can send commands (session.update, *.append, response.item.create, response.create, mute/unmute, session.close). Do NOT send session.start or input audio.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "websocket JSON", "body_ref": "LiveSidebandClientEvent" }, "response": { "content_type": "websocket JSON", "body_ref": "LiveSidebandServerEvent" }, "streaming": { "supported": true, "events_ref": "streaming-events/openai-live.json" }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "AsyncSidebandConnection (see SDK)", "node": "see SDK" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "requires running session" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/live/sideband-websocket", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/voice-server-controls?api=live", "retrieved_at": "2026-09-19T01:31:52Z" } ], "transport": "websocket-sideband", "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "audio", "method": "POST", "path": "/v1/audio/speech", "name": "Create speech (TTS)", "description": "Text → audio. Models gpt-4o-mini-tts (instructions supported, ≤2000 input tokens, 13 voices), tts-1/tts-1-hd (9 voices, no instructions/SSE). `response_format` mp3|opus|aac|flac|wav|pcm; `speed` 0.25–4.0; `stream_format` audio (chunked bytes, default) | sse (speech.audio.delta/done). LIVE: 'OK' → 17,664-byte mp3; SSE → 4 deltas + done.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateSpeechRequest" }, "response": { "content_type": "application/octet-stream (audio) | text/event-stream", "observed": "17664 bytes audio/mpeg" }, "streaming": { "supported": true, "events_ref": "streaming-events/openai-audio-transcription.json (api=audio-speech)" }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.audio.speech.create(model, voice, input, ...) / .with_streaming_response", "node": "client.audio.speech.create({...})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "gpt-4o-mini-tts, voice alloy, input 'OK', mp3 → 200; also stream_format=sse+pcm → 200 SSE" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/audio/subresources/speech/methods/create", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/text-to-speech", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "audio", "method": "POST", "path": "/v1/audio/transcriptions", "name": "Create transcription (STT)", "description": "multipart/form-data: file (≤25 MB; flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm), model, language|languages[], prompt, keywords[], response_format json|text|srt|verbose_json|vtt|diarized_json, temperature, timestamp_granularities[] (whisper-1 + verbose_json), include[]=logprobs (gpt-4o-*-transcribe, json), stream, chunking_strategy auto|server_vad{...}, known_speaker_names[]/references[] (diarize). LIVE: 5 successful variants.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "CreateTranscriptionRequest" }, "response": { "content_type": "application/json | text/plain | text/event-stream", "body_ref": "Transcription | TranscriptionVerbose | TranscriptionDiarized", "observed_examples": { "stt_mini_json": { "text": "OK.", "usage": { "type": "tokens", "total_tokens": 15, "input_tokens": 11, "input_token_details": { "text_tokens": 0, "audio_tokens": 11 }, "output_tokens": 4 } }, "stt_whisper_verbose": { "task": "transcribe", "language": "english", "duration": 1.100000023841858, "text": "OK.", "segments": [ { "id": 0, "seek": 0, "start": 0.0, "end": 0.5, "text": " OK.", "tokens": [ 50364, 2264, 13, 50414 ], "temperature": 0.0, "avg_logprob": -0.7027378082275391, "compression_ratio": 0.27272728085517883, "no_speech_prob": 0.01334396656602621 } ], "words": [ { "word": "OK", "start": 0.0, "end": 0.5 } ], "usage": { "type": "duration", "seconds": 2 } }, "stt_diarize": { "text": "Okay.", "task": "transcribe", "duration": 1.104, "segments": [ { "type": "transcript.text.segment", "text": " Okay.", "speaker": "A", "start": 0.0, "end": 0.3500000000000001, "id": "seg_0" } ], "usage": { "type": "tokens", "total_tokens": 87, "input_tokens": 11, "input_token_details": { "text_tokens": 0, "audio_tokens": 11 }, "output_tokens": 76 } }, "stt_logprobs": { "text": "OK.", "logprobs": [ { "token": "OK", "logprob": -0.009489848278462887, "bytes": [ 79, 75 ] }, { "token": ".", "logprob": -0.0003728774609044194, "bytes": [ 46 ] } ], "usage": { "type": "tokens", "total_tokens": 15, "input_tokens": 11, "input_token_details": { "text_tokens": 0, "audio_tokens": 11 }, "output_tokens": 4 } } } }, "streaming": { "supported": true, "events_ref": "streaming-events/openai-audio-transcription.json" }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.audio.transcriptions.create(file=..., model=...)", "node": "client.audio.transcriptions.create({ file, model })" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "gpt-4o-mini-transcribe json; whisper-1 verbose_json word+segment; gpt-4o-transcribe-diarize diarized_json; include[]=logprobs; stream=true — all 200" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/speech-to-text", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "audio", "method": "POST", "path": "/v1/audio/translations", "name": "Create translation (→ English)", "description": "whisper-1 only. multipart: file, model, prompt, response_format json|text|srt|verbose_json|vtt, temperature. Output always English.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "CreateTranslationRequest" }, "response": { "content_type": "application/json", "body_ref": "Translation | TranslationVerbose", "observed_example": { "text": "OK." } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.audio.translations.create(file=..., model='whisper-1')", "node": "client.audio.translations.create({...})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "whisper-1 json on ok.mp3 → {'text': 'OK.'}" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/audio/subresources/translations/methods/create", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/speech-to-text#translations", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "audio", "method": "POST", "path": "/v1/audio/voices", "name": "Create custom voice", "description": "multipart: name, consent (cons_… id), audio_sample (≤10 MiB; audio/mpeg, wav, x-wav, ogg, aac, flac, webm, mp4; ≤30 s, ≥5 s speech). Returns `audio.voice` {id, name, created_at}. Max 20 voices/org; requires custom-voice access (`api.voices.write`). Not called (creates a resource).", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side) (project-scoped key with custom voice access)", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "CreateVoiceRequest" }, "response": { "content_type": "application/json", "body_ref": "VoiceResource" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.audio.voices.create(name=..., consent=..., audio_sample=...)", "node": "client.audio.voices.create({...})" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not attempted (creates a voice; access gated). GET /v1/audio/voices probe → 404 'Endpoint not found.' (no list endpoint in spec either)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voices/methods/create", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/custom-voices", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "audio", "method": "GET", "path": "/v1/audio/voices", "name": "List voices (NOT DOCUMENTED)", "description": "Probe only: the spec has no GET on /audio/voices; LIVE → 404 `Endpoint not found.` Built-in voice names are enumerated in the speech `voice` parameter instead.", "status": [ "UNVERIFIED", "FAILED_VERIFICATION" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "observed": { "error": { "message": "Endpoint not found.", "type": "invalid_request_error", "param": null, "code": null } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "GET error.message='Endpoint not found.' code=None param=None" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voices/methods/create", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "audio", "method": "POST", "path": "/v1/audio/voice_consents", "name": "Create voice consent", "description": "multipart: name, language (BCP 47 e.g. en-US), recording (≤10 MiB) of one of the 17 exact consent phrases (de,en,es,fr,hi,id,it,ja,ko,nl,pl,pt,ru,uk,vi,zh). Returns `audio.voice_consent`. Not called.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "CreateVoiceConsentRequest" }, "response": { "content_type": "application/json", "body_ref": "VoiceConsentResource" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.audio.voice_consents.create(...)", "node": "client.audio.voiceConsents.create(...)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not attempted (creates a resource)" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/create", "retrieved_at": "2026-09-19T01:31:52Z" }, { "url": "https://developers.openai.com/api/docs/guides/custom-voices", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "audio", "method": "GET", "path": "/v1/audio/voice_consents", "name": "List voice consents", "description": "Cursor list (`after`, `limit` 1–100 default 20) → {object:'list', data:[…], first_id, last_id, has_more}. LIVE 2026-09-18 with our key: 404 `Endpoint not found.` — most likely gated behind custom-voice access (docs: 'Custom voices are limited to eligible customers'); a 404 does not mean the route does not exist.", "status": [ "DOCUMENTED", "FAILED_VERIFICATION" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "VoiceConsentListResource", "observed": { "error": { "message": "Endpoint not found.", "type": "invalid_request_error", "param": null, "code": null } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "after", "limit" ], "response": [ "first_id", "last_id", "has_more" ] }, "idempotency": "not documented", "sdk": { "python": "client.audio.voice_consents.list(limit=20)", "node": "client.audio.voiceConsents.list({ limit: 20 })" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 404, "request_note": "GET ?limit=5 error.message='Endpoint not found.' code=None param=None" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/list", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "audio", "method": "GET", "path": "/v1/audio/voice_consents/{consent_id}", "name": "Retrieve voice consent", "description": "Returns VoiceConsentResource.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "VoiceConsentResource" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.audio.voice_consents.retrieve(consent_id)", "node": "client.audio.voiceConsents.retrieve(consentId)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "list returned 404; no id to retrieve" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/retrieve", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "audio", "method": "POST", "path": "/v1/audio/voice_consents/{consent_id}", "name": "Update voice consent (metadata)", "description": "Body {name}. Returns VoiceConsentResource.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "UpdateVoiceConsentRequest" }, "response": { "content_type": "application/json", "body_ref": "VoiceConsentResource" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.audio.voice_consents.update(consent_id, name=...)", "node": "client.audio.voiceConsents.update(consentId, { name })" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "not attempted" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/update", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "audio", "method": "DELETE", "path": "/v1/audio/voice_consents/{consent_id}", "name": "Delete voice consent", "description": "Returns {id, object:'audio.voice_consent', deleted:true}. Destructive — never run by the atlas.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "body_ref": "VoiceConsentDeletedResource" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.audio.voice_consents.delete(consent_id)", "node": "client.audio.voiceConsents.delete(consentId)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": null, "http_status": null, "request_note": "destructive; not attempted" }, "sources": [ { "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/delete", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "chat-audio", "method": "POST", "path": "/v1/chat/completions (audio)", "name": "Chat Completions with audio (pointer)", "description": "Audio in/out for gpt-audio-1.5 / gpt-audio / gpt-audio-mini / gpt-4o-(mini-)audio-preview: `modalities: [\"text\",\"audio\"]`, `audio: {voice, format wav|aac|mp3|flac|opus|pcm16}`, input part `{type:'input_audio', input_audio:{data (base64), format wav|mp3}}`. LIVE: gpt-audio-mini with modalities ['text'] and text input only → 400 invalid_value (param model): 'This model requires that either input content or output modality contain audio.' Full endpoint owned by the chat-completions agent.", "status": [ "DOCUMENTED", "LIVE_DISCOVERED" ], "auth": "Bearer standard API key (server-side)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateChatCompletionRequest (audio, modalities, input_audio part)" }, "response": { "content_type": "application/json", "body_ref": "ChatCompletion (message.audio {id, data, transcript, expires_at})" }, "streaming": { "supported": true, "events_ref": "chat completions SSE (owned by chat agent)" }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "client.chat.completions.create(model='gpt-audio-mini', modalities=['text','audio'], audio={'voice':'alloy','format':'wav'}, ...)", "node": "client.chat.completions.create({...})" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 400, "request_note": "modalities=[text], max_completion_tokens=8 error.message='This model requires that either input content or output modality contain audio.' code='invalid_value' param='model'" }, "sources": [ { "url": "https://developers.openai.com/api/docs/guides/audio-chat-completions", "retrieved_at": "2026-09-19T01:31:52Z" } ], "_fragment": "generated/fragments/endpoints/openai-realtime-live-audio.json" }, { "provider": "openai", "api_family": "webhooks", "method": "GET", "path": "/v1/webhook_endpoints", "name": "List Webhook Endpoints", "operation_id": "ListWebhookEndpoints", "tags": [], "description": "Returns webhook endpoints for the authenticated project in newest-first order.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "project_api_key (or service-account key / WIF access token)" }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "WebhookEndpointListResource", "object": "list", "fields": [ "object", "data", "first_id", "last_id", "has_more" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "request_params": [ "limit", "after" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": null, "node": null }, "examples": { "curl": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "project key, read-only list" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/resources/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-webhooks.json" }, { "provider": "openai", "api_family": "webhooks", "method": "POST", "path": "/v1/webhook_endpoints", "name": "Create Webhook Endpoint", "operation_id": "CreateWebhookEndpoint", "tags": [], "description": "Creates a webhook endpoint for the authenticated project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "project_api_key (or service-account key / WIF access token)" }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "PublicCreateEndpointBody" }, "response": { "status": 200, "schema_ref": "WebhookEndpointWithSecretResource", "object": "webhook_endpoint", "fields": [ "id", "object", "created_at", "updated_at", "name", "url", "event_types", "signing_secret_hint", "signing_secret" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": null, "node": null }, "examples": { "curl": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/resources/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-webhooks.json" }, { "provider": "openai", "api_family": "webhooks", "method": "GET", "path": "/v1/webhook_endpoints/{webhook_endpoint_id}", "name": "Retrieve Webhook Endpoint", "operation_id": "RetrieveWebhookEndpoint", "tags": [], "description": "Retrieves a webhook endpoint for the authenticated project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "project_api_key (or service-account key / WIF access token)" }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "WebhookEndpointBody", "object": "webhook_endpoint", "fields": [ "id", "object", "created_at", "updated_at", "name", "url", "event_types", "signing_secret_hint" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": null, "node": null }, "examples": { "curl": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/resources/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-webhooks.json" }, { "provider": "openai", "api_family": "webhooks", "method": "POST", "path": "/v1/webhook_endpoints/{webhook_endpoint_id}", "name": "Update Webhook Endpoint", "operation_id": "UpdateWebhookEndpoint", "tags": [], "description": "Updates a webhook endpoint for the authenticated project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "project_api_key (or service-account key / WIF access token)" }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "PublicUpdateEndpointBody" }, "response": { "status": 200, "schema_ref": "WebhookEndpointBody", "object": "webhook_endpoint", "fields": [ "id", "object", "created_at", "updated_at", "name", "url", "event_types", "signing_secret_hint" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": null, "node": null }, "examples": { "curl": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/resources/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-webhooks.json" }, { "provider": "openai", "api_family": "webhooks", "method": "DELETE", "path": "/v1/webhook_endpoints/{webhook_endpoint_id}", "name": "Delete Webhook Endpoint", "operation_id": "DeleteWebhookEndpoint", "tags": [], "description": "Deletes a webhook endpoint for the authenticated project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "project_api_key (or service-account key / WIF access token)" }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "DeletedWebhookEndpointResource", "object": "webhook_endpoint.deleted", "fields": [ "id", "object", "deleted" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": null, "node": null }, "examples": { "curl": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/resources/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-webhooks.json" }, { "provider": "openai", "api_family": "webhooks", "method": "POST", "path": "/v1/webhook_endpoints/{webhook_endpoint_id}/rotate_secret", "name": "Rotate Webhook Endpoint Signing Secret", "operation_id": "RotateWebhookEndpointSigningSecret", "tags": [], "description": "Rotates the signing secret for a webhook endpoint in the authenticated project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "project_api_key (or service-account key / WIF access token)" }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "PublicRotateSecretBody" }, "response": { "status": 200, "schema_ref": "WebhookEndpointWithSecretResource", "object": "webhook_endpoint", "fields": [ "id", "object", "created_at", "updated_at", "name", "url", "event_types", "signing_secret_hint", "signing_secret" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": true, "sdk": { "python": null, "node": null }, "examples": { "curl": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/resources/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-webhooks.json" }, { "provider": "openai", "api_family": "webhooks", "method": "POST", "path": "/v1/webhook_endpoints/{webhook_endpoint_id}/test", "name": "Test Webhook Endpoint", "operation_id": "TestWebhookEndpoint", "tags": [], "description": "Sends a sample event to a webhook endpoint for the authenticated project.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "project_api_key (or service-account key / WIF access token)" }, "beta_header": null, "request": { "content_type": "application/json", "body_ref": "PublicTestEndpointBody" }, "response": { "status": 200, "schema_ref": "WebhookEndpointTestResultResource", "object": "webhook_endpoint.test", "fields": [ "object", "webhook_endpoint_id", "event_type", "status_code", "success" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": null, "node": null }, "examples": { "curl": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/resources/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-webhooks.json" }, { "provider": "openai", "api_family": "webhooks", "method": "GET", "path": "/v1/webhook_event_types", "name": "List Webhook Event Types", "operation_id": "ListWebhookEventTypes", "tags": [], "description": "Returns webhook event types visible to the authenticated project.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": { "scheme": "bearer", "header": "Authorization", "key_type": "project_api_key (or service-account key / WIF access token)" }, "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "status": 200, "schema_ref": "WebhookEventTypeListResource", "object": "list", "fields": [ "object", "data" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "GET/DELETE naturally idempotent; POST create is not; no Idempotency-Key header is documented for the OpenAI API.", "destructive": false, "sdk": { "python": null, "node": null }, "examples": { "curl": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "project key, read-only list" }, "sources": [ { "url": "https://developers.openai.com/api/reference/overview", "retrieved_at": "2026-09-19T01:31:00Z", "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)" }, { "url": "https://developers.openai.com/api/docs/guides/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/reference/resources/webhooks", "retrieved_at": "2026-09-19T01:31:00Z" } ], "_fragment": "generated/fragments/endpoints/openai-webhooks.json" }, { "provider": "openai", "api_family": "auth", "beta_header": null, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Each exchange mints a new token; safe to repeat. No refresh token is returned.", "destructive": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "request_note": "Requires a configured Workload Identity Provider + service-account mapping; not available on our account." }, "sources": [ { "url": "https://developers.openai.com/api/reference/workload-identity-federation", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/workload-identity-federation", "retrieved_at": "2026-09-19T01:31:00Z" } ], "method": "POST", "path": "https://auth.openai.com/oauth/token", "name": "Workload identity token exchange (JWT / OIDC id_token / SPIFFE JWT-SVID)", "operation_id": null, "tags": [ "Workload identity federation" ], "description": "RFC 8693 token exchange: trade an externally issued OIDC JWT for a short-lived OpenAI bearer access token (<= 1 h, never outlives the subject token). Response: access_token, issued_token_type, token_type=Bearer, expires_in, expires_at, scope (only when the mapping defines permissions). Tokens authorize like service-account keys; cannot call Admin API endpoints, DELETE /v1/models/{id} or POST /v1/images/request_audit.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "none (subject_token in body)", "key_type": "external OIDC JWT" }, "request": { "content_type": "application/json", "body_ref": "inline" }, "response": { "status": 200, "schema_ref": null, "fields": [ "access_token", "issued_token_type", "token_type", "expires_in", "expires_at", "scope" ], "example": "{\"access_token\":\"eyJ...\",\"issued_token_type\":\"urn:ietf:params:oauth:token-type:access_token\",\"token_type\":\"Bearer\",\"expires_in\":3600,\"expires_at\":1789045200,\"scope\":\"api.model.read api.model.request\"}" }, "sdk": { "python": "OpenAI(workload_identity=...) (client option; see openai._client)", "node": "new OpenAI({ workloadIdentity: ... }) (verify against installed SDK)" }, "examples": { "curl": "curl https://auth.openai.com/oauth/token -H \"Content-Type: application/json\" -d '{\"grant_type\":\"urn:ietf:params:oauth:grant-type:token-exchange\",\"subject_token_type\":\"urn:ietf:params:oauth:token-type:jwt\",\"subject_token\":\"\",\"identity_provider_id\":\"\",\"service_account_id\":\"\"}'" }, "_fragment": "generated/fragments/endpoints/openai-webhooks.json" }, { "provider": "openai", "api_family": "auth", "beta_header": null, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Each exchange mints a new token; safe to repeat. No refresh token is returned.", "destructive": false, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "request_note": "Requires a configured Workload Identity Provider + service-account mapping; not available on our account." }, "sources": [ { "url": "https://developers.openai.com/api/reference/workload-identity-federation", "retrieved_at": "2026-09-19T01:31:00Z" }, { "url": "https://developers.openai.com/api/docs/guides/workload-identity-federation", "retrieved_at": "2026-09-19T01:31:00Z" } ], "method": "POST", "path": "https://mtls.auth.openai.com/oauth/token", "name": "Workload identity token exchange (X.509 client certificate over mTLS)", "operation_id": null, "tags": [ "Workload identity federation", "Mutual TLS" ], "description": "Present the client certificate during TLS; no subject_token in the body (subject_token_type urn:openai:params:oauth:token-type:x509). Only exact POST /oauth/token on mtls.auth.openai.com is accepted (other methods/paths -> 403). Certificate problems -> invalid_subject_token; attribute-condition/mapping/provider failures -> invalid_grant. Minted bearer never outlives the certificate; API calls must then go to mtls.api.openai.com with the certificate.", "status": [ "DOCUMENTED" ], "auth": { "scheme": "mTLS client certificate", "key_type": "X.509 certificate chained to an active Mutual TLS root" }, "request": { "content_type": "application/json", "body_ref": "inline" }, "response": { "status": 200, "schema_ref": null, "fields": [ "access_token", "issued_token_type", "token_type", "expires_in", "expires_at", "scope" ] }, "sdk": { "python": null, "node": null }, "examples": { "curl": "curl --cert \"$OPENAI_MTLS_CERT_CHAIN\" --key \"$OPENAI_MTLS_KEY\" -X POST https://mtls.auth.openai.com/oauth/token -H \"Content-Type: application/json\" -d '{\"grant_type\":\"urn:ietf:params:oauth:grant-type:token-exchange\",\"subject_token_type\":\"urn:openai:params:oauth:token-type:x509\",\"identity_provider_id\":\"\",\"service_account_id\":\"\"}'" }, "_fragment": "generated/fragments/endpoints/openai-webhooks.json" }, { "provider": "xai", "api_family": "chat_completions", "method": "POST", "path": "/v1/chat/completions", "name": "Chat Completions: create", "description": "Stateless OpenAI-compatible chat. xAI calls it the legacy predecessor of /v1/responses (new features land on Responses first). Supports deferred:true (returns request_id), reasoning_effort, response_format json_schema/json_object, function tools (only `function` and retired `live_search` tool types deserialize), n, seed, service_tier priority, prompt_cache_key/x-grok-conv-id caching, image_url parts. Live Search (search_parameters / web_search_options / live_search tool) → 410 RETIRED. File parts → 400 (use /v1/responses).", "status": [ "DOCUMENTED", "LEGACY", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ChatRequest (parameters/xai-chat-completions.json)" }, "response": { "content_type": "application/json", "schema_ref": "ChatResponse | StartDeferredChatResponse (deferred:true)" }, "streaming": { "supported": true, "events_ref": "streaming-events/xai-inference.json (chat.completion.chunk)", "transport": "data-only SSE, `data: [DONE]` terminator, no event: names" }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "openai.OpenAI(base_url='https://api.x.ai/v1').chat.completions.create(...)", "node": "new OpenAI({baseURL:'https://api.x.ai/v1'}).chat.completions.create(...)", "xai_sdk_python": "client.chat.create(model=…) → chat.append(user(…)) → chat.sample() / chat.stream() / chat.defer() (gRPC, not this REST path)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "grok-4.3 'Reply with OK.' max_completion_tokens=32 → 'OK.' with reasoning_content, 133 reasoning tokens, cached_tokens 192; stream, json_schema, tools (forced/parallel/round-trip/stream), image_url, deferred, n=2, seed, service_tier=priority, prompt caching all 200; logit_bias 400; presence_penalty 400 on grok-4.3; search_parameters/web_search_options 410" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/model-capabilities/legacy/chat-completions", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/openapi.json", "retrieved_at": "2026-09-19" } ], "rate_limit_headers_observed": [ "x-ratelimit-limit-requests", "x-ratelimit-remaining-requests", "x-ratelimit-limit-tokens", "x-ratelimit-remaining-tokens", "x-request-id" ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "chat_completions", "method": "GET", "path": "/v1/chat/deferred-completion/{request_id}", "name": "Chat Completions: fetch deferred result", "description": "Poll a deferred chat completion. 202 with empty body while pending, 200 ChatResponse when done. Docs: result available exactly once within 24 h — live it was fetchable twice.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ChatResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "openai SDK: client.get('/chat/deferred-completion/{id}', cast_to=…) (no dedicated method)", "node": null, "xai_sdk_python": "chat.defer(timeout=…, interval=…)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "first poll 202 (0 bytes), second poll 2 s later 200 'OK.'; third GET also 200" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/advanced-api-usage/deferred-chat-completions", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "responses", "method": "POST", "path": "/v1/responses", "name": "Responses: create", "description": "Primary xAI text/agentic endpoint (OpenAI Responses-compatible). Stateful by default (store=true, 30-day retention), previous_response_id chaining, include reasoning.encrypted_content for stateless replay, server-side tools (web_search, x_search, code_interpreter/code_execution, file_search/collections_search, mcp, image_generation, shell; tool_search alpha), input_image / input_file attachments, text.format json_schema, reasoning {effort, summary}, max_turns, top_k/min_p. background/metadata → 400; instructions+previous_response_id → 400.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ModelRequest (parameters/xai-responses.json)" }, "response": { "content_type": "application/json", "schema_ref": "ModelResponse (objects: Response)" }, "streaming": { "supported": true, "events_ref": "streaming-events/xai-inference.json (responses.*)", "transport": "SSE with `event:` name == data.type and sequence_number; ends with response.completed (no [DONE] observed)" }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "client.responses.create / .stream / .parse / .retrieve / .delete / .input_items.list / .compact (openai SDK)", "node": "client.responses.create(...) etc.", "xai_sdk_python": "client.chat.create(model, store_messages=True|False, previous_response_id=…, use_encrypted_content=True, tools=[web_search(), …]) (gRPC)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "grok-4.3 minimal → output [reasoning, message], usage 196/98 (96 reasoning), cached 192; stream 10 events; previous_response_id; store=false; include encrypted reasoning + replay; json_schema; function_call + function_call_output; input_image; input_file(file_id) → 'PINEAPPLE'; web_search/x_search/code_interpreter/mcp/file_search tool calls; compaction item replay" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/responses", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/model-capabilities/text/generate-text", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/tools/overview", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/openapi.json", "retrieved_at": "2026-09-19" } ], "rate_limit_headers_observed": [ "x-ratelimit-limit-requests", "x-ratelimit-remaining-requests", "x-ratelimit-limit-tokens", "x-ratelimit-remaining-tokens", "x-request-id" ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "responses", "method": "GET", "path": "/v1/responses/{response_id}", "name": "Responses: retrieve", "description": "Retrieve a stored response (30 days). LIVE_DISCOVERED: a response created with store=false was still retrievable (200) seconds later.", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "LIVE_DISCOVERED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ModelResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "client.responses.retrieve(id)", "node": "client.responses.retrieve(id)", "xai_sdk_python": "client.chat.get_stored_completion(id)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "GET stored id → 200 (completed_at updated); after DELETE → 404; store=false id → 200" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/responses", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "responses", "method": "DELETE", "path": "/v1/responses/{response_id}", "name": "Responses: delete", "description": "Delete a stored response → {id, object:'response', deleted:true}.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "DeleteStoredCompletionResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "client.responses.delete(id)", "node": "client.responses.delete(id)", "xai_sdk_python": "client.chat.delete_stored_completion(id)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "deleted:true; subsequent GET 404" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/responses", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "responses", "method": "GET", "path": "/v1/responses/{response_id}/input_items", "name": "Responses: list input items", "description": "List the stored input items of a response (limit 1-100 default 20, order asc|desc, after cursor). Not in the REST reference page; present in the OpenAPI spec.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ListInputItemsResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "limit", "order", "after" ], "fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "client.responses.input_items.list(id)", "node": "client.responses.inputItems.list(id)", "xai_sdk_python": null }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "{object:'list', data:[{content:'Reply with OK.', role:'user', type:'message', id:'item_0'}], has_more:false}" }, "sources": [ { "url": "https://docs.x.ai/openapi.json", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "responses", "method": "POST", "path": "/v1/responses/compact", "name": "Responses: compact context", "description": "Compact a full input window into one opaque `compaction` item (encrypted_content) to pass at the head of the next /v1/responses input. Returns object 'response.compaction' with usage.dropped_message_count.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CompactRequest" }, "response": { "content_type": "application/json", "schema_ref": "CompactResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "client.responses.compact(model=…, input=[…])", "node": "client.responses.compact({...})", "xai_sdk_python": "client.chat.compact_context(model, messages) / chat.compact()" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "5-message conversation → cmp_… item, dropped_message_count 3, 138 output tokens (711 reasoning); follow-up response recalled 'A and B'" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/responses", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/advanced-api-usage/context-compaction", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "messages_compat", "method": "POST", "path": "/v1/messages", "name": "Messages (Anthropic-compatible) — DEPRECATED", "description": "Anthropic Messages-shaped endpoint (Bearer auth, no anthropic-version needed). Docs: 'Anthropic SDK compatibility is fully deprecated'. Live: still works with grok-4.3: text/thinking/tool_use blocks, tools with input_schema, tool_choice auto|any|tool, image blocks (url + base64), system string/array, streaming with Anthropic event names incl. thinking_delta. Rejected: top_k (400), stop_sequences on reasoning models (400), document blocks (422), tool_choice.disable_parallel_tool_use (400), Anthropic server tools (422). `thinking` param silently ignored.", "status": [ "DOCUMENTED", "DEPRECATED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "MessageRequest (parameters/xai-messages-compat.json)" }, "response": { "content_type": "application/json", "schema_ref": "MessageResponse" }, "streaming": { "supported": true, "events_ref": "streaming-events/xai-inference.json (messages_compat)", "transport": "SSE with Anthropic event names (message_start … message_stop); no [DONE]" }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "anthropic.Anthropic(base_url='https://api.x.ai', api_key=XAI_API_KEY).messages.create(...) — unofficial; xAI recommends migrating", "node": "new Anthropic({baseURL:'https://api.x.ai'})", "xai_sdk_python": null }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "minimal 'OK.' (usage input 4 + cache_read 192, output 86 incl. reasoning); forced tool_use + tool_result round trip; stream 11 events; /v1/messages/count_tokens → 404" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/legacy", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/openapi.json", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "legacy", "method": "POST", "path": "/v1/complete", "name": "Legacy Text Completions (Anthropic-compatible) — RETIRED in practice", "description": "(Legacy) Anthropic /v1/complete shape. Live: every text model available to this key (incl. grok-4.20-0309-non-reasoning) → 400 'Raw sampling is not supported for reasoning models'.", "status": [ "DOCUMENTED", "LEGACY", "DEPRECATED", "RETIRED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CompleteRequest" }, "response": { "content_type": "application/json", "schema_ref": "CompleteResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": null }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "failure", "http_status": 400, "request_note": "grok-4.3 and grok-4.20-0309-non-reasoning → 400 invalid-argument 'Raw sampling is not supported for reasoning models'" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/legacy", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/openapi.json", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "legacy", "method": "POST", "path": "/v1/completions", "name": "Legacy Completions (OpenAI-compatible) — RETIRED in practice", "description": "(Legacy) OpenAI /v1/completions shape, 'replaced by /v1/chat/completions'. Live: 400 'Raw sampling is not supported for reasoning models' on both live text models — no model on this key can use it.", "status": [ "DOCUMENTED", "LEGACY", "RETIRED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "SampleRequest" }, "response": { "content_type": "application/json", "schema_ref": "SampleResponse" }, "streaming": { "supported": true, "events_ref": null, "transport": "documented data-only SSE" }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "client.completions.create(...) (openai SDK)", "node": "client.completions.create(...)", "xai_sdk_python": null }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "failure", "http_status": 400, "request_note": "same 400 for grok-4.3 and grok-4.20-0309-non-reasoning" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/legacy", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/openapi.json", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "embeddings", "method": "POST", "path": "/v1/embeddings", "name": "Embeddings: create", "description": "OpenAI-compatible embeddings. No embedding model is exposed to this key (GET /v1/embedding-models → {models: []}); POST → 404 not-found.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "EmbeddingRequest" }, "response": { "content_type": "application/json", "schema_ref": "EmbeddingResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "client.embeddings.create(...)", "node": "client.embeddings.create(...)", "xai_sdk_python": null }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "restricted", "http_status": 404, "request_note": "model grok-embedding-small → 404 'does not exist or your team … does not have access'" }, "sources": [ { "url": "https://docs.x.ai/openapi.json", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/rest-api-reference/inference/other", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "models", "method": "GET", "path": "/v1/embedding-models", "name": "List embedding models", "description": "Embedding models available to the key. Live: empty list for our team (grok-embedding-small is referenced by the Collections API docs).", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "ACCOUNT_RESTRICTED" ], "auth": "API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints in our test (key had wildcard ACLs)", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [] }, "response": { "type": "ListEmbeddingModelsResponse {models:[EmbeddingModel]}", "content_type": "application/json", "fields": "id, fingerprint, created, object, owned_by, version, input_modalities, output_modalities, prompt_text_token_price, prompt_image_token_price, aliases", "live_example": { "models": [] } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": "client.models.list_embedding_models()", "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 200, "request_note": "200 with empty models[]" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/models", "retrieved_at": "2026-09-19" }, { "url": "https://api.x.ai/v1/embedding-models", "retrieved_at": "2026-09-19", "note": "live" } ], "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "account", "method": "POST", "path": "/v1/tokenize-text", "name": "Tokenize text", "description": "Tokenizes `text` with the tokenizer of `model` → token_ids[{token_id, string_token, token_bytes[]}]. Free (no usage/cost). Note (FAQ): API prompt_tokens include system/template overhead so they exceed this count (e.g. 'Reply with OK.' = 4 tokens here vs 188–640 prompt_tokens billed).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints in our test (key had wildcard ACLs)", "beta_header": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "{model: string, text: string, user?: string|null}", "path_params": [], "query_params": [] }, "response": { "type": "TokenizeResponse", "content_type": "application/json", "live_example": { "token_ids": [ { "token_id": 19974, "string_token": "Reply", "token_bytes": [ 82, 101, 112, 108, 121 ] }, { "token_id": 550, "string_token": " with" }, { "token_id": 16655, "string_token": " OK" }, { "token_id": 174, "string_token": "." } ] }, "errors": { "422": "plain string 'Failed to deserialize the JSON body into the target type: text: invalid type: integer `123`, expected a string at line 1 column 33'" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (pure function)", "sdk": { "python": "client.tokenizer.tokenize_text(text, model) (gRPC xai_api.Tokenize/TokenizeText)", "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "grok-4.3, 'Reply with OK.' → 4 tokens; x-ratelimit-limit-requests 1800, no token header" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/other", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "account", "method": "GET", "path": "/v1/api-key", "name": "Get API key info", "description": "Metadata of the calling key: redacted_api_key, name, user_id, team_id, acls[], api_key_id, create/modify time, modified_by, api_key_blocked, api_key_disabled, team_blocked. Live: acls ['api-key:model:*','api-key:endpoint:*'], create_time/modify_time returned as EMPTY strings (docs say Unix timestamp / example shows RFC3339).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints in our test (key had wildcard ACLs)", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [] }, "response": { "type": "ApiKey", "content_type": "application/json", "live_example_redacted": { "redacted_api_key": "xai-...QGh6", "name": "key-003", "acls": [ "api-key:model:*", "api-key:endpoint:*" ], "create_time": "", "modify_time": "", "team_blocked": false, "api_key_blocked": false, "api_key_disabled": false } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": "client.auth.get_api_key_info() (gRPC xai_api.Auth/get)", "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "2026-09-19; also documented as the mTLS smoke-test endpoint" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/other", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/advanced-api-usage/mtls", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "files", "method": "POST", "path": "/v1/files", "name": "Files: upload", "description": "Multipart upload (file, optional purpose, expires_after 3600-2592000 s which must precede the file part). Max 50 MB (spec) / 512 MB (guide). Returns File.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "UploadFileMultipartRequest" }, "response": { "content_type": "application/json", "schema_ref": "File" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "client.files.create(file=…, purpose='assistants', expires_after={anchor:'created_at', seconds:N})", "node": "client.files.create({file, purpose, expires_after})", "xai_sdk_python": "client.files.upload(path|bytes|fileobj, filename=…, expires_after=…)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "200-byte text/plain with expires_after=3600 → id file_…, expires_at=created_at+3600, purpose '' (input 'assistants' not echoed); 95-byte PNG too" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/files/upload", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/files/managing-files", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/openapi.json", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "files", "method": "GET", "path": "/v1/files", "name": "Files: list", "description": "List team files: limit (≤100), order, sort_by, pagination_token, filter (AIP-160), after (compat).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ListFilesResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "token", "params": [ "limit", "pagination_token" ], "end_condition": "page shorter than limit / pagination_token null" }, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "client.files.list()", "node": "client.files.list()", "xai_sdk_python": "client.files.list(limit, order, sort_by, pagination_token, filter)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "limit=2 → 1 file, pagination_token null; filter=public_url != null → 1" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/files/manage", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "files", "method": "GET", "path": "/v1/files/{file_id}", "name": "Files: retrieve metadata", "description": "File metadata; 404 {code:'not-found', error:'File not found'} after delete/expiry.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "File" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "client.files.retrieve(id)", "node": "client.files.retrieve(id)", "xai_sdk_python": "client.files.get(id)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "200 then 404 after delete" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/files/manage", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "files", "method": "DELETE", "path": "/v1/files/{file_id}", "name": "Files: delete", "description": "Delete → {id, deleted:true, object:'file'}.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "DeleteFileResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "client.files.delete(id)", "node": "client.files.delete(id)", "xai_sdk_python": "client.files.delete(id)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "deleted:true" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/files/manage", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "files", "method": "GET", "path": "/v1/files/{file_id}/content", "name": "Files: download content", "description": "Raw bytes (application/octet-stream). ?format=text documented; live on a text/plain file → 404 {error:'Failed to retrieve file'}.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/octet-stream", "schema_ref": null }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": "client.files.content(id)", "node": "client.files.content(id)", "xai_sdk_python": "client.files.content(id)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "200 bytes identical to upload; format=text → 404" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/files/download", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "files", "method": "POST", "path": "/v1/files/{file_id}/public-url", "name": "Files: create public URL", "description": "Permanent unauthenticated CDN URL (https://files-cdn.x.ai//.). Only png/jpeg/gif/webp/mp4/webm/pdf (text/plain → 400). Idempotent: repeat call returns the same URL and updates expiry. expires_after may not exceed the file's remaining TTL (400). ≤1000 active URLs/team.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreatePublicUrlRequest ({} allowed)" }, "response": { "content_type": "application/json", "schema_ref": "CreatePublicUrlResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.files.create_public_url(file_id, expires_after=…)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "PNG without TTL + {} → public_url; anonymous GET 200 image/png; second call with expires_after 3600 → same URL + expires_at; txt → 400 unsupported content type; PNG with TTL 3600 + expires_after 3600 → 400 'at most 3599s'" }, "sources": [ { "url": "https://docs.x.ai/developers/files/public-urls", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/openapi.json", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "files", "method": "POST", "path": "/v1/files/{file_id}/public-url/revoke", "name": "Files: revoke public URL", "description": "Revoke → {id, revoked:true, public_url}; no active URL → {id, revoked:false} (idempotent, no error).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "RevokePublicUrlResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.files.revoke_public_url(file_id)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "revoked:true then revoked:false" }, "sources": [ { "url": "https://docs.x.ai/developers/files/public-urls", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/openapi.json", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "files", "method": "POST", "path": "/v1/files:initialize", "name": "Files: chunked upload initialize", "description": "Listed in the REST reference without documentation (chunked upload protocol used by the SDK progress upload). Not in OpenAPI.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": null }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-19", "result": "success", "http_status": null, "request_note": "not called" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/files/upload", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "files", "method": "POST", "path": "/v1/files:uploadChunks", "name": "Files: chunked upload chunks", "description": "Listed in the REST reference without documentation. Not in OpenAPI.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": null }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-19", "result": "success", "http_status": null, "request_note": "not called" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/files/upload", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "files", "method": "PUT", "path": "/v1/files/{file_id}", "name": "Files: update (undocumented)", "description": "Listed in the REST reference as 'API endpoint for PUT requests' without fields. Not in OpenAPI.", "status": [ "DOCUMENTED", "UNVERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": null }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-19", "result": "success", "http_status": null, "request_note": "not called" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/files/manage", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "collections", "method": "POST", "path": "/v1/documents/search", "name": "Collections: search documents", "description": "Semantic/keyword/hybrid chunk search across collections (query, source.collection_ids, limit, filter AIP-160, retrieval_mode {type: hybrid|semantic|keyword, reranker…}, group_by, instructions). Base URL api.x.ai with the inference key.", "status": [ "DOCUMENTED", "LIVE_VERIFIED", "FAILED_VERIFICATION" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "SearchRequest" }, "response": { "content_type": "application/json", "schema_ref": "SearchResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.collections.search(query, collection_ids, …)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "failure", "http_status": 404, "request_note": "fake id → 404 'not found or not accessible'; [] → 400 'Collection IDs cannot be empty'; freshly created collection with a document still DOCUMENT_STATUS_PROCESSING after 75 s → 404 (same message). No processed collection was available to obtain a 200 within the probe window." }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/collections/search", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/files/collections/api", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/openapi.json", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "collections", "method": "POST", "path": "/v1/collections", "name": "Collections: create", "description": "Create a collection (collection_name, index_configuration.model_name, chunk_configuration, metric_space, field_definitions, collection_description). On api.x.ai `field_definitions` is required (may be []) and each definition needs key/required/inject_into_chunk/unique. Documented base URL https://management-api.x.ai + Management API key (401 'Invalid bearer token. Please ensure you use a valid management key.' with the inference key). LIVE_DISCOVERED: the same paths also exist on https://api.x.ai and accept the inference key (gRPC-gateway style: path ids must be repeated in the JSON body).", "status": [ "DOCUMENTED", "LIVE_DISCOVERED", "LIVE_VERIFIED", "ACCOUNT_RESTRICTED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreateCollectionRequest (parameters/xai-files-collections-batches.json)" }, "response": { "content_type": "application/json", "schema_ref": "Collection" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.collections.* (requires management_api_key in Client)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "api.x.ai: {collection_name, field_definitions:[]} → collection_… (default grok-embedding-small, BytesConfiguration 4000/800); management-api.x.ai → 401" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/collections/collection", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/files/collections/api", "retrieved_at": "2026-09-19" } ], "documented_base_url": "https://management-api.x.ai", "live_base_url_observed": "https://api.x.ai (inference key)", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "collections", "method": "GET", "path": "/v1/collections", "name": "Collections: list", "description": "List collections (limit ≤100, order, sort_by, pagination_token, filter, team_id). Documented base URL https://management-api.x.ai + Management API key (401 'Invalid bearer token. Please ensure you use a valid management key.' with the inference key). LIVE_DISCOVERED: the same paths also exist on https://api.x.ai and accept the inference key (gRPC-gateway style: path ids must be repeated in the JSON body).", "status": [ "DOCUMENTED", "LIVE_DISCOVERED", "LIVE_VERIFIED", "ACCOUNT_RESTRICTED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ListCollectionsResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "token", "params": [ "limit", "pagination_token" ] }, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.collections.* (requires management_api_key in Client)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "api.x.ai → {collections:[…], pagination_token:null}; management-api → 401" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/collections/collection", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/files/collections/api", "retrieved_at": "2026-09-19" } ], "documented_base_url": "https://management-api.x.ai", "live_base_url_observed": "https://api.x.ai (inference key)", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "collections", "method": "GET", "path": "/v1/collections/{collection_id}", "name": "Collections: get", "description": "Collection metadata. Documented base URL https://management-api.x.ai + Management API key (401 'Invalid bearer token. Please ensure you use a valid management key.' with the inference key). LIVE_DISCOVERED: the same paths also exist on https://api.x.ai and accept the inference key (gRPC-gateway style: path ids must be repeated in the JSON body).", "status": [ "DOCUMENTED", "LIVE_DISCOVERED", "LIVE_VERIFIED", "ACCOUNT_RESTRICTED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "Collection" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.collections.* (requires management_api_key in Client)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "api.x.ai 200 with many undocumented fields (sharing, effective_privilege, is_owned, …)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/collections/collection", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/files/collections/api", "retrieved_at": "2026-09-19" } ], "documented_base_url": "https://management-api.x.ai", "live_base_url_observed": "https://api.x.ai (inference key)", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "collections", "method": "PUT", "path": "/v1/collections/{collection_id}", "name": "Collections: update", "description": "Update name/description/chunk_configuration/field_definition_updates. Live on api.x.ai: body must include collection_id and field_definition_updates (422 'missing field' otherwise) — not completed. Documented base URL https://management-api.x.ai + Management API key (401 'Invalid bearer token. Please ensure you use a valid management key.' with the inference key). LIVE_DISCOVERED: the same paths also exist on https://api.x.ai and accept the inference key (gRPC-gateway style: path ids must be repeated in the JSON body).", "status": [ "DOCUMENTED", "LIVE_DISCOVERED", "FAILED_VERIFICATION", "ACCOUNT_RESTRICTED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "UpdateCollectionRequest" }, "response": { "content_type": "application/json", "schema_ref": "Collection" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.collections.* (requires management_api_key in Client)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "failure", "http_status": 422, "request_note": "{collection_name} → 422 missing field collection_id; {collection_id, collection_name} → 422 missing field field_definition_updates" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/collections/collection", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/files/collections/api", "retrieved_at": "2026-09-19" } ], "documented_base_url": "https://management-api.x.ai", "live_base_url_observed": "https://api.x.ai (inference key)", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "collections", "method": "DELETE", "path": "/v1/collections/{collection_id}", "name": "Collections: delete", "description": "Delete a collection → 200 {}. Documented base URL https://management-api.x.ai + Management API key (401 'Invalid bearer token. Please ensure you use a valid management key.' with the inference key). LIVE_DISCOVERED: the same paths also exist on https://api.x.ai and accept the inference key (gRPC-gateway style: path ids must be repeated in the JSON body).", "status": [ "DOCUMENTED", "LIVE_DISCOVERED", "LIVE_VERIFIED", "ACCOUNT_RESTRICTED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "{}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.collections.* (requires management_api_key in Client)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "api.x.ai 200 {}" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/collections/collection", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/files/collections/api", "retrieved_at": "2026-09-19" } ], "documented_base_url": "https://management-api.x.ai", "live_base_url_observed": "https://api.x.ai (inference key)", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "collections", "method": "POST", "path": "/v1/collections/{collection_id}/documents/{file_id}", "name": "Collections: add document", "description": "Attach an uploaded Files-API file to a collection (indexing starts asynchronously; poll the document status). Live body on api.x.ai: {collection_id, file_id, fields}. Documented base URL https://management-api.x.ai + Management API key (401 'Invalid bearer token. Please ensure you use a valid management key.' with the inference key). LIVE_DISCOVERED: the same paths also exist on https://api.x.ai and accept the inference key (gRPC-gateway style: path ids must be repeated in the JSON body).", "status": [ "DOCUMENTED", "LIVE_DISCOVERED", "LIVE_VERIFIED", "ACCOUNT_RESTRICTED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "AddDocumentRequest {collection_id, file_id, fields{}}" }, "response": { "content_type": "application/json", "schema_ref": "{}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.collections.* (requires management_api_key in Client)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "200 {} once collection_id+file_id were repeated in the body (422 otherwise); document then listed with status 1 (PROCESSING) for >75 s" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/collections/collection", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/files/collections/api", "retrieved_at": "2026-09-19" } ], "documented_base_url": "https://management-api.x.ai", "live_base_url_observed": "https://api.x.ai (inference key)", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "collections", "method": "POST", "path": "/v1/collections/{collection_id}/documents", "name": "Collections: upload document (multipart, guide only)", "description": "Guide shows a one-step multipart upload (name, data, content_type, fields) on management-api.x.ai. Not in the REST reference; api.x.ai → 405. Documented base URL https://management-api.x.ai + Management API key (401 'Invalid bearer token. Please ensure you use a valid management key.' with the inference key). LIVE_DISCOVERED: the same paths also exist on https://api.x.ai and accept the inference key (gRPC-gateway style: path ids must be repeated in the JSON body).", "status": [ "DOCUMENTED", "FAILED_VERIFICATION" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "name, data, content_type, fields" }, "response": { "content_type": "application/json", "schema_ref": null }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.collections.* (requires management_api_key in Client)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "failure", "http_status": 405, "request_note": "api.x.ai multipart → 405 Method Not Allowed" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/collections/collection", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/files/collections/api", "retrieved_at": "2026-09-19" } ], "documented_base_url": "https://management-api.x.ai", "live_base_url_observed": "https://api.x.ai (inference key)", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "collections", "method": "GET", "path": "/v1/collections/{collection_id}/documents", "name": "Collections: list documents", "description": "List documents with file_metadata, fields, status, error_message, last_indexed_at (+ live: chunk_count, chunks_processed_count). Documented base URL https://management-api.x.ai + Management API key (401 'Invalid bearer token. Please ensure you use a valid management key.' with the inference key). LIVE_DISCOVERED: the same paths also exist on https://api.x.ai and accept the inference key (gRPC-gateway style: path ids must be repeated in the JSON body).", "status": [ "DOCUMENTED", "LIVE_DISCOVERED", "LIVE_VERIFIED", "ACCOUNT_RESTRICTED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ListDocumentsResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "token", "params": [ "limit", "pagination_token", "filter", "sort_by", "order" ] }, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.collections.* (requires management_api_key in Client)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "1 document, status integer 1 while processing" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/collections/collection", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/files/collections/api", "retrieved_at": "2026-09-19" } ], "documented_base_url": "https://management-api.x.ai", "live_base_url_observed": "https://api.x.ai (inference key)", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "collections", "method": "GET", "path": "/v1/collections/{collection_id}/documents/{file_id}", "name": "Collections: get document", "description": "Document metadata + processing status. Documented base URL https://management-api.x.ai + Management API key (401 'Invalid bearer token. Please ensure you use a valid management key.' with the inference key). LIVE_DISCOVERED: the same paths also exist on https://api.x.ai and accept the inference key (gRPC-gateway style: path ids must be repeated in the JSON body).", "status": [ "DOCUMENTED", "LIVE_DISCOVERED", "LIVE_VERIFIED", "ACCOUNT_RESTRICTED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "Document" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.collections.* (requires management_api_key in Client)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "status 1 (proto enum number, docs say string enum); 404 'Cannot find document metadata' before the document is added" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/collections/collection", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/files/collections/api", "retrieved_at": "2026-09-19" } ], "documented_base_url": "https://management-api.x.ai", "live_base_url_observed": "https://api.x.ai (inference key)", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "collections", "method": "PATCH", "path": "/v1/collections/{collection_id}/documents/{file_id}", "name": "Collections: reindex document", "description": "Regenerate indices for a document. Documented base URL https://management-api.x.ai + Management API key (401 'Invalid bearer token. Please ensure you use a valid management key.' with the inference key). LIVE_DISCOVERED: the same paths also exist on https://api.x.ai and accept the inference key (gRPC-gateway style: path ids must be repeated in the JSON body).", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED", "UNVERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": null }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.collections.* (requires management_api_key in Client)" }, "verification": { "method": "docs_only", "verified_at": "2026-09-19", "result": "success", "http_status": null, "request_note": "not called" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/collections/collection", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/files/collections/api", "retrieved_at": "2026-09-19" } ], "documented_base_url": "https://management-api.x.ai", "live_base_url_observed": "https://api.x.ai (inference key)", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "collections", "method": "DELETE", "path": "/v1/collections/{collection_id}/documents/{file_id}", "name": "Collections: remove document", "description": "Remove a document from a collection → 200 {}. LIVE_DISCOVERED hazard: the underlying Files-API file was deleted as well (GET /v1/files/{id} → 404 afterwards), even when the document had never been successfully added. Documented base URL https://management-api.x.ai + Management API key (401 'Invalid bearer token. Please ensure you use a valid management key.' with the inference key). LIVE_DISCOVERED: the same paths also exist on https://api.x.ai and accept the inference key (gRPC-gateway style: path ids must be repeated in the JSON body).", "status": [ "DOCUMENTED", "LIVE_DISCOVERED", "LIVE_VERIFIED", "ACCOUNT_RESTRICTED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": null }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.collections.* (requires management_api_key in Client)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "200 {} ; file gone afterwards" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/collections/collection", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/files/collections/api", "retrieved_at": "2026-09-19" } ], "documented_base_url": "https://management-api.x.ai", "live_base_url_observed": "https://api.x.ai (inference key)", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "collections", "method": "GET", "path": "/v1/collections/{collection_id}/documents:batchGet", "name": "Collections: batch get documents", "description": "Get several documents' metadata (file_ids[] query). Live: could not find the accepted query encoding (file_ids=… → 'expected a sequence'; file_ids[]=… → 'missing field file_ids'). Documented base URL https://management-api.x.ai + Management API key (401 'Invalid bearer token. Please ensure you use a valid management key.' with the inference key). LIVE_DISCOVERED: the same paths also exist on https://api.x.ai and accept the inference key (gRPC-gateway style: path ids must be repeated in the JSON body).", "status": [ "DOCUMENTED", "FAILED_VERIFICATION", "ACCOUNT_RESTRICTED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": null }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.collections.* (requires management_api_key in Client)" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "failure", "http_status": 400, "request_note": "two encodings → 400 deserialization errors" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/collections/collection", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/files/collections/api", "retrieved_at": "2026-09-19" } ], "documented_base_url": "https://management-api.x.ai", "live_base_url_observed": "https://api.x.ai (inference key)", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "batches", "method": "POST", "path": "/v1/batches", "name": "Batches: create", "description": "Create a batch container {name} (or {name, input_file_id} for a sealed JSONL batch). expire_time = +30 days live. Discounted pricing (20% off on grok-4.3 / grok-4.20*), no rate-limit consumption; 2 creations/s/team.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "{name, input_file_id?}" }, "response": { "content_type": "application/json", "schema_ref": "Batch" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.batch.create/add/get/list/list_batch_requests/list_batch_results/cancel" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "{name:'atlas-probe'} → batch_… , state all zeros, expire_time create+30d" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/batches", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/advanced-api-usage/batch-api", "retrieved_at": "2026-09-19" } ], "note": "Not present in the OpenAPI spec (openapi.json has no /v1/batches paths); shape from the REST reference + live.", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "batches", "method": "GET", "path": "/v1/batches", "name": "Batches: list", "description": "List team batches (limit, pagination_token).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ListBatchesResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "token", "params": [ "limit", "pagination_token" ] }, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.batch.create/add/get/list/list_batch_requests/list_batch_results/cancel" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "limit=2 → 1 batch, pagination_token null" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/batches", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/advanced-api-usage/batch-api", "retrieved_at": "2026-09-19" } ], "note": "Not present in the OpenAPI spec (openapi.json has no /v1/batches paths); shape from the REST reference + live.", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "batches", "method": "GET", "path": "/v1/batches/{batch_id}", "name": "Batches: get", "description": "Batch with aggregate state counters; poll until num_pending == 0.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "Batch" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.batch.create/add/get/list/list_batch_requests/list_batch_results/cancel" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "2 requests: pending 2 at t=0, success 2 at t=11 s" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/batches", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/advanced-api-usage/batch-api", "retrieved_at": "2026-09-19" } ], "note": "Not present in the OpenAPI spec (openapi.json has no /v1/batches paths); shape from the REST reference + live.", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "batches", "method": "POST", "path": "/v1/batches/{batch_id}/requests", "name": "Batches: add requests", "description": "Add requests {batch_requests:[{batch_request_id, batch_request:{chat_get_completion|responses|image_generation|image_edit|video_generation|video_extension}}]}. Live: 200 with an EMPTY body; a `responses` request was accepted but its result came back as chat_get_completion.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "AddBatchRequests" }, "response": { "content_type": null, "schema_ref": "empty" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.batch.create/add/get/list/list_batch_requests/list_batch_results/cancel" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "2 requests (chat_get_completion + responses) → 200 null body" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/batches", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/advanced-api-usage/batch-api", "retrieved_at": "2026-09-19" } ], "note": "Not present in the OpenAPI spec (openapi.json has no /v1/batches paths); shape from the REST reference + live.", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "batches", "method": "GET", "path": "/v1/batches/{batch_id}/requests", "name": "Batches: list request metadata", "description": "Per-request state (pending|succeeded|failed|cancelled), endpoint, model, timestamps (limit ≤1000, pagination_token).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ListBatchRequestsResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "token", "params": [ "limit", "pagination_token" ] }, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.batch.create/add/get/list/list_batch_requests/list_batch_results/cancel" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "both requests 'succeeded', endpoint 'xai_api.Chat/GetCompletion'" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/batches", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/advanced-api-usage/batch-api", "retrieved_at": "2026-09-19" } ], "note": "Not present in the OpenAPI spec (openapi.json has no /v1/batches paths); shape from the REST reference + live.", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "batches", "method": "GET", "path": "/v1/batches/{batch_id}/results", "name": "Batches: list results", "description": "Results {batch_request_id, batch_result:{response:{chat_get_completion:ChatCompletion}|error}} (limit ≤1000). Available as soon as individual requests finish; per-result cost in usage.cost_in_usd_ticks.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "ListBatchResultsResponse" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "token", "params": [ "limit", "pagination_token" ] }, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.batch.create/add/get/list/list_batch_requests/list_batch_results/cancel" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "2 results, both chat_get_completion with reasoning_content, cost_in_usd_ticks 3887200 / 2187200 (≈$0.0004/$0.0002)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/batches", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/advanced-api-usage/batch-api", "retrieved_at": "2026-09-19" } ], "note": "Not present in the OpenAPI spec (openapi.json has no /v1/batches paths); shape from the REST reference + live.", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "batches", "method": "POST", "path": "/v1/batches/{batch_id}:cancel", "name": "Batches: cancel", "description": "Cancel pending requests; completed results stay. Live: works on an already-completed batch (sets cancel_time).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": "Batch" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.batch.create/add/get/list/list_batch_requests/list_batch_results/cancel" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "success", "http_status": 200, "request_note": "cancel_time set, state unchanged (2 success)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/batches", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/advanced-api-usage/batch-api", "retrieved_at": "2026-09-19" } ], "note": "Not present in the OpenAPI spec (openapi.json has no /v1/batches paths); shape from the REST reference + live.", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "batches", "method": "DELETE", "path": "/v1/batches/{batch_id}", "name": "Batches: delete (not offered)", "description": "Not documented; probed → 405.", "status": [ "LIVE_DISCOVERED" ], "auth": "Authorization: Bearer (inference API key; no version header)", "beta_header": null, "request": { "content_type": null, "body_ref": null }, "response": { "content_type": "application/json", "schema_ref": null }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "Not idempotent (POST) / idempotent (GET, DELETE)", "sdk": { "python": null, "node": null, "xai_sdk_python": "client.batch.create/add/get/list/list_batch_requests/list_batch_results/cancel" }, "verification": { "method": "live_api", "verified_at": "2026-09-19", "result": "failure", "http_status": 405, "request_note": "405 Method Not Allowed, empty body" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/batches", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/advanced-api-usage/batch-api", "retrieved_at": "2026-09-19" } ], "note": "Not present in the OpenAPI spec (openapi.json has no /v1/batches paths); shape from the REST reference + live.", "_fragment": "generated/fragments/endpoints/xai-inference.json" }, { "provider": "xai", "api_family": "images", "method": "POST", "path": "/v1/images/generations", "name": "Generate image(s)", "description": "Text → 1–10 images (Grok Imagine). JSON body, OpenAI-compatible (`client.images.generate` works). Response `data[]` items carry `url` (ephemeral https://imgen.x.ai/xai-imgen/xai-.jpeg) or `b64_json`, plus `mime_type` (live: image/jpeg). Optional `storage_options` persists the file to the Files API (`file_output`). Synchronous (live: ~5–10 s).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "GenerateImageRequest", "params_ref": "generated/fragments/parameters/xai-images.json" }, "response": { "content_type": "application/json", "body_ref": "GeneratedImageResponse", "observed_example": { "data": [ { "b64_json": "<146796 base64 chars → 110096-byte JPEG>", "mime_type": "image/jpeg" } ], "usage": { "cost_in_usd_ticks": 200000000 } }, "notes": "usage.cost_in_usd_ticks (1 USD = 10,000,000,000 ticks) is always present; the documented token detail fields (input_tokens, output_tokens, *_details) were absent on every live response." }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "openai: client.images.generate(model=..., prompt=..., response_format='b64_json', extra_body={'aspect_ratio': '1:1'}) · xai_sdk: client.image.sample(...) / sample_batch(n=...)", "node": "openai: client.images.generate({model, prompt, aspect_ratio}) (base_url https://api.x.ai/v1) · @ai-sdk/xai: generateImage({model: xai.image(id)})" }, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "grok-imagine-image, prompt 'a plain white square', n=1, aspect_ratio 1:1, resolution 1k, response_format b64_json → 200, JPEG 110 KB, cost 200000000 ticks = $0.02. Also: quality='low' on grok-imagine-image is silently ACCEPTED (200, billed $0.02) although docs say quality is 2.0-only; aspect_ratio '7:7' → 422 text/plain serde error; n=0 → 400 {code:'invalid-argument'}; response_format 'png' → 400 'Invalid format.'; model grok-2-image → 404 {code:'not-found'}. Raw: tmp-live/xai-media/images-generations-*.json" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/images", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/images/generation", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/pricing", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "images", "method": "POST", "path": "/v1/images/edits", "name": "Edit image(s)", "description": "Prompt + 1 source image (`image`) or up to 5 (`images[]`, referenced as … in the prompt) → edited image(s). JSON body only (public URL, base64 data URL or Files API `file_id`) — the OpenAI SDK `images.edit()` (multipart) is NOT supported. Output aspect ratio follows the (first) input image unless `aspect_ratio` is set for multi-image edits. Billed input image + output image.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "EditImageRequest", "params_ref": "generated/fragments/parameters/xai-images.json" }, "response": { "content_type": "application/json", "body_ref": "GeneratedImageResponse", "observed_example": { "data": [ { "b64_json": "<123193-byte JPEG>", "mime_type": "image/jpeg" } ], "usage": { "cost_in_usd_ticks": 220000000 } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "xai_sdk: client.image.sample(prompt=..., model=..., image_url='data:image/jpeg;base64,...') · openai SDK: NOT supported (multipart) — use requests/httpx", "node": "fetch POST https://api.x.ai/v1/images/edits · @ai-sdk/xai: generateImage({prompt: {text, images: [...]}})" }, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "grok-imagine-image, image={url: data:image/jpeg;base64,...} (the generated white square), prompt 'draw a small red circle in the center', b64_json → 200, cost 220000000 ticks = $0.022 ($0.02 output + $0.002 input image). Quirk: POST /v1/images/edits WITHOUT `image`/`images` (prompt only) returned 200 and generated a fresh image billed $0.02 — behaves like /generations instead of rejecting. Raw: tmp-live/xai-media/images-edits-*.json" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/images", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/images/editing", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/images/multi-image-editing", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "models", "method": "GET", "path": "/v1/image-generation-models", "name": "List image generation models", "description": "Image models with modalities, fingerprint, max_prompt_length, image_price and the optional per-(quality,resolution) pricing matrix. Live: 3 models.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints in our test (key had wildcard ACLs)", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [] }, "response": { "type": "ListImageGenerationModelsResponse {models:[ImageGenerationModel]}", "content_type": "application/json", "fields": "id, fingerprint, max_prompt_length, created, object, owned_by, version, input_modalities, output_modalities, image_price (ticks), pricing[{quality,resolution,price_per_image}], aliases" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": "client.models.list_image_generation_models()", "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "3 models" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/models", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "models", "method": "GET", "path": "/v1/image-generation-models/{model_id}", "name": "Get image generation model", "description": "One image model.", "status": [ "DOCUMENTED" ], "auth": "API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints in our test (key had wildcard ACLs)", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "model_id" ], "query_params": [] }, "response": { "type": "ImageGenerationModel", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": "client.models.get_image_generation_model(id)", "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "list endpoint verified instead" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/models", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "videos", "method": "POST", "path": "/v1/videos/generations", "name": "Start video generation (async)", "description": "Text-to-video, image-to-video (`image` = first frame), reference-to-video (`reference_images`/`reference_audios`, grok-imagine-video-1.5) and first/last-frame (`last_frame`, 1.5 only). Returns immediately with `{request_id}`; poll GET /v1/videos/{request_id}. 1–15 s, 480p/720p/1080p, audio track by default (`generate_audio: false` for silent). Billed per output second ($0.05/s grok-imagine-video, $0.08/s grok-imagine-video-1.5). Also usable in the Batch API (standard rates).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "GenerateVideoRequest", "params_ref": "generated/fragments/parameters/xai-videos.json" }, "response": { "content_type": "application/json", "body_ref": "{request_id: string}", "observed_example": { "request_id": "60407e87-a722-92de-8eeb-9a71491aa8e1" }, "observed_headers": [ "x-request-id (= request_id)", "x-ratelimit-limit-requests: 480", "x-zero-data-retention: false", "x-data-retention: general" ] }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "xai_sdk: client.video.generate(...) (polls) / client.video.start(...) + client.video.get(id)", "node": "@ai-sdk/xai: experimental_generateVideo({model: xai.video(id), prompt, duration, aspectRatio, providerOptions: {xai: {resolution, pollTimeoutMs, pollIntervalMs}}})" }, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "grok-imagine-video, prompt 'a plain white square, static camera', duration 1, resolution 480p, aspect_ratio 1:1 → 200 {request_id}; job done after 11.4 s; cost 500000000 ticks = $0.05 (1 s × $0.05). duration 99 → 400 'Duration must be between 1 and 15 seconds'; resolution '4k' → 422 text/plain serde error. Raw tmp-live/xai-media/video-job.json" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/videos", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/video/generation", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/video/reference-to-video", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/pricing", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "videos", "method": "POST", "path": "/v1/videos/edits", "name": "Start video edit (async)", "description": "Prompt + source `video` (public .mp4 URL, base64 data URL or Files API file_id) → edited video with the same duration (input capped at 8.7 s), aspect ratio and resolution (capped at 720p). No `duration`/`aspect_ratio`/`resolution` params. Returns `{request_id}`; poll GET /v1/videos/{request_id}.", "status": [ "DOCUMENTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "EditVideoRequest" }, "response": { "content_type": "application/json", "body_ref": "{request_id: string}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "xai_sdk: client.video.generate(prompt=..., video_url=...)", "node": "@ai-sdk/xai providerOptions.xai.{mode: 'edit-video', videoUrl}" }, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "failure", "http_status": 422, "request_note": "Only the validation path was exercised: body without `video` → 422 text/plain 'Failed to deserialize the JSON body into the target type: missing field `video`'. No paid edit run." }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/videos", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/video/editing", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "videos", "method": "POST", "path": "/v1/videos/extensions", "name": "Start video extension (async)", "description": "Prompt + source `video` → the original clip continued from its last frame; `duration` (2–10 s, default 6) is the length of the ADDED segment; output = original + extension. Returns `{request_id}`.", "status": [ "DOCUMENTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "ExtendVideoRequest" }, "response": { "content_type": "application/json", "body_ref": "{request_id: string}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "xai_sdk: client.video.extend(...) / client.video.extend_start(...)", "node": "@ai-sdk/xai providerOptions.xai.{mode: 'extend-video', videoUrl}" }, "relations": null, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "documentation only (paid, needs media input, or enterprise-gated)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/videos", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/video/extension", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "videos", "method": "GET", "path": "/v1/videos/{request_id}", "name": "Get deferred video result", "description": "Poll a video job. Live: HTTP **202** with `{status:'pending', progress:0–99}` while running, HTTP 200 with `{status:'done', video:{url, duration, respect_moderation}, model, usage, progress:100}` when ready; `status:'failed'` carries `error:{code,message}`; `expired` after the retention window. `video.url` (https://vidgen.x.ai/xai-vidgen-bucket/xai-video-.mp4) is temporary — download promptly.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": null, "response": { "content_type": "application/json", "body_ref": "VideoResponse (flattened; the OpenAPI GetDeferredVideoResponse wrapper {status, response} is NOT what the REST endpoint returns)", "observed_examples": [ { "http": 202, "body": { "status": "pending", "progress": 1 } }, { "http": 200, "body": { "status": "done", "video": { "url": "https://vidgen.x.ai/xai-vidgen-bucket/xai-video-.mp4", "duration": 1, "respect_moderation": true }, "model": "grok-imagine-video", "usage": { "cost_in_usd_ticks": 500000000 }, "progress": 100 } } ], "states_ref": "generated/fragments/status-lifecycles/xai-lifecycles.json#video_generation_job" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "3 polls at 0.6 s (202 pending/1%), 6.0 s (202 pending/87%), 11.4 s (200 done); MP4 53608 bytes downloaded (video/mp4, ftypisom). Unknown UUID → 404 {code:'not-found', error:'Failed to read static file.'}; non-UUID id → 400 {code:'invalid-argument', error:'Malformed request ID'}." }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/videos", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/video/generation", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "models", "method": "GET", "path": "/v1/video-generation-models", "name": "List video generation models", "description": "Video models (no prices in the object). Live: grok-imagine-video (input text,image,video) and grok-imagine-video-1.5 (input text,image,audio).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints in our test (key had wildcard ACLs)", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [] }, "response": { "type": "ListVideoGenerationModelsResponse {models:[VideoGenerationModel]}", "content_type": "application/json", "fields": "id, fingerprint, created, object, owned_by, version, input_modalities, output_modalities, aliases" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "2 models" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/models", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "models", "method": "GET", "path": "/v1/video-generation-models/{model_id}", "name": "Get video generation model", "description": "One video model.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints in our test (key had wildcard ACLs)", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "model_id" ], "query_params": [] }, "response": { "type": "VideoGenerationModel", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "grok-imagine-video-1.5 → 200" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/models", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "voice", "method": "POST", "path": "/v1/realtime/client_secrets", "name": "Create ephemeral client secret (voice)", "description": "Mint a short-lived token (`xai-realtime-…`, default TTL 600 s, max 3600 s) for browser/mobile clients of the Speech-to-Speech WebSocket. Optional `session` (model, reasoning.effort) is bound to the secret. Use as `Authorization: Bearer ` or as WebSocket subprotocol `xai-client-secret.`.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "{expires_after:{seconds}, session:{model, reasoning:{effort}}}" }, "response": { "content_type": "application/json", "body_ref": "{value: string, expires_at: int}", "observed_example": { "value": "xai-real…(111 chars)", "expires_at": 1789789324 } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "expires_after.seconds=60 → value (111 chars, prefix 'xai-real'), expires_at = now+60; with session {model: grok-voice-latest, reasoning: {effort: none}} → 200 same shape. Secret then used as Sec-WebSocket-Protocol 'xai-client-secret.' → 101, session.created + conversation.created received." }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/ephemeral-tokens", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "WS", "path": "wss://api.x.ai/v1/realtime", "name": "Speech to Speech realtime session (WebSocket)", "description": "Bidirectional JSON (or binary-frame audio) session with grok-voice-latest (= grok-voice-think-fast-2.0). Query: `model`, `reasoning.effort` (high|none), `call_id` (SIP), `conversation_id` (resumption). Client events: session.update, input_audio_buffer.append/commit/clear, conversation.item.create/delete/truncate, response.create/cancel. OpenAI Realtime-compatible naming with xAI extensions (force_message, resumption, replace). Billing: $0.08/min audio (billable_audio_seconds, rounded up) + $0.004 per text `conversation.item.create`.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer API key (server) or ephemeral client secret (header or Sec-WebSocket-Protocol xai-client-secret.)", "beta_header": null, "request": { "content_type": "websocket json + optional binary frames", "body_ref": "client events → generated/fragments/streaming-events/xai-voice.json (api=realtime, client→server)" }, "response": { "content_type": "websocket json + optional binary frames", "body_ref": "server events → generated/fragments/streaming-events/xai-voice.json (api=realtime, server→client)", "observed_sequence_text_only": [ "session.created", "conversation.created", "ping", "session.updated", "conversation.item.added", "response.created", "response.output_item.added", "conversation.item.added", "response.content_part.added", "response.output_audio.delta", "response.output_audio_transcript.delta", "response.output_audio.delta", "response.output_audio.delta", "response.output_audio_transcript.done", "response.content_part.done", "response.output_audio.done", "response.output_item.done", "response.done" ] }, "streaming": { "supported": true, "events_ref": "generated/fragments/streaming-events/xai-voice.json" }, "pagination": null, "idempotency": "not documented", "sdk": { "python": "websockets (raw) · openai AsyncOpenAI(base_url='https://api.x.ai/v1').realtime.connect(model='grok-voice-latest')", "node": "ws (raw) · openai OpenAIRealtimeWS({model:'grok-voice-latest'}, client with baseURL https://api.x.ai/v1)" }, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 101, "request_note": "wss://api.x.ai/v1/realtime?model=grok-voice-latest, API key header. session.update {turn_detection:null, reasoning:{effort:'none'}, voice:'eve', pcm 16 kHz} → conversation.item.create input_text 'Reply with OK.' → response.create → 18 events in 1.23 s, transcript 'OK', 22.7 KB PCM, response.done.usage {input_tokens:4, output_tokens:37 (audio 36, text 1), output_audio_seconds:0.71, billable_audio_seconds:1}. Undocumented server event `ping` observed. Default session.created shows voice 'xai_ara', model grok-voice-think-fast-2.0, modalities ['audio'], turn_detection {type:null}. Raw tmp-live/xai-media/voice-ws-session.json" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/voice-realtime.ws.json", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/pricing", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "POST", "path": "/v2/phone-numbers", "name": "Create SIP phone number (voice)", "description": "Register a Direct SIP number (`origin: byo_trunk`, customer-owned E.164 number) routed to an `agent_id` or a `webhook` that receives signed `realtime.call.incoming` events (Standard Webhooks v1 HMAC-SHA256; `dispatch_signing_secret` returned once). Provisioning xAI numbers (`xai_provisioned`) via API is not supported per the SIP guide. Note the /v2 prefix.", "status": [ "DOCUMENTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CreatePhoneNumberV2 {origin, name, agent_id|webhook, phone_number, area_code, sip_auth}" }, "response": { "content_type": "application/json", "body_ref": "{phone_number:{phone_number_id, team_id, phone_number, name, agent_id, webhook_id, origin, sip_host:'sip.voice.x.ai', inbound_trunk_id, sip_auth, created_at, updated_at}, webhook:{webhook_id, dispatch_signing_secret}}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "documentation only (paid, needs media input, or enterprise-gated)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech/sip", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "POST", "path": "/v1/realtime/calls/{call_id}/refer", "name": "Transfer SIP call (REFER)", "description": "Transfer an active SIP call to `target_uri` (tel:+E.164 or sip:user@host). Blocks until the transfer resolves; HTTP status reports the outcome. Returns `{}`.", "status": [ "DOCUMENTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "{target_uri: string}" }, "response": { "content_type": "application/json", "body_ref": "{}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "documentation only (paid, needs media input, or enterprise-gated)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech/sip", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "POST", "path": "/v1/realtime/calls/{call_id}/hangup", "name": "Hang up SIP call", "description": "End an active SIP call. Returns `{}`.", "status": [ "DOCUMENTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": null, "response": { "content_type": "application/json", "body_ref": "{}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "documentation only (paid, needs media input, or enterprise-gated)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech/sip", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "POST", "path": "/v1/tts", "name": "Text to speech (unary)", "description": "Text (≤ 60,000 chars, inline speech tags like [laugh], ) → audio bytes (mp3 default 24 kHz/128 kbps; wav, pcm, mulaw, alaw). `language` is REQUIRED (BCP-47 or 'auto'). With `with_timestamps: true` the response becomes a JSON envelope {audio (base64), content_type, duration, audio_timestamps}. $15 / 1M characters.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "TTS request {text, voice_id, language, output_format:{codec, sample_rate, bit_rate}, speed, optimize_streaming_latency, text_normalization, with_timestamps, replace}" }, "response": { "content_type": "audio/* (or application/json with with_timestamps)", "body_ref": "audio bytes | {audio, content_type, duration, audio_timestamps:{graph_chars[], graph_times[]}}", "observed_examples": [ { "http": 200, "content_type": "audio/wav", "bytes": 25324, "request": "text 'OK.', wav 16 kHz" }, { "http": 200, "content_type": "application/json", "body": { "audio": "<16384 base64 chars>", "content_type": "audio/mpeg", "duration": 0.71, "audio_timestamps": { "graph_chars": [ "O", "K", "." ], "graph_times": [ [ 0.04, 0.06 ], [ 0.2, 0.22 ], [ 0.22, 0.71 ] ] } } } ], "notes": "Live: graph_times is an array of [start, end] pairs (as in the TTS guide), not the {start, end} objects shown in the REST reference page." }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "'OK.' voice eve language en → wav 25 KB; with_timestamps → JSON envelope; missing `language` → 422 text/plain 'missing field `language`'. ~$0.00005 each." }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/text-to-speech", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/pricing", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "WS", "path": "wss://api.x.ai/v1/tts", "name": "Text to speech streaming (WebSocket)", "description": "Bidirectional streaming TTS: configure by query (voice, language [required], codec, sample_rate, bit_rate, optimize_streaming_latency, speed 0.7–1.5, text_normalization, with_timestamps); send `text.delta`… `text.done`, receive `audio.delta`… `audio.done`; multi-utterance on one connection; no text length limit.", "status": [ "DOCUMENTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "websocket json", "body_ref": "text.delta / text.done" }, "response": { "content_type": "websocket json", "body_ref": "audio.delta / audio.done / error" }, "streaming": { "supported": true, "events_ref": "generated/fragments/streaming-events/xai-voice.json (api=tts)" }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "documentation only (paid, needs media input, or enterprise-gated)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/text-to-speech", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/tts-streaming.ws.json", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "GET", "path": "/v1/tts/voices", "name": "List built-in voices", "description": "Roster shared by TTS, Speech-to-Speech (`voice`) and video `reference_audios.voice_id`. Live: 28 voices, each {voice_id, name, language:'multilingual', gender} — the `gender` field and the 'multilingual' language value are not in the REST reference (which shows language 'en'); 'aurora' and 'liora' are absent from the documented example list.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": null, "response": { "content_type": "application/json", "body_ref": "{voices: [{voice_id, name, language, gender}]}", "observed_example": { "voices": [ { "voice_id": "altair", "name": "Altair", "language": "multilingual", "gender": "male" }, { "voice_id": "eve", "name": "Eve", "language": "multilingual", "gender": "female" }, "… 28 total" ] } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "28 voices; raw tmp-live/xai-media/tts-voices.json" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/text-to-speech", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "GET", "path": "/v1/tts/voices/{voice_id}", "name": "Get built-in voice", "description": "Single voice record.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": null, "response": { "content_type": "application/json", "body_ref": "{voice_id, name, language, gender}", "observed_example": { "voice_id": "eve", "name": "Eve", "language": "multilingual", "gender": "female" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "eve" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "POST", "path": "/v1/stt", "name": "Speech to text (batch)", "description": "multipart/form-data: `file` (≤ 500 MB; wav, mp3, ogg, opus, flac, aac, mp4, m4a, mkv auto-detected; raw pcm/mulaw/alaw need `audio_format` + `sample_rate`) or `url`; options language, format, multichannel, channels, diarize, keyterm[], filler_words, vad_threshold. Returns {text, language, duration, words[], channels[]}. $0.10 / hour.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "STT multipart fields (file must be the last field)" }, "response": { "content_type": "application/json", "body_ref": "{text, language, duration, words:[{text,start,end,confidence?,speaker?}], channels?}", "observed_example": { "text": "Okay.", "language": "en", "duration": 0.79, "words": [ { "text": "Okay.", "start": 0.122, "end": 0.466 } ] } }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "0.79 s WAV (the TTS 'OK.' clip), language=en → text 'Okay.'; `confidence` omitted (docs: omitted when 0). ~$0.00002." }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-text", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/rest-api-reference/inference/speech-to-text", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/pricing", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "WS", "path": "wss://api.x.ai/v1/stt", "name": "Speech to text streaming (WebSocket)", "description": "Raw audio binary frames in (pcm|mulaw|alaw|opus; query sample_rate, encoding, interim_results, endpointing, language, model grok-voice-transcribe-1.0|2.0, multichannel, channels, diarize, keyterm, filler_words, smart_turn, smart_turn_timeout, vad_threshold) → transcript.created, transcript.partial (is_final / speech_final), transcript.done. Client JSON: finalize, audio.done. $0.20 / hour.", "status": [ "DOCUMENTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "websocket binary frames + json", "body_ref": "binary audio | finalize | audio.done" }, "response": { "content_type": "websocket json", "body_ref": "transcript.created | transcript.partial | transcript.done | error" }, "streaming": { "supported": true, "events_ref": "generated/fragments/streaming-events/xai-voice.json (api=stt)" }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "documentation only (paid, needs media input, or enterprise-gated)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-text", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/stt-streaming.ws.json", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "POST", "path": "/v1/custom-voices", "name": "Create custom voice (clone)", "description": "multipart: reference `file` (≤ 120 s; wav/mp3/flac/ogg/opus/m4a/aac/mkv/mp4) + labels (name, description, gender, accent, age, language, use_case, tone) → {voice_id (8 lowercase alnum), …}. API creation is gated to Enterprise teams (403 otherwise); console cloning is free for up to 30 voices/team; US-only (except Illinois).", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "custom voice fields" }, "response": { "content_type": "application/json", "body_ref": "CustomVoice" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "Not called: documented as Enterprise-only for API creation (403 'Custom voices not enabled for this team'); no reference clip and no consent basis for cloning." }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/custom-voices", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "GET", "path": "/v1/custom-voices", "name": "List custom voices", "description": "Team-scoped custom voices; `limit` 1–1000 (default 100), `pagination_token`. Live shape adds `total_count` and `cap` (30) to the documented {voices, pagination_token}.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": null, "response": { "content_type": "application/json", "body_ref": "{voices: [CustomVoice], pagination_token?, total_count, cap}", "observed_example": { "voices": [], "total_count": 0, "cap": 30 } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "token", "params": [ "limit", "pagination_token" ], "response_field": "pagination_token" }, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "empty list; note undocumented total_count/cap fields and absent pagination_token key" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/custom-voices", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "GET", "path": "/v1/custom-voices/{voice_id}", "name": "Get custom voice", "description": "Single CustomVoice.", "status": [ "DOCUMENTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": null, "response": { "content_type": "application/json", "body_ref": "CustomVoice" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "documentation only (paid, needs media input, or enterprise-gated)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/custom-voices", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "PATCH", "path": "/v1/custom-voices/{voice_id}", "name": "Update custom voice metadata", "description": "Partial update of labels (name, description, gender, accent, age, language, use_case, tone); empty strings rejected (400).", "status": [ "DOCUMENTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "application/json", "body_ref": "CustomVoice labels (all optional)" }, "response": { "content_type": "application/json", "body_ref": "CustomVoice" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "documentation only (paid, needs media input, or enterprise-gated)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/custom-voices", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "DELETE", "path": "/v1/custom-voices/{voice_id}", "name": "Delete custom voice", "description": "Returns {deleted: true}.", "status": [ "DOCUMENTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": null, "response": { "content_type": "application/json", "body_ref": "{deleted: true}" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "documentation only (paid, needs media input, or enterprise-gated)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/custom-voices", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "voice", "method": "GET", "path": "/v1/custom-voices/{voice_id}/audio", "name": "Download custom voice reference audio", "description": "Raw reference clip bytes.", "status": [ "DOCUMENTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": null, "response": { "content_type": "audio/*", "body_ref": "bytes" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "documentation only (paid, needs media input, or enterprise-gated)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/voice", "retrieved_at": "2026-09-18" }, { "url": "https://docs.x.ai/developers/model-capabilities/audio/custom-voices", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "skills", "method": "GET", "path": "/v1/skills", "name": "List hosted skills", "description": "OpenAPI-only endpoint (no public docs page): paginated SkillList {object:'list', data:[Skill], first_id, last_id, has_more}; query limit 1–100 (default 100), after, order asc|desc (default desc). Live with our key: 404 {error:{code:404, message:'The requested resource was not found…'}} — the resource is not reachable for this team (gated or not yet deployed).", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": null, "response": { "content_type": "application/json", "body_ref": "SkillList", "observed_example": { "error": { "code": 404, "message": "The requested resource was not found. Please check the URL and try again. Documentation is available at https://docs.x.ai/" } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "cursor", "params": [ "limit", "after", "order" ], "response_fields": [ "first_id", "last_id", "has_more" ] }, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 404, "request_note": "GET /v1/skills?limit=5 → 404 generic JSON error (Content-Type application/json). Same for GET /v1/skills/{id}. Raw tmp-live/xai-media/skills-*.json" }, "sources": [ { "url": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "skills", "method": "POST", "path": "/v1/skills", "name": "Upload hosted skill", "description": "multipart/form-data field `files` (a zip of the skill directory, or the field repeated once per file of a directory upload). The skill's `name`/`description` come from SKILL.md YAML frontmatter. Returns Skill {id, object:'skill', name, description, created_at, default_version:'1', latest_version:'1'}; 400 invalid upload, 413 too large. Live: 404 text/plain with our key.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": { "content_type": "multipart/form-data", "body_ref": "UploadSkillMultipartRequest {files[]}" }, "response": { "content_type": "application/json", "body_ref": "Skill" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 404, "request_note": "zip(atlas-probe-skill/SKILL.md) as `files` → 404 text/plain (122 bytes); single SKILL.md file → 404; JSON body → 404 JSON error." }, "sources": [ { "url": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "skills", "method": "GET", "path": "/v1/skills/{skill_id}", "name": "Retrieve hosted skill", "description": "Skill record; 404 'Skill not found.'", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": null, "response": { "content_type": "application/json", "body_ref": "Skill" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 404, "request_note": "unknown id → 404 generic JSON error" }, "sources": [ { "url": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "skills", "method": "DELETE", "path": "/v1/skills/{skill_id}", "name": "Delete hosted skill", "description": "Returns DeletedSkill {id, object:'skill.deleted', deleted:true}.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": null, "response": { "content_type": "application/json", "body_ref": "DeletedSkill" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not attempted (no skill could be created)" }, "sources": [ { "url": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "skills", "method": "GET", "path": "/v1/skills/{skill_id}/content", "name": "Download hosted skill content", "description": "Raw skill zip bytes streamed in chunks (application/zip).", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "Bearer xAI API key", "beta_header": null, "request": null, "response": { "content_type": "application/zip", "body_ref": "zip bytes" }, "streaming": { "supported": false, "events_ref": null }, "pagination": null, "idempotency": "not documented", "sdk": null, "relations": null, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "not_tested", "http_status": null, "request_note": "not attempted (no skill could be created)" }, "sources": [ { "url": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)", "retrieved_at": "2026-09-18" } ], "_fragment": "generated/fragments/endpoints/xai-media-voice-skills.json" }, { "provider": "xai", "api_family": "models", "method": "GET", "path": "/v1/models", "name": "List models", "description": "All models (language, image, video) available to the API key with ids, aliases, created, context_length and pricing. Live 2026-09-19: 12 ids. Regional hosts return their own subset (us.api.x.ai → grok-4.6 at 1.1x; eu-west-1.api.x.ai → grok-4.3).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints in our test (key had wildcard ACLs)", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [] }, "response": { "type": "ListModelsResponse {data:[Model], object:'list'}", "content_type": "application/json", "fields": "id, aliases[], context_length, created, object='model', owned_by, prompt_text_token_price, cached_prompt_text_token_price, prompt_image_token_price, completion_text_token_price, *_long_context, long_context_threshold, image_price, pricing[{quality,resolution,price_per_image}] — prices in ticks (1e-10 USD)" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": "client.models (xai-sdk: list_language_models/list_image_generation_models…); openai: client.models.list()", "node": "openai: client.models.list()" }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "GET /v1/models 2026-09-19 → 12 models; no x-ratelimit headers; also on us.api.x.ai and eu-west-1.api.x.ai" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/models", "retrieved_at": "2026-09-19" }, { "url": "https://api.x.ai/v1/models", "retrieved_at": "2026-09-19", "note": "live" } ], "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "models", "method": "GET", "path": "/v1/models/{model_id}", "name": "Get model", "description": "Model object (same shape as list items) for an id OR alias OR retired-redirect slug: grok-3, grok-4-fast → grok-4.3 object; grok-code-fast-1 → grok-build-0.1 object; grok-4.3-latest → grok-4.3.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints in our test (key had wildcard ACLs)", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "model_id" ], "query_params": [] }, "response": { "type": "Model", "content_type": "application/json", "errors": { "404": "{code:'not-found', error:'The model X does not exist or your team does not have access to it…'}" } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "grok-3 (200→grok-4.3), grok-4-fast (200→grok-4.3), grok-code-fast-1 (200→grok-build-0.1), grok-4.3-latest (200), grok-2-image (404), grok-voice-think-fast-2.0 (404)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/models", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "models", "method": "GET", "path": "/v1/language-models", "name": "List language models", "description": "Chat / image-understanding models with full info (fingerprint, version, modalities, search_price). Live: 7 models.", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints in our test (key had wildcard ACLs)", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [] }, "response": { "type": "ListLanguageModelsResponse {models:[LanguageModel]}", "content_type": "application/json", "fields": "id, fingerprint, created, object, owned_by, version, input_modalities[], output_modalities[], all token prices (ticks), search_price (0), long-context prices + threshold, aliases[]" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": "client.models.list_language_models()", "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "7 models; x-request-id present" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/models", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "models", "method": "GET", "path": "/v1/language-models/{model_id}", "name": "Get language model", "description": "Full info for one language model (aliases and redirected slugs accepted: grok-4-0709 → grok-4.3).", "status": [ "DOCUMENTED", "LIVE_VERIFIED" ], "auth": "API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints in our test (key had wildcard ACLs)", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "model_id" ], "query_params": [] }, "response": { "type": "LanguageModel", "content_type": "application/json", "example": { "id": "grok-4.3", "fingerprint": "fp_0e35aa9326", "created": 1776384000, "version": "1.0", "input_modalities": [ "text", "image" ], "output_modalities": [ "text" ], "prompt_text_token_price": 12500, "cached_prompt_text_token_price": 2000, "prompt_image_token_price": 12500, "completion_text_token_price": 25000, "search_price": 0, "prompt_text_token_price_long_context": 25000, "cached_prompt_text_token_price_long_context": 4000, "completion_text_token_price_long_context": 50000, "long_context_threshold": 200000, "aliases": [ "grok-4.3-latest" ] } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": "client.models.get_language_model(id)", "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "grok-4.3 and grok-4-0709 (redirect)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/models", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "models", "method": "GET", "path": "/v1/embedding-models/{model_id}", "name": "Get embedding model", "description": "One embedding model.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "API key (Authorization: Bearer xai-…); ACL api-key:endpoint:* not required for catalogue/account endpoints in our test (key had wildcard ACLs)", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "model_id" ], "query_params": [] }, "response": { "type": "EmbeddingModel", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 404, "request_note": "grok-embedding-small → 404 not-found ('does not exist or your team … does not have access')" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/inference/models", "retrieved_at": "2026-09-19" } ], "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "account", "method": "GET", "path": "/v1/me", "name": "Get current caller", "description": "Identity of the credentials (API key OR OAuth token): user_id, team_id, team_blocked, zdr_status ('no_zdr' | 'zdr'; legacy 'pii_scrubbing' read-only), api_key{redacted_api_key, api_key_id, blocked, disabled} | oauth{client_id}. In the OpenAPI spec; NOT on the docs REST reference pages.", "status": [ "DOCUMENTED", "LIVE_DISCOVERED", "LIVE_VERIFIED" ], "auth": "API key or OAuth bearer", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [] }, "response": { "type": "GetMeResponse", "content_type": "application/json", "live_example_redacted": { "user_id": "", "team_id": "", "zdr_status": "no_zdr", "team_blocked": false, "api_key": { "redacted_api_key": "xai-...QGh6", "api_key_id": "", "blocked": false, "disabled": false } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "success", "http_status": 200, "request_note": "2026-09-19 (twice); OAuth branch not exercised" }, "sources": [ { "url": "https://docs.x.ai/openapi.json", "retrieved_at": "2026-09-19", "note": "openapi operationId handle_get_me_request" } ], "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "GET", "path": "/auth/management-keys/validation", "name": "Validate management key", "description": "Returns metadata of the management key (apiKeyId, teamId [DEPRECATED → scope/scopeId], scope SCOPE_TEAM|SCOPE_ORGANIZATION, scopeId, ownerUserId, createTime, modifyTime, name, aclStrings…). Needs no ACL.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [], "query_params": [] }, "response": { "type": "ManagementKey", "content_type": "application/json", "errors": { "401": { "code": 16, "message": "Invalid bearer token. Please ensure you use a valid management key.", "details": [] } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "probed with inference key 2026-09-19 → 401 {code:16}" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/auth", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "POST", "path": "/auth/teams/{teamId}/api-keys", "name": "Create API key", "description": "Creates an inference API key for the team: name (required), acls[] ('api-key:endpoint:*' / 'api-key:endpoint:chat' / 'api-key:endpoint:image' / 'api-key:model:*' / 'api-key:model:grok-4.6'), qps, qpm, tpm (string), expireTime. Response includes the plaintext apiKey ONLY at creation plus apiKeyId, redactedApiKey, aclStrings, disabled, timestamps.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "{name, acls[], qps?, qpm?, tpm?, expireTime?}", "path_params": [ "teamId" ], "query_params": [] }, "response": { "type": "ApiKey (camelCase)", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "not idempotent (creates a secret)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/auth", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "GET", "path": "/auth/teams/{teamId}/api-keys", "name": "List API keys", "description": "Admin → all team keys; member → own keys. Query: pageSize, paginationToken, aclFilters[], activeOnly. Response apiKeys[], paginationToken.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "teamId" ], "query_params": [ "pageSize", "paginationToken", "aclFilters", "activeOnly" ] }, "response": { "type": "{apiKeys:[ApiKey], paginationToken}", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_token", "params": [ "pageSize", "paginationToken" ], "response_fields": [ "apiKeys", "paginationToken" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "live_api", "verified_at": "2026-09-18", "result": "restricted", "http_status": 401, "request_note": "probed with inference key 2026-09-19 → 401 {code:16}" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/auth", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "PUT", "path": "/auth/api-keys/{api_key_id}", "name": "Update API key", "description": "Selective update with {apiKey:{…}, fieldMask:'qpm' | 'name' | …} (qps, qpm, tpm, name, disabled, acls, expireTime).", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "{apiKey:{…}, fieldMask: string}", "path_params": [ "api_key_id" ], "query_params": [] }, "response": { "type": "ApiKey", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (full field overwrite)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/auth", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "POST", "path": "/auth/api-keys/{apiKeyId}/rotate", "name": "Rotate API key secret", "description": "!!CAUTION!! New secret returned; old secret accepted until oldSecretExpireTime (default 24 h, max 7 days). Body: expireTime?, oldSecretExpireTime?.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "{expireTime?, oldSecretExpireTime?}", "path_params": [ "apiKeyId" ], "query_params": [] }, "response": { "type": "ApiKey (with new apiKey secret)", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "not idempotent", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/auth", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "caution": "destructive — never run by this atlas", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "DELETE", "path": "/auth/api-keys/{apiKeyId}", "name": "Delete API key", "description": "!!CAUTION!! Permanently and irrevocably deletes the key. Response {}.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "apiKeyId" ], "query_params": [] }, "response": { "type": "{}", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (delete)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/auth", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "caution": "destructive — never run by this atlas", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "GET", "path": "/auth/api-keys/{apiKeyId}/propagation", "name": "Check key propagation", "description": "icPropagation: map inference-cluster host → bool (example: cloud9.api.x.ai, us-east-1.api.x.ai). New keys may take a moment to reach all clusters.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "apiKeyId" ], "query_params": [] }, "response": { "type": "{icPropagation:{host:bool}}", "content_type": "application/json", "example": { "icPropagation": { "cloud9.api.x.ai": true, "us-east-1.api.x.ai": true } } }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/auth", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "GET", "path": "/auth/teams/{teamId}/models", "name": "List team models", "description": "clusterConfigs[] → per inference cluster: languageModels[], imageGenerationModels[], embeddingModels[]… with names usable in api-key:model: ACLs and pricing/alias details (large schema).", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "teamId" ], "query_params": [] }, "response": { "type": "{clusterConfigs:[{cluster, languageModels[], …}]}", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/auth", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "GET", "path": "/auth/teams/{teamId}/endpoints", "name": "List endpoint ACLs", "description": "acls[{acl, description, namespace}] that can be granted to keys (api-key:endpoint:*).", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "teamId" ], "query_params": [] }, "response": { "type": "{acls:[{acl,description,namespace}]}", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/auth", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "GET", "path": "/audit/teams/{teamId}/events", "name": "List audit events", "description": "Team audit log: pageSize, pageToken, eventFilter.userId, eventFilter.query (full-text), eventFilter.eventId, eventTimeFrom/To (ISO 8601), orderBy TIME_ASCENDING|TIME_DESCENDING → events[{eventTime,eventId,description,user{…}}], nextPageToken. Same data as console → Audit Log (admins). Content of API requests is never in audit logs.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "teamId" ], "query_params": [ "pageSize", "pageToken", "eventFilter.userId", "eventFilter.query", "eventFilter.eventId", "eventTimeFrom", "eventTimeTo", "orderBy" ] }, "response": { "type": "{events:[AuditEvent], nextPageToken}", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_token", "params": [ "pageSize", "pageToken" ], "response_fields": [ "events", "nextPageToken" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/audit", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "GET", "path": "/v1/billing/teams/{team_id}/billing-info", "name": "Get billing info", "description": "Team billing address / tax info.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "team_id" ], "query_params": [] }, "response": { "type": "BillingInfo", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/billing", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "POST", "path": "/v1/billing/teams/{team_id}/billing-info", "name": "Set billing info", "description": "Sets billing address / tax info (appears on invoices; invoices cannot be regenerated).", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "BillingInfo", "path_params": [ "team_id" ], "query_params": [] }, "response": { "type": "BillingInfo", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "not idempotent", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/billing", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "caution": "modifies billing — not run", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "GET", "path": "/v1/billing/teams/{team_id}/invoices", "name": "List invoices", "description": "Invoices (prepaid purchases + monthly) with pagination query params.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "team_id" ], "query_params": [ "pageSize", "pageToken" ] }, "response": { "type": "{invoices:[Invoice], nextPageToken}", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "opaque_token", "params": [ "pageSize", "pageToken" ], "response_fields": [ "invoices", "nextPageToken" ] }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/billing", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "GET", "path": "/v1/billing/teams/{team_id}/payment-method", "name": "List payment methods", "description": "Payment methods on file (add/delete only in console).", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "team_id" ], "query_params": [] }, "response": { "type": "{paymentMethods:[…]}", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/billing", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "POST", "path": "/v1/billing/teams/{team_id}/payment-method/default", "name": "Set default payment method", "description": "Pick an existing payment method as default.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "{paymentMethodId}", "path_params": [ "team_id" ], "query_params": [] }, "response": { "type": "{}", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "not idempotent", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/billing", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "caution": "modifies billing — not run", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "GET", "path": "/v1/billing/teams/{team_id}/postpaid/invoice/preview", "name": "Preview postpaid invoice", "description": "Amount due for postpaid usage in the current period.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "team_id" ], "query_params": [] }, "response": { "type": "InvoicePreview", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/billing", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "GET", "path": "/v1/billing/teams/{team_id}/postpaid/spending-limits", "name": "Get postpaid spending limits", "description": "Monthly invoiced-billing limit ($0 default → prepaid only; API stops when consumed).", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "team_id" ], "query_params": [] }, "response": { "type": "SpendingLimits", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/billing", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "POST", "path": "/v1/billing/teams/{team_id}/postpaid/spending-limits", "name": "Set postpaid spending limit", "description": "Sets the monthly postpaid cap.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "{limit…}", "path_params": [ "team_id" ], "query_params": [] }, "response": { "type": "SpendingLimits", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "not idempotent", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/billing", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "caution": "modifies billing — not run", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "GET", "path": "/v1/billing/teams/{team_id}/prepaid/balance", "name": "Get prepaid balance", "description": "Prepaid credit balance and balance changes.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": null, "body_ref": null, "path_params": [ "team_id" ], "query_params": [] }, "response": { "type": "PrepaidBalance", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (safe)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/billing", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "POST", "path": "/v1/billing/teams/{team_id}/prepaid/top-up", "name": "Top up prepaid credit", "description": "Charges the default payment method to add credits (console also offers auto top-up).", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "{amount…}", "path_params": [ "team_id" ], "query_params": [] }, "response": { "type": "TopUpResult", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "not idempotent", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/billing", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "caution": "spends money — not run", "_fragment": "generated/fragments/endpoints/xai-models-management.json" }, { "provider": "xai", "api_family": "management", "method": "POST", "path": "/v1/billing/teams/{team_id}/usage", "name": "Get usage", "description": "Historical usage over a time range aggregated by fields (model, API key, cluster, token type…) — API twin of the console Usage Explorer.", "status": [ "DOCUMENTED", "ACCOUNT_RESTRICTED" ], "auth": "MANAGEMENT key (console → Settings → Management Keys; scope SCOPE_TEAM or SCOPE_ORGANIZATION). Inference key → 401 {code:16,'Invalid bearer token. Please ensure you use a valid management key.'}", "beta_header": null, "headers": [], "request": { "content_type": "application/json", "body_ref": "{startTime, endTime, aggregateBy[], filters…}", "path_params": [ "team_id" ], "query_params": [] }, "response": { "type": "UsageReport", "content_type": "application/json" }, "streaming": { "supported": false, "events_ref": null }, "pagination": { "style": "none" }, "idempotency": "idempotent (read via POST)", "sdk": { "python": null, "node": null }, "verification": { "method": "docs_only", "verified_at": "2026-09-18", "result": "restricted", "http_status": null, "request_note": "no Management key available to this atlas; not called (destructive endpoints never called by policy)" }, "sources": [ { "url": "https://docs.x.ai/developers/rest-api-reference/management/billing", "retrieved_at": "2026-09-19" }, { "url": "https://docs.x.ai/developers/management-api-guide", "retrieved_at": "2026-09-19" } ], "base_url": "https://management-api.x.ai", "_fragment": "generated/fragments/endpoints/xai-models-management.json" } ]