Python 88.3%
TypeScript 7.6%
Shell 4.1%
1[2 {3 "provider": "anthropic",4 "api_family": "messages-batches",5 "name": "MessageBatch",6 "official_type_name": "BetaMessageBatch",7 "description": "Response object of POST /v1/messages/batches",8 "fields": [9 {10 "name": "type",11 "type": "\"message_batch\"",12 "required": true,13 "description": "Object type. For Message Batches, this is always `\"message_batch\"`.",14 "default": "message_batch"15 },16 {17 "name": "id",18 "type": "string",19 "required": true,20 "description": "Unique object identifier. The format and length of IDs may change over time."21 },22 {23 "name": "archived_at",24 "type": "string or null",25 "required": true,26 "description": "RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.",27 "constraints": {28 "format": "date-time"29 }30 },31 {32 "name": "cancel_initiated_at",33 "type": "string or null",34 "required": true,35 "description": "RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.",36 "constraints": {37 "format": "date-time"38 }39 },40 {41 "name": "created_at",42 "type": "string",43 "required": true,44 "description": "RFC 3339 datetime string representing the time at which the Message Batch was created.",45 "constraints": {46 "format": "date-time"47 }48 },49 {50 "name": "ended_at",51 "type": "string or null",52 "required": true,53 "description": "RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired.",54 "constraints": {55 "format": "date-time"56 }57 },58 {59 "name": "expires_at",60 "type": "string",61 "required": true,62 "description": "RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.",63 "constraints": {64 "format": "date-time"65 }66 },67 {68 "name": "processing_status",69 "type": "\"in_progress\" or \"canceling\" or \"ended\"",70 "required": true,71 "description": "Processing status of the Message Batch.",72 "enum": [73 "in_progress",74 "canceling",75 "ended"76 ]77 },78 {79 "name": "request_counts",80 "type": "BetaMessageBatchRequestCounts",81 "required": true,82 "description": "Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch."83 },84 {85 "name": "request_counts.canceled",86 "type": "number",87 "required": true,88 "description": "Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended.",89 "default": "0"90 },91 {92 "name": "request_counts.errored",93 "type": "number",94 "required": true,95 "description": "Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended.",96 "default": "0"97 },98 {99 "name": "request_counts.expired",100 "type": "number",101 "required": true,102 "description": "Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended.",103 "default": "0"104 },105 {106 "name": "request_counts.processing",107 "type": "number",108 "required": true,109 "description": "Number of requests in the Message Batch that are processing.",110 "default": "0"111 },112 {113 "name": "request_counts.succeeded",114 "type": "number",115 "required": true,116 "description": "Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended.",117 "default": "0"118 },119 {120 "name": "results_url",121 "type": "string or null",122 "required": true,123 "description": "URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests."124 }125 ],126 "example": {127 "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",128 "archived_at": "2024-08-20T18:37:24.100435Z",129 "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",130 "created_at": "2024-08-20T18:37:24.100435Z",131 "ended_at": "2024-08-20T18:37:24.100435Z",132 "expires_at": "2024-08-20T18:37:24.100435Z",133 "processing_status": "in_progress",134 "request_counts": {135 "canceled": 10,136 "errored": 30,137 "expired": 10,138 "processing": 100,139 "succeeded": 50140 },141 "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",142 "type": "message_batch"143 },144 "status": [145 "DOCUMENTED",146 "LIVE_VERIFIED"147 ],148 "sources": [149 {150 "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",151 "retrieved_at": "2026-09-18"152 },153 {154 "url": "https://platform.claude.com/docs/en/api/messages/batches/create",155 "retrieved_at": "2026-09-18"156 }157 ]158 },159 {160 "provider": "anthropic",161 "api_family": "messages-batches",162 "name": "DeletedMessageBatch",163 "official_type_name": "BetaDeletedMessageBatch",164 "description": "Response object of DELETE /v1/messages/batches/{message_batch_id}",165 "fields": [166 {167 "name": "type",168 "type": "\"message_batch_deleted\"",169 "required": true,170 "description": "Deleted object type. For Message Batches, this is always `\"message_batch_deleted\"`.",171 "default": "message_batch_deleted"172 },173 {174 "name": "id",175 "type": "string",176 "required": true,177 "description": "ID of the Message Batch."178 }179 ],180 "example": {181 "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",182 "type": "message_batch_deleted"183 },184 "status": [185 "DOCUMENTED",186 "LIVE_VERIFIED"187 ],188 "sources": [189 {190 "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/delete",191 "retrieved_at": "2026-09-18"192 },193 {194 "url": "https://platform.claude.com/docs/en/api/messages/batches/delete",195 "retrieved_at": "2026-09-18"196 }197 ]198 },199 {200 "provider": "anthropic",201 "api_family": "messages-batches",202 "name": "MessageBatchIndividualResponse",203 "official_type_name": "BetaMessageBatchIndividualResponse",204 "description": "This is a single line in the response `.jsonl` file and does not represent the response as a whole.",205 "fields": [206 {207 "name": "custom_id",208 "type": "string",209 "required": true,210 "description": "Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch."211 },212 {213 "name": "result",214 "type": "BetaMessageBatchResult",215 "required": true,216 "description": "Processing result for this request. Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration."217 },218 {219 "name": "result.type",220 "type": "\"succeeded\"",221 "required": true,222 "description": "",223 "default": "succeeded"224 },225 {226 "name": "result.message",227 "type": "BetaMessage",228 "required": true,229 "description": ""230 },231 {232 "name": "result.message.type",233 "type": "\"message\"",234 "required": true,235 "description": "Object type. For Messages, this is always `\"message\"`.",236 "default": "message"237 },238 {239 "name": "result.message.id",240 "type": "string",241 "required": true,242 "description": "Unique object identifier. The format and length of IDs may change over time."243 },244 {245 "name": "result.message.container",246 "type": "BetaContainer or null",247 "required": true,248 "description": "Information about the container used in the request (for the code execution tool)"249 },250 {251 "name": "result.message.content",252 "type": "array of BetaContentBlock",253 "required": true,254 "description": "Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{\"type\": \"text\", \"text\": \"Hi, I'm Claude.\"}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {\"role\": \"user\", \"content\": \"What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun\"}, {\"role\": \"assistant\", \"content\": \"The best answer is (\"} ] ``` Then the response `content` might be: ```json [{\"type\": \"text\", \"text\": \"B)\"}] ```"255 },256 {257 "name": "result.message.context_management",258 "type": "BetaContextManagementResponse or null",259 "required": true,260 "description": "Context management response. Information about context management strategies applied during the request."261 },262 {263 "name": "result.message.diagnostics",264 "type": "BetaDiagnostics or null",265 "required": true,266 "description": "Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request."267 },268 {269 "name": "result.message.model",270 "type": "Model",271 "required": true,272 "description": "The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."273 },274 {275 "name": "result.message.role",276 "type": "\"assistant\"",277 "required": true,278 "description": "Conversational role of the generated message. This will always be `\"assistant\"`.",279 "default": "assistant"280 },281 {282 "name": "result.message.stop_details",283 "type": "BetaRefusalStopDetails or null",284 "required": true,285 "description": "Structured information about a refusal."286 },287 {288 "name": "result.message.stop_reason",289 "type": "BetaStopReason or null",290 "required": true,291 "description": "The reason that we stopped. This may be one the following values: * `\"end_turn\"`: the model reached a natural stopping point * `\"max_tokens\"`: we exceeded the requested `max_tokens` or the model's maximum * `\"stop_sequence\"`: one of your provided custom `stop_sequences` was generated * `\"tool_use\"`: the model invoked one or more tools * `\"pause_turn\"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `\"refusal\"`: when streaming classifiers intervene to handle potential policy violations * `\"model_context_window_exceeded\"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise.",292 "enum": [293 "end_turn",294 "max_tokens",295 "stop_sequence",296 "tool_use",297 "pause_turn",298 "compaction",299 "refusal",300 "model_context_window_exceeded"301 ]302 },303 {304 "name": "result.message.stop_sequence",305 "type": "string or null",306 "required": true,307 "description": "Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated."308 },309 {310 "name": "result.message.usage",311 "type": "BetaUsage",312 "required": true,313 "description": "Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`."314 },315 {316 "name": "result.message.input_transformations",317 "type": "array of BetaInputTransformation or null",318 "required": false,319 "description": "Changes the API made to the request's input before showing it to the model, and blocks that failed a binding check but were left unchanged: one entry per block, in request order. Two entry types today. `thinking_dropped` — a `thinking`, `redacted_thinking` or `connector_text` block from the request's `messages` that was removed from the prompt instead of being shown to the model because it failed a binding check. `thinking_mismatch_allowed` — a `thinking` or `redacted_thinking` block that failed the conversation check (the conversation before it differs from the one it was created in, or it carries no record of one on a model that requires it) and was shown to the model all the same, because that check is not enforced for this request. More entry types may be added over time; ignore types you do not recognize. Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on every such response from a model that supports extended thinking, as `[]` when there is no entry to report; without the beta, blocks are removed or left in place all the same but nothing is reported. Removed blocks contribute nothing to `usage.input_tokens`; blocks left in place count as sent. When streaming, the array is final in `message_start`; the final `message_delta` event carries it only when a server-side model fallback happened mid-stream, in which case it holds the serving model's entries and replaces the one in `message_start`."320 },321 {322 "name": "result.type",323 "type": "\"errored\"",324 "required": true,325 "description": "",326 "default": "errored"327 },328 {329 "name": "result.error",330 "type": "BetaErrorResponse",331 "required": true,332 "description": ""333 },334 {335 "name": "result.error.type",336 "type": "\"error\"",337 "required": true,338 "description": "",339 "default": "error"340 },341 {342 "name": "result.error.error",343 "type": "BetaError",344 "required": true,345 "description": ""346 },347 {348 "name": "result.error.request_id",349 "type": "string or null",350 "required": true,351 "description": ""352 },353 {354 "name": "result.type",355 "type": "\"canceled\"",356 "required": true,357 "description": "",358 "default": "canceled"359 },360 {361 "name": "result.type",362 "type": "\"expired\"",363 "required": true,364 "description": "",365 "default": "expired"366 }367 ],368 "example": null,369 "status": [370 "DOCUMENTED",371 "LIVE_VERIFIED"372 ],373 "sources": [374 {375 "url": "https://platform.claude.com/docs/en/api/beta/messages/batches/results",376 "retrieved_at": "2026-09-18"377 },378 {379 "url": "https://platform.claude.com/docs/en/api/messages/batches/results",380 "retrieved_at": "2026-09-18"381 }382 ]383 },384 {385 "provider": "anthropic",386 "api_family": "admin",387 "name": "ChatProjectUsage",388 "official_type_name": "BetaChatProjectUsage",389 "description": "Response for GET /v1/organizations/analytics/apps/chat/projects.",390 "fields": [391 {392 "name": "data",393 "type": "array of object",394 "required": true,395 "description": ""396 },397 {398 "name": "data[].distinct_user_count",399 "type": "number",400 "required": true,401 "description": "Number of distinct users who used the project on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values."402 },403 {404 "name": "data[].message_count",405 "type": "number",406 "required": true,407 "description": "Number of messages sent in the project on the requested day"408 },409 {410 "name": "data[].project_id",411 "type": "string",412 "required": true,413 "description": "Tagged project identifier (e.g. `claude_proj_...`)"414 },415 {416 "name": "data[].project_name",417 "type": "string",418 "required": true,419 "description": "Name of the project"420 },421 {422 "name": "data[].created_at",423 "type": "string or null",424 "required": false,425 "description": "Project creation timestamp in RFC 3339 format. Null if the project was deleted before attribution was recorded.",426 "constraints": {427 "format": "date-time"428 }429 },430 {431 "name": "data[].created_by",432 "type": "BetaAnalyticsUser or null",433 "required": false,434 "description": "A user in the organization, identified by tagged id and email address."435 },436 {437 "name": "data[].created_by.type",438 "type": "\"user\"",439 "required": true,440 "description": "Object type. Always `user`.",441 "default": "user"442 },443 {444 "name": "data[].created_by.id",445 "type": "string",446 "required": true,447 "description": "Tagged user identifier (e.g. `user_...`)"448 },449 {450 "name": "data[].created_by.email_address",451 "type": "string",452 "required": true,453 "description": "Email address of the user"454 },455 {456 "name": "data[].distinct_conversation_count",457 "type": "number or null",458 "required": false,459 "description": "Number of distinct conversations in the project. Null on aggregated rows where a distinct count cannot be computed."460 },461 {462 "name": "data[].product",463 "type": "string or null",464 "required": false,465 "description": "Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, or `office_agent` (the canonical Cost & Usage product naming; an `office_agent` row's per-surface breakdown is in its `office_metrics`). On `/plugins` only `cowork` and `claude_code` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, and `cowork` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`."466 },467 {468 "name": "data[].rbac_group_id",469 "type": "string or null",470 "required": false,471 "description": "Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`."472 },473 {474 "name": "data[].rbac_group_name",475 "type": "string or null",476 "required": false,477 "description": "Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key."478 },479 {480 "name": "data[].user_id",481 "type": "string or null",482 "required": false,483 "description": "Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`."484 },485 {486 "name": "next_page",487 "type": "string or null",488 "required": true,489 "description": "Opaque cursor for the next page, or null if no more results"490 }491 ],492 "example": {493 "data": [494 {495 "distinct_user_count": 0,496 "message_count": 0,497 "project_id": "project_id",498 "project_name": "project_name",499 "created_at": "2019-12-27T18:11:19.117Z",500 "created_by": {501 "id": "id",502 "email_address": "email_address",503 "type": "user"504 },505 "distinct_conversation_count": 0,506 "product": "product",507 "rbac_group_id": "rbac_group_id",508 "rbac_group_name": "rbac_group_name",509 "user_id": "user_id"510 }511 ],512 "next_page": "next_page"513 },514 "status": [515 "DOCUMENTED"516 ],517 "sources": [518 {519 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/chat_projects/list",520 "retrieved_at": "2026-09-18"521 },522 {523 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/chat_projects",524 "retrieved_at": "2026-09-18"525 }526 ]527 },528 {529 "provider": "anthropic",530 "api_family": "admin",531 "name": "ArtifactUsage",532 "official_type_name": "BetaArtifactUsage",533 "description": "Response for GET /v1/organizations/analytics/artifacts. `next_page` is null on ungrouped queries — the artifact-type cube is finite and returned in full. Grouped queries (`group_by[]` on `product` / `user_id` / `rbac_group_id`) multiply the cube and paginate like the other analytics list endpoints.",534 "fields": [535 {536 "name": "data",537 "type": "array of object",538 "required": true,539 "description": ""540 },541 {542 "name": "data[].artifact_type",543 "type": "string",544 "required": true,545 "description": "Canonical artifact MIME type (e.g. `text/markdown`, `application/vnd.ant.react`, `image/svg+xml`), or `other`. Claude Code and Cowork artifacts report as `text/html`."546 },547 {548 "name": "data[].artifacts_created_count",549 "type": "number",550 "required": true,551 "description": "Number of artifacts created in this bucket on the requested day"552 },553 {554 "name": "data[].distinct_user_count",555 "type": "number",556 "required": true,557 "description": "Number of distinct users who created artifacts in this bucket on the requested day"558 },559 {560 "name": "data[].is_shared",561 "type": "boolean",562 "required": true,563 "description": "Whether the artifacts in this bucket have ever been shared (a Claude Code / Cowork artifact is shared once anyone beyond its creator may open it: named members, the whole organization, or anyone with the link)."564 },565 {566 "name": "data[].published_artifacts_created_count",567 "type": "number",568 "required": true,569 "description": "Number of those artifacts that have been published (for Claude Code / Cowork artifacts: open to anyone with the link); never exceeds `artifacts_created_count`"570 },571 {572 "name": "data[].product",573 "type": "string or null",574 "required": false,575 "description": "Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, or `office_agent` (the canonical Cost & Usage product naming; an `office_agent` row's per-surface breakdown is in its `office_metrics`). On `/plugins` only `cowork` and `claude_code` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, and `cowork` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`."576 },577 {578 "name": "data[].rbac_group_id",579 "type": "string or null",580 "required": false,581 "description": "Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`."582 },583 {584 "name": "data[].rbac_group_name",585 "type": "string or null",586 "required": false,587 "description": "Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key."588 },589 {590 "name": "data[].user_id",591 "type": "string or null",592 "required": false,593 "description": "Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`."594 },595 {596 "name": "next_page",597 "type": "string or null",598 "required": true,599 "description": "Cursor for the next page of a grouped query; always null for the ungrouped artifact-type cube, which is returned in full."600 }601 ],602 "example": {603 "data": [604 {605 "artifact_type": "artifact_type",606 "artifacts_created_count": 0,607 "distinct_user_count": 0,608 "is_shared": true,609 "published_artifacts_created_count": 0,610 "product": "product",611 "rbac_group_id": "rbac_group_id",612 "rbac_group_name": "rbac_group_name",613 "user_id": "user_id"614 }615 ],616 "next_page": "next_page"617 },618 "status": [619 "DOCUMENTED"620 ],621 "sources": [622 {623 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/artifacts/list",624 "retrieved_at": "2026-09-18"625 },626 {627 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/artifacts",628 "retrieved_at": "2026-09-18"629 }630 ]631 },632 {633 "provider": "anthropic",634 "api_family": "admin",635 "name": "ConnectorUsage",636 "official_type_name": "BetaConnectorUsage",637 "description": "Response for GET /v1/organizations/analytics/connectors.",638 "fields": [639 {640 "name": "data",641 "type": "array of object",642 "required": true,643 "description": ""644 },645 {646 "name": "data[].chat_metrics",647 "type": "object",648 "required": true,649 "description": "Claude.ai activity metrics for a single connector on a given day."650 },651 {652 "name": "data[].chat_metrics.distinct_conversation_connector_used_count",653 "type": "number or null",654 "required": true,655 "description": "Number of distinct conversations in which the connector was used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."656 },657 {658 "name": "data[].claude_code_metrics",659 "type": "object",660 "required": true,661 "description": "Claude Code activity metrics for a single connector on a given day."662 },663 {664 "name": "data[].claude_code_metrics.distinct_session_connector_used_count",665 "type": "number or null",666 "required": true,667 "description": "Number of distinct Claude Code sessions in which the connector was used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."668 },669 {670 "name": "data[].connector_name",671 "type": "string",672 "required": true,673 "description": "Name of the connector. Some rows carry an opaque connector id here instead of a readable name; `connector_display_name` holds the resolved name for those rows."674 },675 {676 "name": "data[].cowork_metrics",677 "type": "object",678 "required": true,679 "description": "Cowork activity metrics for a single connector on a given day."680 },681 {682 "name": "data[].cowork_metrics.distinct_session_connector_used_count",683 "type": "number or null",684 "required": true,685 "description": "Number of distinct Cowork sessions in which the connector was used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."686 },687 {688 "name": "data[].distinct_user_count",689 "type": "number",690 "required": true,691 "description": "Number of distinct users who used the connector on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values."692 },693 {694 "name": "data[].office_metrics",695 "type": "object",696 "required": true,697 "description": "Office Agent activity metrics for a single connector on a given day, broken out by Office product."698 },699 {700 "name": "data[].office_metrics.excel",701 "type": "BetaConnectorOfficeProductMetrics",702 "required": true,703 "description": "Office Agent activity metrics for a single connector on a given day within one Office product."704 },705 {706 "name": "data[].office_metrics.outlook",707 "type": "BetaConnectorOfficeProductMetrics",708 "required": true,709 "description": "Office Agent activity metrics for a single connector on a given day within one Office product."710 },711 {712 "name": "data[].office_metrics.powerpoint",713 "type": "BetaConnectorOfficeProductMetrics",714 "required": true,715 "description": "Office Agent activity metrics for a single connector on a given day within one Office product."716 },717 {718 "name": "data[].office_metrics.word",719 "type": "BetaConnectorOfficeProductMetrics",720 "required": true,721 "description": "Office Agent activity metrics for a single connector on a given day within one Office product."722 },723 {724 "name": "data[].connector_display_name",725 "type": "string or null",726 "required": false,727 "description": "Human-readable display name for rows whose `connector_name` is an opaque connector id rather than a readable name, resolved at request time from the organization's connectors (including connectors that have since been removed). `connector_name` remains the row's stable key for sorting and pagination, and `filter[]=connector_name:{value}` also matches these rows by display name. Display names are not unique, and the same connector's claude.ai usage can appear under a separate row with a readable `connector_name`. Null when `connector_name` is already a readable name, when the id cannot be resolved to one of the organization's connectors, or when display-name resolution is not enabled for this organization."728 },729 {730 "name": "data[].individual_auth_distinct_user_count",731 "type": "number or null",732 "required": false,733 "description": "Number of distinct users whose use of this connector on the requested day ran on their own individual credential, connected through their own consent flow. Companion bucket to `managed_auth_distinct_user_count`, which carries the measurement, attribution, and null rules. Users whose requests used no stored credential count in neither bucket."734 },735 {736 "name": "data[].managed_auth_distinct_user_count",737 "type": "number or null",738 "required": false,739 "description": "Number of distinct users whose use of this connector on the requested day ran on Enterprise Managed Auth (an organization-managed credential provisioned through the organization's identity provider), read from the token record each request used. Null, never 0, when managed-auth reporting is not enabled for the organization, the value cannot be attributed to the row, no credentialed requests and no managed-token mint events (a managed credential being provisioned for a user's use of the connector) were observed that day, or the day predates 2026-07-01, the first day the backing data exists (forward-only data, no backfill). When credentialed requests or mint events were observed and attributed, both managed-auth fields populate, reporting 0 for a bucket with no users; the two counts are independent, not a partition — a user whose requests that day used both kinds of credential counts in both. Mint events carry user but not surface attribution, so they count as observed auth activity on `user_id` and `rbac_group_id` cuts — attributed to the user the credential was provisioned for — but never on a cut that references `product` (group or filter). Date-range rollup mode (`starting_date`/`ending_date`) computes both fields exactly over the window — distinct users with at least one qualifying day — when the whole window starts on or after 2026-07-01, with the null-versus-0 and mint-event rules applying with the window in place of the day; a range starting earlier reports every managed-auth field as null, never a partial-window value."740 },741 {742 "name": "data[].product",743 "type": "string or null",744 "required": false,745 "description": "Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, or `office_agent` (the canonical Cost & Usage product naming; an `office_agent` row's per-surface breakdown is in its `office_metrics`). On `/plugins` only `cowork` and `claude_code` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, and `cowork` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`."746 },747 {748 "name": "data[].rbac_group_id",749 "type": "string or null",750 "required": false,751 "description": "Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`."752 },753 {754 "name": "data[].rbac_group_name",755 "type": "string or null",756 "required": false,757 "description": "Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key."758 },759 {760 "name": "data[].read_call_count",761 "type": "number or null",762 "required": false,763 "description": "Number of connector tool calls on the requested day whose trusted read-only annotation marked them read-only. Call count, not distinct users. Every call recorded on a classified surface lands in exactly one of `read_call_count`, `write_call_count`, or `unclassified_call_count`, so the three sum to the day's classified calls. Classification is forward-only per surface: claude.ai from 2026-06-01, Claude Code from 2026-05-30, Claude in Office from 2026-05-29, Cowork from 2026-06-02 (Cowork clients predating annotation forwarding land in `unclassified_call_count`). Null, never 0, when the value cannot be stated: the read/write split is not enabled for this organization, or the day predates 2026-05-29. For a date-range total, sum the per-day values, but treat a window that extends before 2026-05-29 as null rather than summing only its covered days — date-range rollup mode (`starting_date`/`ending_date`) applies both rules server-side."764 },765 {766 "name": "data[].unclassified_call_count",767 "type": "number or null",768 "required": false,769 "description": "Number of connector tool calls on the requested day with no trusted read-only annotation — the annotation is optional in the MCP spec and is discarded when connector access controls are active, so unclassified calls are common. This field shows how much of the day's classified activity the read/write split actually covers. Call count, not distinct users. One of the three call-classification buckets; see `read_call_count` for the per-surface data-start dates, null conditions, and date-range guidance."770 },771 {772 "name": "data[].user_id",773 "type": "string or null",774 "required": false,775 "description": "Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`."776 },777 {778 "name": "data[].write_call_count",779 "type": "number or null",780 "required": false,781 "description": "Number of connector tool calls on the requested day whose trusted read-only annotation marked them not read-only. Call count, not distinct users. One of the three call-classification buckets; see `read_call_count` for the per-surface data-start dates, null conditions, and date-range guidance."782 },783 {784 "name": "next_page",785 "type": "string or null",786 "required": true,787 "description": "Opaque cursor for the next page, or null if no more results"788 }789 ],790 "example": {791 "data": [792 {793 "chat_metrics": {794 "distinct_conversation_connector_used_count": 0795 },796 "claude_code_metrics": {797 "distinct_session_connector_used_count": 0798 },799 "connector_name": "connector_name",800 "cowork_metrics": {801 "distinct_session_connector_used_count": 0802 },803 "distinct_user_count": 0,804 "office_metrics": {805 "excel": {806 "distinct_session_connector_used_count": 0807 },808 "outlook": {809 "distinct_session_connector_used_count": 0810 },811 "powerpoint": {812 "distinct_session_connector_used_count": 0813 },814 "word": {815 "distinct_session_connector_used_count": 0816 }817 },818 "connector_display_name": "connector_display_name",819 "individual_auth_distinct_user_count": 0,820 "managed_auth_distinct_user_count": 0,821 "product": "product",822 "rbac_group_id": "rbac_group_id",823 "rbac_group_name": "rbac_group_name",824 "read_call_count": 0,825 "unclassified_call_count": 0,826 "user_id": "user_id",827 "write_call_count": 0828 }829 ],830 "next_page": "next_page"831 },832 "status": [833 "DOCUMENTED"834 ],835 "sources": [836 {837 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors/list",838 "retrieved_at": "2026-09-18"839 },840 {841 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors",842 "retrieved_at": "2026-09-18"843 }844 ]845 },846 {847 "provider": "anthropic",848 "api_family": "admin",849 "name": "CostBucket",850 "official_type_name": "BetaCostBucket",851 "description": "Response object of GET /v1/organizations/analytics/cost_report",852 "fields": [853 {854 "name": "data",855 "type": "array of object",856 "required": true,857 "description": "Time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no data (their `results` list is empty). A page holds at most `limit` buckets."858 },859 {860 "name": "data[].ending_at",861 "type": "string",862 "required": true,863 "description": "End of the time bucket (exclusive) in RFC 3339 format.",864 "constraints": {865 "format": "date-time"866 }867 },868 {869 "name": "data[].results",870 "type": "array of object",871 "required": true,872 "description": "Rows for this time bucket. Empty when the bucket has no data; otherwise a single combined row when `group_by[]` is omitted, or one row per group (subject to the per-bucket group cap described on the `group_by[]` parameter)."873 },874 {875 "name": "data[].results[].amount",876 "type": "string",877 "required": true,878 "description": "Amount (post-discount, pre-credit) in fractional cents."879 },880 {881 "name": "data[].results[].claude_tag_category",882 "type": "\"dm\" or \"engaged\" or \"monitoring\" or 2 more or null",883 "required": true,884 "description": "Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.",885 "enum": [886 "dm",887 "engaged",888 "monitoring",889 "proactive",890 "scheduled"891 ]892 },893 {894 "name": "data[].results[].claude_tag_user_id",895 "type": "string or null",896 "required": true,897 "description": "Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter."898 },899 {900 "name": "data[].results[].context_window",901 "type": "\"0-200k\" or \"200k-1M\" or null",902 "required": true,903 "description": "Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution.",904 "enum": [905 "0-200k",906 "200k-1M"907 ]908 },909 {910 "name": "data[].results[].cost_type",911 "type": "\"code_execution\" or \"tokens\" or \"web_search\" or null",912 "required": true,913 "description": "Cost component when `group_by[]=cost_type`; null otherwise (amount is the combined total).",914 "enum": [915 "code_execution",916 "tokens",917 "web_search"918 ]919 },920 {921 "name": "data[].results[].currency",922 "type": "\"USD\"",923 "required": true,924 "description": "Currency code for the cost amount. Currently always `\"USD\"`.",925 "default": "USD"926 },927 {928 "name": "data[].results[].inference_geo",929 "type": "\"global\" or \"us\" or null",930 "required": true,931 "description": "Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches).",932 "enum": [933 "global",934 "us"935 ]936 },937 {938 "name": "data[].results[].list_amount",939 "type": "string",940 "required": true,941 "description": "List-price amount (pre-discount) in fractional cents."942 },943 {944 "name": "data[].results[].model",945 "type": "string or null",946 "required": true,947 "description": "Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution."948 },949 {950 "name": "data[].results[].product",951 "type": "string or null",952 "required": true,953 "description": "Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, and `claude-tag`. `claude-tag` is Claude Tag, the Claude product in Slack. Some unattributed usage is reported as \"other\"."954 },955 {956 "name": "data[].results[].rbac_group_id",957 "type": "string or null",958 "required": true,959 "description": "RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`."960 },961 {962 "name": "data[].results[].requests",963 "type": "number or null",964 "required": true,965 "description": "Number of API requests in this row's scope. Null when `group_by` includes `cost_type` or `token_type` (the count has no per-component attribution; read it from the ungrouped response). For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`)."966 },967 {968 "name": "data[].results[].slack_channel_id",969 "type": "string or null",970 "required": true,971 "description": "Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled)."972 },973 {974 "name": "data[].results[].speed",975 "type": "\"fast\" or \"standard\" or null",976 "required": true,977 "description": "Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`.",978 "enum": [979 "fast",980 "standard"981 ]982 },983 {984 "name": "data[].results[].token_type",985 "type": "\"cache_creation.ephemeral_1h_input_tokens\" or \"cache_creation.ephemeral_5m_input_tokens\" or \"cache_read_input_tokens\" or 2 more or null",986 "required": true,987 "description": "Token type when `group_by[]=token_type` and `cost_type=tokens`; null otherwise.",988 "enum": [989 "cache_creation.ephemeral_1h_input_tokens",990 "cache_creation.ephemeral_5m_input_tokens",991 "cache_read_input_tokens",992 "output_tokens",993 "uncached_input_tokens"994 ]995 },996 {997 "name": "data[].starting_at",998 "type": "string",999 "required": true,1000 "description": "Start of the time bucket (inclusive) in RFC 3339 format.",1001 "constraints": {1002 "format": "date-time"1003 }1004 },1005 {1006 "name": "data_refreshed_at",1007 "type": "string or null",1008 "required": true,1009 "description": "RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case every bucket's `results` list is empty. Buckets beyond this watermark are incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours but not final until about 30 days after the usage date (late-arriving events, reconciliation adjustments).",1010 "constraints": {1011 "format": "date-time"1012 }1013 },1014 {1015 "name": "has_more",1016 "type": "boolean",1017 "required": true,1018 "description": "Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it."1019 },1020 {1021 "name": "next_page",1022 "type": "string or null",1023 "required": true,1024 "description": "Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page."1025 },1026 {1027 "name": "organization_id",1028 "type": "string",1029 "required": true,1030 "description": "ID of the Organization."1031 }1032 ],1033 "example": {1034 "data": [1035 {1036 "ending_at": "2019-12-27T18:11:19.117Z",1037 "results": [1038 {1039 "amount": "amount",1040 "claude_tag_category": "dm",1041 "claude_tag_user_id": "U0123ABCDEF",1042 "context_window": "0-200k",1043 "cost_type": "code_execution",1044 "currency": "USD",1045 "inference_geo": "global",1046 "list_amount": "list_amount",1047 "model": "claude-opus-5",1048 "product": "chat",1049 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",1050 "requests": 0,1051 "slack_channel_id": "C0123ABCDEF",1052 "speed": "fast",1053 "token_type": "cache_creation.ephemeral_1h_input_tokens"1054 }1055 ],1056 "starting_at": "2019-12-27T18:11:19.117Z"1057 }1058 ],1059 "data_refreshed_at": "2019-12-27T18:11:19.117Z",1060 "has_more": true,1061 "next_page": "next_page",1062 "organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"1063 },1064 "status": [1065 "DOCUMENTED"1066 ],1067 "sources": [1068 {1069 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",1070 "retrieved_at": "2026-09-18"1071 },1072 {1073 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost",1074 "retrieved_at": "2026-09-18"1075 }1076 ]1077 },1078 {1079 "provider": "anthropic",1080 "api_family": "admin",1081 "name": "PluginUsage",1082 "official_type_name": "BetaPluginUsage",1083 "description": "Response for GET /v1/organizations/analytics/plugins.",1084 "fields": [1085 {1086 "name": "data",1087 "type": "array of object",1088 "required": true,1089 "description": ""1090 },1091 {1092 "name": "data[].claude_code_metrics",1093 "type": "object",1094 "required": true,1095 "description": "Claude Code activity metrics for a single plugin on a given day."1096 },1097 {1098 "name": "data[].claude_code_metrics.distinct_session_plugin_used_count",1099 "type": "number or null",1100 "required": true,1101 "description": "Number of distinct Claude Code sessions in which the plugin was invoked. Null on aggregated rows where a distinct count cannot be computed."1102 },1103 {1104 "name": "data[].cowork_metrics",1105 "type": "object",1106 "required": true,1107 "description": "Cowork activity metrics for a single plugin on a given day."1108 },1109 {1110 "name": "data[].cowork_metrics.distinct_session_plugin_used_count",1111 "type": "number or null",1112 "required": true,1113 "description": "Number of distinct Cowork sessions in which the plugin was invoked. Null on aggregated rows where a distinct count cannot be computed."1114 },1115 {1116 "name": "data[].distinct_user_count",1117 "type": "number",1118 "required": true,1119 "description": "Number of distinct users with recorded install or invocation activity for the plugin on the requested day (install-only users count), or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values."1120 },1121 {1122 "name": "data[].install_count",1123 "type": "number or null",1124 "required": true,1125 "description": "Number of distinct users who installed the plugin on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values."1126 },1127 {1128 "name": "data[].invocation_count",1129 "type": "number",1130 "required": true,1131 "description": "Number of plugin invocations on the requested day"1132 },1133 {1134 "name": "data[].plugin_name",1135 "type": "string",1136 "required": true,1137 "description": "Name of the plugin"1138 },1139 {1140 "name": "data[].plugin_id",1141 "type": "string or null",1142 "required": false,1143 "description": "Stable plugin identifier when available (e.g. `serena@claude-plugins-official`). Null for third-party Claude Code plugins (redacted at the source) and Cowork slash commands that carry only a hashed id."1144 },1145 {1146 "name": "data[].product",1147 "type": "string or null",1148 "required": false,1149 "description": "Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, or `office_agent` (the canonical Cost & Usage product naming; an `office_agent` row's per-surface breakdown is in its `office_metrics`). On `/plugins` only `cowork` and `claude_code` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, and `cowork` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`."1150 },1151 {1152 "name": "data[].rbac_group_id",1153 "type": "string or null",1154 "required": false,1155 "description": "Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`."1156 },1157 {1158 "name": "data[].rbac_group_name",1159 "type": "string or null",1160 "required": false,1161 "description": "Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key."1162 },1163 {1164 "name": "data[].user_id",1165 "type": "string or null",1166 "required": false,1167 "description": "Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`."1168 },1169 {1170 "name": "next_page",1171 "type": "string or null",1172 "required": true,1173 "description": "Opaque cursor for the next page, or null if no more results"1174 }1175 ],1176 "example": {1177 "data": [1178 {1179 "claude_code_metrics": {1180 "distinct_session_plugin_used_count": 01181 },1182 "cowork_metrics": {1183 "distinct_session_plugin_used_count": 01184 },1185 "distinct_user_count": 0,1186 "install_count": 0,1187 "invocation_count": 0,1188 "plugin_name": "plugin_name",1189 "plugin_id": "plugin_id",1190 "product": "product",1191 "rbac_group_id": "rbac_group_id",1192 "rbac_group_name": "rbac_group_name",1193 "user_id": "user_id"1194 }1195 ],1196 "next_page": "next_page"1197 },1198 "status": [1199 "DOCUMENTED"1200 ],1201 "sources": [1202 {1203 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins/list",1204 "retrieved_at": "2026-09-18"1205 },1206 {1207 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins",1208 "retrieved_at": "2026-09-18"1209 }1210 ]1211 },1212 {1213 "provider": "anthropic",1214 "api_family": "admin",1215 "name": "SkillUsage",1216 "official_type_name": "BetaSkillUsage",1217 "description": "Response for GET /v1/organizations/analytics/skills.",1218 "fields": [1219 {1220 "name": "data",1221 "type": "array of object",1222 "required": true,1223 "description": ""1224 },1225 {1226 "name": "data[].chat_metrics",1227 "type": "object",1228 "required": true,1229 "description": "Claude.ai activity metrics for a single skill on a given day."1230 },1231 {1232 "name": "data[].chat_metrics.distinct_conversation_skill_used_count",1233 "type": "number or null",1234 "required": true,1235 "description": "Number of distinct conversations in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."1236 },1237 {1238 "name": "data[].claude_code_metrics",1239 "type": "object",1240 "required": true,1241 "description": "Claude Code activity metrics for a single skill on a given day."1242 },1243 {1244 "name": "data[].claude_code_metrics.distinct_session_skill_used_count",1245 "type": "number or null",1246 "required": true,1247 "description": "Number of distinct Claude Code sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."1248 },1249 {1250 "name": "data[].cowork_metrics",1251 "type": "object",1252 "required": true,1253 "description": "Cowork activity metrics for a single skill on a given day."1254 },1255 {1256 "name": "data[].cowork_metrics.distinct_session_skill_used_count",1257 "type": "number or null",1258 "required": true,1259 "description": "Number of distinct Cowork sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."1260 },1261 {1262 "name": "data[].distinct_user_count",1263 "type": "number",1264 "required": true,1265 "description": "Number of distinct users who used the skill on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted."1266 },1267 {1268 "name": "data[].office_metrics",1269 "type": "object",1270 "required": true,1271 "description": "Office Agent activity metrics for a single skill on a given day, broken out by Office product."1272 },1273 {1274 "name": "data[].office_metrics.excel",1275 "type": "BetaSkillOfficeProductMetrics",1276 "required": true,1277 "description": "Office Agent activity metrics for a single skill on a given day within one Office product."1278 },1279 {1280 "name": "data[].office_metrics.outlook",1281 "type": "BetaSkillOfficeProductMetrics",1282 "required": true,1283 "description": "Office Agent activity metrics for a single skill on a given day within one Office product."1284 },1285 {1286 "name": "data[].office_metrics.powerpoint",1287 "type": "BetaSkillOfficeProductMetrics",1288 "required": true,1289 "description": "Office Agent activity metrics for a single skill on a given day within one Office product."1290 },1291 {1292 "name": "data[].office_metrics.word",1293 "type": "BetaSkillOfficeProductMetrics",1294 "required": true,1295 "description": "Office Agent activity metrics for a single skill on a given day within one Office product."1296 },1297 {1298 "name": "data[].skill_name",1299 "type": "string",1300 "required": true,1301 "description": "Name of the skill"1302 },1303 {1304 "name": "data[].attributed_list_price",1305 "type": "string or null",1306 "required": false,1307 "description": "List-price (rate-card) value of the member requests attributed to this skill, as a decimal string in the minor unit of `currency` (cents for USD), from Claude Code, Cowork, and Office Agent request-level attribution — the value of requests that involved the skill, not the skill's incremental cost. Unlike `estimated_overage_spend` this reflects usage value regardless of how it was funded — seat-covered usage counts — but it is undiscounted and does not tie to billed spend or the organization's spend reporting. claude.ai chat usage carries no request-level attribution and contributes nothing: the field is null on `chat` product rows and on `office_agent` product cuts dated before 2026-06-18 (the Office Agent attribution data-start), and on ungrouped rows it covers the Claude Code + Cowork + Office Agent share only (null when no attributable usage exists). Also null under the same conditions as `estimated_overage_spend` (spend reporting not enabled for this organization, `office_agent` product cuts before the 2026-06-18 data-start). \"0\" means attributable usage existed but none was attributed to this skill. Addable across days: date-range rollup mode returns the window's sum. On `group_by[]` and `filter[]` shapes both amounts can total below the ungrouped value for the same skill over the same date or range: spend attributed to a member–skill pair with no counted usage on that day is excluded from those cuts."1308 },1309 {1310 "name": "data[].currency",1311 "type": "\"USD\" or null",1312 "required": false,1313 "description": "Currency for this row's monetary fields (`estimated_overage_spend` and `attributed_list_price`), as an uppercase ISO-4217 code. Always \"USD\" when either amount is populated; null whenever both amounts are null."1314 },1315 {1316 "name": "data[].enable_count",1317 "type": "number or null",1318 "required": false,1319 "description": "Distinct accounts that enabled this skill on the requested day (claude.ai only — the skill analog of plugin `install_count`). The count is org-wide: null when enable reporting is not enabled for this organization, or when the request scopes to `user_id` / `rbac_group_id` / `product` via `group_by[]` or `filter[]` (an org-wide count would be misleading on per-cut rows). A distinct count, not an event count: summing across days double-counts members who enable the skill on more than one day, so it is also null in date-range rollup mode (`starting_date`/`ending_date`)."1320 },1321 {1322 "name": "data[].estimated_overage_spend",1323 "type": "string or null",1324 "required": false,1325 "description": "Estimated overage spend attributed to this skill, as a decimal string in the minor unit of `currency` (cents for USD; \"1250\" is $12.50, fractional cents possible) — an allocation of each member's daily post-discount, pre-credit metered overage spend (the same cost basis as the organization's spend reporting and the Cost & Usage API, so per-skill figures are directly comparable; spend with no skill attribution — including any member-day without skill invocations — is not represented, so skill rows sum to at most those totals) across the skills the member used. Overage only: usage covered by included seat allowances bills nothing and allocates $0 here — see `attributed_list_price` for the funding-independent usage-value companion. Claude Code, Cowork, and Office Agent spend use request-level skill attribution; claude.ai chat spend is approximated proportionally to skill-invoking messages. An estimate, not a billing number — and the cost of the requests/messages that involved the skill, not the skill's incremental cost (the same request would still have cost something without the skill active). \"0\" means no overage spend was attributed; null when spend reporting is not enabled for this organization, on `office_agent` product cuts dated before 2026-06-18 (the Office Agent attribution data-start). Addable across days: date-range rollup mode (`starting_date`/`ending_date`) returns the window's sum. With `group_by[]=user_id` each row carries the user's own attributed spend. On `group_by[]` and `filter[]` shapes both amounts can total below the ungrouped value for the same skill over the same date or range: spend attributed to a member–skill pair with no counted usage on that day is excluded from those cuts."1326 },1327 {1328 "name": "data[].invocation_count",1329 "type": "number or null",1330 "required": false,1331 "description": "Total number of times this skill was invoked on the requested day (the skill analog of plugin `invocation_count`). Unlike `distinct_user_count` — which answers '\\# of users' — this is the true '# of uses'. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Null when invocation reporting is not enabled for this organization. Sum across a date range for total uses in the window — date-range rollup mode (`starting_date`/`ending_date`) returns this sum directly."1332 },1333 {1334 "name": "data[].product",1335 "type": "string or null",1336 "required": false,1337 "description": "Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, or `office_agent` (the canonical Cost & Usage product naming; an `office_agent` row's per-surface breakdown is in its `office_metrics`). On `/plugins` only `cowork` and `claude_code` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, and `cowork` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`."1338 },1339 {1340 "name": "data[].rbac_group_id",1341 "type": "string or null",1342 "required": false,1343 "description": "Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`."1344 },1345 {1346 "name": "data[].rbac_group_name",1347 "type": "string or null",1348 "required": false,1349 "description": "Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key."1350 },1351 {1352 "name": "data[].share_status",1353 "type": "\"organization\" or \"private\" or \"public\" or null",1354 "required": false,1355 "description": "Skill share status (claude.ai only): one of `private`, `organization`, or `public`. Null for skills used only in Claude Code or Office (no per-skill share-status concept) and when share-status reporting is not yet available for the organization. Filterable via `filter[]=share_status:{value}`.",1356 "enum": [1357 "organization",1358 "private",1359 "public"1360 ]1361 },1362 {1363 "name": "data[].skill_display_name",1364 "type": "string or null",1365 "required": false,1366 "description": "Human-readable display name for rows whose `skill_name` is an opaque skill id (user/organization skill types and plugin-delivered skills — user-defined names are withheld from the analytics pipeline). Organization-shared skills and skills delivered by the organization's own plugins (its plugin marketplaces and its library) resolve; plugin skill names are shown without their 'plugin:' prefix. The literal 'unknown' bucket row gets a fixed 'Unknown skill' label. Null for private (user-defined) skills and members' personal-plugin skills — those names are not disclosed to analytics-key holders — and for Anthropic-provided plugin skills (not resolved), and null when `skill_name` is already a display name, when the skill or plugin was deleted, or when display-name resolution is not enabled for this organization."1367 },1368 {1369 "name": "data[].user_id",1370 "type": "string or null",1371 "required": false,1372 "description": "Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`."1373 },1374 {1375 "name": "next_page",1376 "type": "string or null",1377 "required": true,1378 "description": "Opaque cursor for the next page, or null if no more results"1379 }1380 ],1381 "example": {1382 "data": [1383 {1384 "chat_metrics": {1385 "distinct_conversation_skill_used_count": 01386 },1387 "claude_code_metrics": {1388 "distinct_session_skill_used_count": 01389 },1390 "cowork_metrics": {1391 "distinct_session_skill_used_count": 01392 },1393 "distinct_user_count": 0,1394 "office_metrics": {1395 "excel": {1396 "distinct_session_skill_used_count": 01397 },1398 "outlook": {1399 "distinct_session_skill_used_count": 01400 },1401 "powerpoint": {1402 "distinct_session_skill_used_count": 01403 },1404 "word": {1405 "distinct_session_skill_used_count": 01406 }1407 },1408 "skill_name": "skill_name",1409 "attributed_list_price": "attributed_list_price",1410 "currency": "USD",1411 "enable_count": 0,1412 "estimated_overage_spend": "estimated_overage_spend",1413 "invocation_count": 0,1414 "product": "product",1415 "rbac_group_id": "rbac_group_id",1416 "rbac_group_name": "rbac_group_name",1417 "share_status": "organization",1418 "skill_display_name": "skill_display_name",1419 "user_id": "user_id"1420 }1421 ],1422 "next_page": "next_page"1423 },1424 "status": [1425 "DOCUMENTED"1426 ],1427 "sources": [1428 {1429 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/skills/list",1430 "retrieved_at": "2026-09-18"1431 },1432 {1433 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/skills",1434 "retrieved_at": "2026-09-18"1435 }1436 ]1437 },1438 {1439 "provider": "anthropic",1440 "api_family": "admin",1441 "name": "ActivitySummary",1442 "official_type_name": "BetaActivitySummary",1443 "description": "Response for GET /v1/organizations/analytics/summaries.",1444 "fields": [1445 {1446 "name": "summaries",1447 "type": "array of object",1448 "required": true,1449 "description": ""1450 },1451 {1452 "name": "summaries[].assigned_seat_count",1453 "type": "number or null",1454 "required": true,1455 "description": "Number of seats currently assigned to members. Null when the response is scoped to an RBAC group — seat assignment is org-wide and has no per-group analogue."1456 },1457 {1458 "name": "summaries[].cowork_daily_active_user_count",1459 "type": "number",1460 "required": true,1461 "description": "Number of users with Cowork activity on the requested day"1462 },1463 {1464 "name": "summaries[].cowork_monthly_active_user_count",1465 "type": "number",1466 "required": true,1467 "description": "Number of users with Cowork activity in the 30-day rolling window"1468 },1469 {1470 "name": "summaries[].cowork_weekly_active_user_count",1471 "type": "number",1472 "required": true,1473 "description": "Number of users with Cowork activity in the 7-day rolling window"1474 },1475 {1476 "name": "summaries[].daily_active_user_count",1477 "type": "number",1478 "required": true,1479 "description": "Number of users with token consumption on the requested day"1480 },1481 {1482 "name": "summaries[].daily_adoption_rate",1483 "type": "number or null",1484 "required": true,1485 "description": "Percentage of assigned seats with activity on the requested day (`DAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group."1486 },1487 {1488 "name": "summaries[].ending_at",1489 "type": "string",1490 "required": true,1491 "description": "End of the aggregation period (exclusive), UTC midnight in RFC 3339 format (e.g. `2026-01-16T00:00:00Z`).",1492 "constraints": {1493 "format": "date-time"1494 }1495 },1496 {1497 "name": "summaries[].monthly_active_user_count",1498 "type": "number",1499 "required": true,1500 "description": "Number of users with token consumption in the 30-day rolling window"1501 },1502 {1503 "name": "summaries[].monthly_adoption_rate",1504 "type": "number or null",1505 "required": true,1506 "description": "Percentage of assigned seats with activity in the 30-day rolling window (`MAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group."1507 },1508 {1509 "name": "summaries[].pending_invite_count",1510 "type": "number or null",1511 "required": true,1512 "description": "Number of pending invitations to join the organization. Null when the response is scoped to an RBAC group."1513 },1514 {1515 "name": "summaries[].starting_at",1516 "type": "string",1517 "required": true,1518 "description": "Start of the aggregation period (inclusive), UTC midnight in RFC 3339 format (e.g. `2026-01-15T00:00:00Z`).",1519 "constraints": {1520 "format": "date-time"1521 }1522 },1523 {1524 "name": "summaries[].weekly_active_user_count",1525 "type": "number",1526 "required": true,1527 "description": "Number of users with token consumption in the 7-day rolling window"1528 },1529 {1530 "name": "summaries[].weekly_adoption_rate",1531 "type": "number or null",1532 "required": true,1533 "description": "Percentage of assigned seats with activity in the 7-day rolling window (`WAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group."1534 },1535 {1536 "name": "summaries[].chat_daily_active_user_count",1537 "type": "number or null",1538 "required": false,1539 "description": "Number of users with claude.ai (chat) activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization."1540 },1541 {1542 "name": "summaries[].chat_monthly_active_user_count",1543 "type": "number or null",1544 "required": false,1545 "description": "Number of users with claude.ai (chat) activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization."1546 },1547 {1548 "name": "summaries[].chat_weekly_active_user_count",1549 "type": "number or null",1550 "required": false,1551 "description": "Number of users with claude.ai (chat) activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization."1552 },1553 {1554 "name": "summaries[].claude_code_daily_active_user_count",1555 "type": "number or null",1556 "required": false,1557 "description": "Number of users with Claude Code activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization."1558 },1559 {1560 "name": "summaries[].claude_code_monthly_active_user_count",1561 "type": "number or null",1562 "required": false,1563 "description": "Number of users with Claude Code activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization."1564 },1565 {1566 "name": "summaries[].claude_code_weekly_active_user_count",1567 "type": "number or null",1568 "required": false,1569 "description": "Number of users with Claude Code activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization."1570 },1571 {1572 "name": "summaries[].claude_design_daily_active_user_count",1573 "type": "number or null",1574 "required": false,1575 "description": "Number of users with Claude Design activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization."1576 },1577 {1578 "name": "summaries[].claude_design_monthly_active_user_count",1579 "type": "number or null",1580 "required": false,1581 "description": "Number of users with Claude Design activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization."1582 },1583 {1584 "name": "summaries[].claude_design_weekly_active_user_count",1585 "type": "number or null",1586 "required": false,1587 "description": "Number of users with Claude Design activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization."1588 },1589 {1590 "name": "summaries[].office_agent_daily_active_user_count",1591 "type": "number or null",1592 "required": false,1593 "description": "Number of users with Claude in Office activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization."1594 },1595 {1596 "name": "summaries[].office_agent_monthly_active_user_count",1597 "type": "number or null",1598 "required": false,1599 "description": "Number of users with Claude in Office activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization."1600 },1601 {1602 "name": "summaries[].office_agent_weekly_active_user_count",1603 "type": "number or null",1604 "required": false,1605 "description": "Number of users with Claude in Office activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization."1606 },1607 {1608 "name": "summaries[].science_daily_active_user_count",1609 "type": "number or null",1610 "required": false,1611 "description": "Number of users with Claude Science activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization."1612 },1613 {1614 "name": "summaries[].science_entitled_user_count",1615 "type": "number or null",1616 "required": false,1617 "description": "Number of users with a Claude Science seat entitlement (per-seat RBAC) at the time of the daily snapshot. The funnel top; independent of the org-level Claude Science toggle. Null when the response is scoped to an RBAC group — entitlement is org-wide and has no per-group analogue. Omitted from the response while the per-product breakdown is not enabled for this organization."1618 },1619 {1620 "name": "summaries[].science_monthly_active_user_count",1621 "type": "number or null",1622 "required": false,1623 "description": "Number of users with Claude Science activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization."1624 },1625 {1626 "name": "summaries[].science_weekly_active_user_count",1627 "type": "number or null",1628 "required": false,1629 "description": "Number of users with Claude Science activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization."1630 }1631 ],1632 "example": {1633 "summaries": [1634 {1635 "assigned_seat_count": 0,1636 "cowork_daily_active_user_count": 0,1637 "cowork_monthly_active_user_count": 0,1638 "cowork_weekly_active_user_count": 0,1639 "daily_active_user_count": 0,1640 "daily_adoption_rate": 0,1641 "ending_at": "2019-12-27T18:11:19.117Z",1642 "monthly_active_user_count": 0,1643 "monthly_adoption_rate": 0,1644 "pending_invite_count": 0,1645 "starting_at": "2019-12-27T18:11:19.117Z",1646 "weekly_active_user_count": 0,1647 "weekly_adoption_rate": 0,1648 "chat_daily_active_user_count": 0,1649 "chat_monthly_active_user_count": 0,1650 "chat_weekly_active_user_count": 0,1651 "claude_code_daily_active_user_count": 0,1652 "claude_code_monthly_active_user_count": 0,1653 "claude_code_weekly_active_user_count": 0,1654 "claude_design_daily_active_user_count": 0,1655 "claude_design_monthly_active_user_count": 0,1656 "claude_design_weekly_active_user_count": 0,1657 "office_agent_daily_active_user_count": 0,1658 "office_agent_monthly_active_user_count": 0,1659 "office_agent_weekly_active_user_count": 0,1660 "science_daily_active_user_count": 0,1661 "science_entitled_user_count": 0,1662 "science_monthly_active_user_count": 0,1663 "science_weekly_active_user_count": 01664 }1665 ]1666 },1667 "status": [1668 "DOCUMENTED"1669 ],1670 "sources": [1671 {1672 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/retrieve_summaries",1673 "retrieved_at": "2026-09-18"1674 },1675 {1676 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics",1677 "retrieved_at": "2026-09-18"1678 }1679 ]1680 },1681 {1682 "provider": "anthropic",1683 "api_family": "admin",1684 "name": "UsageBucket",1685 "official_type_name": "BetaUsageBucket",1686 "description": "Response object of GET /v1/organizations/analytics/usage_report",1687 "fields": [1688 {1689 "name": "data",1690 "type": "array of object",1691 "required": true,1692 "description": "Time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no data (their `results` list is empty). A page holds at most `limit` buckets."1693 },1694 {1695 "name": "data[].ending_at",1696 "type": "string",1697 "required": true,1698 "description": "End of the time bucket (exclusive) in RFC 3339 format.",1699 "constraints": {1700 "format": "date-time"1701 }1702 },1703 {1704 "name": "data[].results",1705 "type": "array of object",1706 "required": true,1707 "description": "Rows for this time bucket. Empty when the bucket has no data; otherwise a single combined row when `group_by[]` is omitted, or one row per group (subject to the per-bucket group cap described on the `group_by[]` parameter)."1708 },1709 {1710 "name": "data[].results[].cache_creation",1711 "type": "BetaCacheCreation",1712 "required": true,1713 "description": "The number of input tokens for cache creation."1714 },1715 {1716 "name": "data[].results[].cache_read_input_tokens",1717 "type": "number",1718 "required": true,1719 "description": "The number of input tokens read from the cache."1720 },1721 {1722 "name": "data[].results[].claude_tag_category",1723 "type": "\"dm\" or \"engaged\" or \"monitoring\" or 2 more or null",1724 "required": true,1725 "description": "Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.",1726 "enum": [1727 "dm",1728 "engaged",1729 "monitoring",1730 "proactive",1731 "scheduled"1732 ]1733 },1734 {1735 "name": "data[].results[].claude_tag_user_id",1736 "type": "string or null",1737 "required": true,1738 "description": "Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter."1739 },1740 {1741 "name": "data[].results[].context_window",1742 "type": "\"0-200k\" or \"200k-1M\" or null",1743 "required": true,1744 "description": "Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution.",1745 "enum": [1746 "0-200k",1747 "200k-1M"1748 ]1749 },1750 {1751 "name": "data[].results[].inference_geo",1752 "type": "\"global\" or \"us\" or null",1753 "required": true,1754 "description": "Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches).",1755 "enum": [1756 "global",1757 "us"1758 ]1759 },1760 {1761 "name": "data[].results[].model",1762 "type": "string or null",1763 "required": true,1764 "description": "Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution."1765 },1766 {1767 "name": "data[].results[].output_tokens",1768 "type": "number",1769 "required": true,1770 "description": "The number of output tokens generated."1771 },1772 {1773 "name": "data[].results[].product",1774 "type": "string or null",1775 "required": true,1776 "description": "Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, and `claude-tag`. `claude-tag` is Claude Tag, the Claude product in Slack. Some unattributed usage is reported as \"other\"."1777 },1778 {1779 "name": "data[].results[].rbac_group_id",1780 "type": "string or null",1781 "required": true,1782 "description": "RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`."1783 },1784 {1785 "name": "data[].results[].requests",1786 "type": "number or null",1787 "required": true,1788 "description": "Number of API requests in this row's scope. For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`)."1789 },1790 {1791 "name": "data[].results[].server_tool_use",1792 "type": "object",1793 "required": true,1794 "description": "Server-side tool usage metrics."1795 },1796 {1797 "name": "data[].results[].slack_channel_id",1798 "type": "string or null",1799 "required": true,1800 "description": "Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled)."1801 },1802 {1803 "name": "data[].results[].speed",1804 "type": "\"fast\" or \"standard\" or null",1805 "required": true,1806 "description": "Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`.",1807 "enum": [1808 "fast",1809 "standard"1810 ]1811 },1812 {1813 "name": "data[].results[].uncached_input_tokens",1814 "type": "number",1815 "required": true,1816 "description": "The number of uncached input tokens processed."1817 },1818 {1819 "name": "data[].starting_at",1820 "type": "string",1821 "required": true,1822 "description": "Start of the time bucket (inclusive) in RFC 3339 format.",1823 "constraints": {1824 "format": "date-time"1825 }1826 },1827 {1828 "name": "data_refreshed_at",1829 "type": "string or null",1830 "required": true,1831 "description": "RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case every bucket's `results` list is empty. Buckets beyond this watermark are incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours but not final until about 30 days after the usage date (late-arriving events, reconciliation adjustments).",1832 "constraints": {1833 "format": "date-time"1834 }1835 },1836 {1837 "name": "has_more",1838 "type": "boolean",1839 "required": true,1840 "description": "Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it."1841 },1842 {1843 "name": "next_page",1844 "type": "string or null",1845 "required": true,1846 "description": "Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page."1847 },1848 {1849 "name": "organization_id",1850 "type": "string",1851 "required": true,1852 "description": "ID of the Organization."1853 }1854 ],1855 "example": {1856 "data": [1857 {1858 "ending_at": "2019-12-27T18:11:19.117Z",1859 "results": [1860 {1861 "cache_creation": {1862 "ephemeral_1h_input_tokens": 0,1863 "ephemeral_5m_input_tokens": 01864 },1865 "cache_read_input_tokens": 0,1866 "claude_tag_category": "dm",1867 "claude_tag_user_id": "U0123ABCDEF",1868 "context_window": "0-200k",1869 "inference_geo": "global",1870 "model": "claude-opus-5",1871 "output_tokens": 0,1872 "product": "chat",1873 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",1874 "requests": 0,1875 "server_tool_use": {1876 "web_search_requests": 101877 },1878 "slack_channel_id": "C0123ABCDEF",1879 "speed": "fast",1880 "uncached_input_tokens": 01881 }1882 ],1883 "starting_at": "2019-12-27T18:11:19.117Z"1884 }1885 ],1886 "data_refreshed_at": "2019-12-27T18:11:19.117Z",1887 "has_more": true,1888 "next_page": "next_page",1889 "organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"1890 },1891 "status": [1892 "DOCUMENTED"1893 ],1894 "sources": [1895 {1896 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",1897 "retrieved_at": "2026-09-18"1898 },1899 {1900 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage",1901 "retrieved_at": "2026-09-18"1902 }1903 ]1904 },1905 {1906 "provider": "anthropic",1907 "api_family": "admin",1908 "name": "UserCost",1909 "official_type_name": "BetaUserCost",1910 "description": "Response object of GET /v1/organizations/analytics/user_cost_report",1911 "fields": [1912 {1913 "name": "data",1914 "type": "array of object",1915 "required": true,1916 "description": "Rows for this page, ranked by `order_by` in the `order` direction. One row per user, or several per user when `group_by[]` or `bucket_width` breaks that user's usage or cost out across rows. Rows split out by `cost_type` or `token_type` (cost endpoint only) stay adjacent and are ranked as one unit."1917 },1918 {1919 "name": "data[].actor",1920 "type": "BetaAnalyticsUserActor",1921 "required": true,1922 "description": "The user this row's usage or cost is attributed to. Always a `user_actor`."1923 },1924 {1925 "name": "data[].actor.type",1926 "type": "\"user_actor\"",1927 "required": true,1928 "description": "Actor type. Always `\"user_actor\"`."1929 },1930 {1931 "name": "data[].actor.deleted",1932 "type": "boolean",1933 "required": true,1934 "description": "True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation."1935 },1936 {1937 "name": "data[].actor.email",1938 "type": "string or null",1939 "required": true,1940 "description": "The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`)."1941 },1942 {1943 "name": "data[].actor.name",1944 "type": "string or null",1945 "required": true,1946 "description": "The user's full name. Null when the user has not set a name. Returns `\"Deleted User\"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `\"Claude Security\"` for usage by Anthropic's security-patching service) or null."1947 },1948 {1949 "name": "data[].actor.user_id",1950 "type": "string",1951 "required": true,1952 "description": "Tagged user ID."1953 },1954 {1955 "name": "data[].amount",1956 "type": "string",1957 "required": true,1958 "description": "Amount (post-discount, pre-credit) in fractional cents (minor units)."1959 },1960 {1961 "name": "data[].claude_tag_category",1962 "type": "\"dm\" or \"engaged\" or \"monitoring\" or 2 more or null",1963 "required": true,1964 "description": "Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.",1965 "enum": [1966 "dm",1967 "engaged",1968 "monitoring",1969 "proactive",1970 "scheduled"1971 ]1972 },1973 {1974 "name": "data[].claude_tag_user_id",1975 "type": "string or null",1976 "required": true,1977 "description": "Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter."1978 },1979 {1980 "name": "data[].context_window",1981 "type": "\"0-200k\" or \"200k-1M\" or null",1982 "required": true,1983 "description": "Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution.",1984 "enum": [1985 "0-200k",1986 "200k-1M"1987 ]1988 },1989 {1990 "name": "data[].cost_type",1991 "type": "\"code_execution\" or \"tokens\" or \"web_search\" or null",1992 "required": true,1993 "description": "Cost component breakdown; null when returning the combined total.",1994 "enum": [1995 "code_execution",1996 "tokens",1997 "web_search"1998 ]1999 },2000 {2001 "name": "data[].currency",2002 "type": "\"USD\"",2003 "required": true,2004 "description": "Currency code for the cost amount. Currently always `\"USD\"`.",2005 "default": "USD"2006 },2007 {2008 "name": "data[].ending_at",2009 "type": "string or null",2010 "required": true,2011 "description": "End of the row's UTC time bucket (exclusive), as an RFC 3339 timestamp; equal to `starting_at` plus one `bucket_width`. Null unless `bucket_width` is set.",2012 "constraints": {2013 "format": "date-time"2014 }2015 },2016 {2017 "name": "data[].inference_geo",2018 "type": "\"global\" or \"us\" or null",2019 "required": true,2020 "description": "Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches).",2021 "enum": [2022 "global",2023 "us"2024 ]2025 },2026 {2027 "name": "data[].list_amount",2028 "type": "string",2029 "required": true,2030 "description": "List-price amount (pre-discount) in fractional cents."2031 },2032 {2033 "name": "data[].model",2034 "type": "string or null",2035 "required": true,2036 "description": "Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution."2037 },2038 {2039 "name": "data[].product",2040 "type": "string or null",2041 "required": true,2042 "description": "Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, and `claude-tag`. `claude-tag` is Claude Tag, the Claude product in Slack. Some unattributed usage is reported as \"other\"."2043 },2044 {2045 "name": "data[].rbac_group_id",2046 "type": "string or null",2047 "required": true,2048 "description": "RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`."2049 },2050 {2051 "name": "data[].requests",2052 "type": "number or null",2053 "required": true,2054 "description": "Number of API requests in this row's scope. Null when `group_by` includes `cost_type` or `token_type` (the count has no per-component attribution; read it from the ungrouped response). For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`)."2055 },2056 {2057 "name": "data[].slack_channel_id",2058 "type": "string or null",2059 "required": true,2060 "description": "Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled)."2061 },2062 {2063 "name": "data[].speed",2064 "type": "\"fast\" or \"standard\" or null",2065 "required": true,2066 "description": "Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`.",2067 "enum": [2068 "fast",2069 "standard"2070 ]2071 },2072 {2073 "name": "data[].starting_at",2074 "type": "string or null",2075 "required": true,2076 "description": "Start of the row's UTC time bucket (inclusive), as an RFC 3339 timestamp. Null unless `bucket_width` is set; without `bucket_width`, each row aggregates the full requested range.",2077 "constraints": {2078 "format": "date-time"2079 }2080 },2081 {2082 "name": "data[].token_type",2083 "type": "\"cache_creation.ephemeral_1h_input_tokens\" or \"cache_creation.ephemeral_5m_input_tokens\" or \"cache_read_input_tokens\" or 2 more or null",2084 "required": true,2085 "description": "Token type when `cost_type` is `tokens`; null otherwise.",2086 "enum": [2087 "cache_creation.ephemeral_1h_input_tokens",2088 "cache_creation.ephemeral_5m_input_tokens",2089 "cache_read_input_tokens",2090 "output_tokens",2091 "uncached_input_tokens"2092 ]2093 },2094 {2095 "name": "data_refreshed_at",2096 "type": "string or null",2097 "required": true,2098 "description": "RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case `data` is empty. Data beyond this watermark is incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours but not final until about 30 days after the usage date (late-arriving events, reconciliation adjustments).",2099 "constraints": {2100 "format": "date-time"2101 }2102 },2103 {2104 "name": "has_more",2105 "type": "boolean",2106 "required": true,2107 "description": "Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it."2108 },2109 {2110 "name": "next_page",2111 "type": "string or null",2112 "required": true,2113 "description": "Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page."2114 },2115 {2116 "name": "organization_id",2117 "type": "string",2118 "required": true,2119 "description": "ID of the Organization."2120 }2121 ],2122 "example": {2123 "data": [2124 {2125 "actor": {2126 "deleted": true,2127 "email": "jane@example.com",2128 "name": "Jane Smith",2129 "type": "user_actor",2130 "user_id": "user_01AbCdEfGhIjKlMnOpQrSt"2131 },2132 "amount": "41280.000000",2133 "claude_tag_category": "dm",2134 "claude_tag_user_id": "U0123ABCDEF",2135 "context_window": "0-200k",2136 "cost_type": "code_execution",2137 "currency": "USD",2138 "ending_at": "2019-12-27T18:11:19.117Z",2139 "inference_geo": "global",2140 "list_amount": "51600.000000",2141 "model": "claude-opus-5",2142 "product": "chat",2143 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",2144 "requests": 128,2145 "slack_channel_id": "C0123ABCDEF",2146 "speed": "fast",2147 "starting_at": "2019-12-27T18:11:19.117Z",2148 "token_type": "cache_creation.ephemeral_1h_input_tokens"2149 }2150 ],2151 "data_refreshed_at": "2019-12-27T18:11:19.117Z",2152 "has_more": true,2153 "next_page": "next_page",2154 "organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"2155 },2156 "status": [2157 "DOCUMENTED"2158 ],2159 "sources": [2160 {2161 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",2162 "retrieved_at": "2026-09-18"2163 }2164 ]2165 },2166 {2167 "provider": "anthropic",2168 "api_family": "admin",2169 "name": "UserUsage",2170 "official_type_name": "BetaUserUsage",2171 "description": "Response object of GET /v1/organizations/analytics/user_usage_report",2172 "fields": [2173 {2174 "name": "data",2175 "type": "array of object",2176 "required": true,2177 "description": "Rows for this page, ranked by `order_by` in the `order` direction. One row per user, or several per user when `group_by[]` or `bucket_width` breaks that user's usage or cost out across rows. Rows split out by `cost_type` or `token_type` (cost endpoint only) stay adjacent and are ranked as one unit."2178 },2179 {2180 "name": "data[].actor",2181 "type": "BetaAnalyticsUserActor",2182 "required": true,2183 "description": "The user this row's usage or cost is attributed to. Always a `user_actor`."2184 },2185 {2186 "name": "data[].actor.type",2187 "type": "\"user_actor\"",2188 "required": true,2189 "description": "Actor type. Always `\"user_actor\"`."2190 },2191 {2192 "name": "data[].actor.deleted",2193 "type": "boolean",2194 "required": true,2195 "description": "True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation."2196 },2197 {2198 "name": "data[].actor.email",2199 "type": "string or null",2200 "required": true,2201 "description": "The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`)."2202 },2203 {2204 "name": "data[].actor.name",2205 "type": "string or null",2206 "required": true,2207 "description": "The user's full name. Null when the user has not set a name. Returns `\"Deleted User\"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `\"Claude Security\"` for usage by Anthropic's security-patching service) or null."2208 },2209 {2210 "name": "data[].actor.user_id",2211 "type": "string",2212 "required": true,2213 "description": "Tagged user ID."2214 },2215 {2216 "name": "data[].cache_creation",2217 "type": "BetaCacheCreation",2218 "required": true,2219 "description": "The number of input tokens for cache creation."2220 },2221 {2222 "name": "data[].cache_creation.ephemeral_1h_input_tokens",2223 "type": "number",2224 "required": true,2225 "description": "The number of input tokens used to create the 1 hour cache entry.",2226 "default": "0",2227 "minimum": 02228 },2229 {2230 "name": "data[].cache_creation.ephemeral_5m_input_tokens",2231 "type": "number",2232 "required": true,2233 "description": "The number of input tokens used to create the 5 minute cache entry.",2234 "default": "0",2235 "minimum": 02236 },2237 {2238 "name": "data[].cache_read_input_tokens",2239 "type": "number",2240 "required": true,2241 "description": "The number of input tokens read from the cache."2242 },2243 {2244 "name": "data[].claude_tag_category",2245 "type": "\"dm\" or \"engaged\" or \"monitoring\" or 2 more or null",2246 "required": true,2247 "description": "Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.",2248 "enum": [2249 "dm",2250 "engaged",2251 "monitoring",2252 "proactive",2253 "scheduled"2254 ]2255 },2256 {2257 "name": "data[].claude_tag_user_id",2258 "type": "string or null",2259 "required": true,2260 "description": "Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter."2261 },2262 {2263 "name": "data[].context_window",2264 "type": "\"0-200k\" or \"200k-1M\" or null",2265 "required": true,2266 "description": "Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution.",2267 "enum": [2268 "0-200k",2269 "200k-1M"2270 ]2271 },2272 {2273 "name": "data[].ending_at",2274 "type": "string or null",2275 "required": true,2276 "description": "End of the row's UTC time bucket (exclusive), as an RFC 3339 timestamp; equal to `starting_at` plus one `bucket_width`. Null unless `bucket_width` is set.",2277 "constraints": {2278 "format": "date-time"2279 }2280 },2281 {2282 "name": "data[].inference_geo",2283 "type": "\"global\" or \"us\" or null",2284 "required": true,2285 "description": "Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches).",2286 "enum": [2287 "global",2288 "us"2289 ]2290 },2291 {2292 "name": "data[].model",2293 "type": "string or null",2294 "required": true,2295 "description": "Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution."2296 },2297 {2298 "name": "data[].output_tokens",2299 "type": "number",2300 "required": true,2301 "description": "The number of output tokens generated."2302 },2303 {2304 "name": "data[].product",2305 "type": "string or null",2306 "required": true,2307 "description": "Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, and `claude-tag`. `claude-tag` is Claude Tag, the Claude product in Slack. Some unattributed usage is reported as \"other\"."2308 },2309 {2310 "name": "data[].rbac_group_id",2311 "type": "string or null",2312 "required": true,2313 "description": "RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`."2314 },2315 {2316 "name": "data[].requests",2317 "type": "number or null",2318 "required": true,2319 "description": "Number of API requests in this row's scope. For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`)."2320 },2321 {2322 "name": "data[].server_tool_use",2323 "type": "object",2324 "required": true,2325 "description": "Server-side tool usage metrics."2326 },2327 {2328 "name": "data[].server_tool_use.web_search_requests",2329 "type": "number",2330 "required": true,2331 "description": "The number of web search requests made."2332 },2333 {2334 "name": "data[].slack_channel_id",2335 "type": "string or null",2336 "required": true,2337 "description": "Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled)."2338 },2339 {2340 "name": "data[].speed",2341 "type": "\"fast\" or \"standard\" or null",2342 "required": true,2343 "description": "Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`.",2344 "enum": [2345 "fast",2346 "standard"2347 ]2348 },2349 {2350 "name": "data[].starting_at",2351 "type": "string or null",2352 "required": true,2353 "description": "Start of the row's UTC time bucket (inclusive), as an RFC 3339 timestamp. Null unless `bucket_width` is set; without `bucket_width`, each row aggregates the full requested range.",2354 "constraints": {2355 "format": "date-time"2356 }2357 },2358 {2359 "name": "data[].total_tokens",2360 "type": "number",2361 "required": true,2362 "description": "Total token count across all token types. This is the value the default `order_by` (`total_tokens`) sorts on."2363 },2364 {2365 "name": "data[].uncached_input_tokens",2366 "type": "number",2367 "required": true,2368 "description": "The number of uncached input tokens processed."2369 },2370 {2371 "name": "data_refreshed_at",2372 "type": "string or null",2373 "required": true,2374 "description": "RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case `data` is empty. Data beyond this watermark is incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours but not final until about 30 days after the usage date (late-arriving events, reconciliation adjustments).",2375 "constraints": {2376 "format": "date-time"2377 }2378 },2379 {2380 "name": "has_more",2381 "type": "boolean",2382 "required": true,2383 "description": "Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it."2384 },2385 {2386 "name": "next_page",2387 "type": "string or null",2388 "required": true,2389 "description": "Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page."2390 },2391 {2392 "name": "organization_id",2393 "type": "string",2394 "required": true,2395 "description": "ID of the Organization."2396 }2397 ],2398 "example": {2399 "data": [2400 {2401 "actor": {2402 "deleted": true,2403 "email": "jane@example.com",2404 "name": "Jane Smith",2405 "type": "user_actor",2406 "user_id": "user_01AbCdEfGhIjKlMnOpQrSt"2407 },2408 "cache_creation": {2409 "ephemeral_1h_input_tokens": 0,2410 "ephemeral_5m_input_tokens": 02411 },2412 "cache_read_input_tokens": 3200000,2413 "claude_tag_category": "dm",2414 "claude_tag_user_id": "U0123ABCDEF",2415 "context_window": "0-200k",2416 "ending_at": "2019-12-27T18:11:19.117Z",2417 "inference_geo": "global",2418 "model": "claude-opus-5",2419 "output_tokens": 891000,2420 "product": "chat",2421 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",2422 "requests": 128,2423 "server_tool_use": {2424 "web_search_requests": 102425 },2426 "slack_channel_id": "C0123ABCDEF",2427 "speed": "fast",2428 "starting_at": "2019-12-27T18:11:19.117Z",2429 "total_tokens": 5377000,2430 "uncached_input_tokens": 12845002431 }2432 ],2433 "data_refreshed_at": "2019-12-27T18:11:19.117Z",2434 "has_more": true,2435 "next_page": "next_page",2436 "organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF"2437 },2438 "status": [2439 "DOCUMENTED"2440 ],2441 "sources": [2442 {2443 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",2444 "retrieved_at": "2026-09-18"2445 }2446 ]2447 },2448 {2449 "provider": "anthropic",2450 "api_family": "admin",2451 "name": "UserActivity",2452 "official_type_name": "BetaUserActivity",2453 "description": "Response for GET /v1/organizations/analytics/users.",2454 "fields": [2455 {2456 "name": "data",2457 "type": "array of object",2458 "required": true,2459 "description": ""2460 },2461 {2462 "name": "data[].chat_metrics",2463 "type": "object",2464 "required": true,2465 "description": "Claude.ai activity metrics for a single user on a given day."2466 },2467 {2468 "name": "data[].chat_metrics.connectors_used_count",2469 "type": "number",2470 "required": true,2471 "description": "Number of MCP connector invocations."2472 },2473 {2474 "name": "data[].chat_metrics.distinct_artifacts_created_count",2475 "type": "number",2476 "required": true,2477 "description": "Number of distinct artifacts created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it."2478 },2479 {2480 "name": "data[].chat_metrics.distinct_connectors_used_count",2481 "type": "number or null",2482 "required": true,2483 "description": "Distinct claude.ai connectors this user used. Excludes calls whose connector could not be identified and all calls from organizations with zero data retention. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."2484 },2485 {2486 "name": "data[].chat_metrics.distinct_conversation_count",2487 "type": "number or null",2488 "required": true,2489 "description": "Number of distinct conversations the user participated in. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."2490 },2491 {2492 "name": "data[].chat_metrics.distinct_files_uploaded_count",2493 "type": "number or null",2494 "required": true,2495 "description": "Number of distinct files uploaded. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."2496 },2497 {2498 "name": "data[].chat_metrics.distinct_projects_created_count",2499 "type": "number",2500 "required": true,2501 "description": "Number of distinct projects created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it."2502 },2503 {2504 "name": "data[].chat_metrics.distinct_projects_used_count",2505 "type": "number or null",2506 "required": true,2507 "description": "Number of distinct projects used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."2508 },2509 {2510 "name": "data[].chat_metrics.distinct_shared_artifacts_viewed_count",2511 "type": "number or null",2512 "required": true,2513 "description": "Number of distinct shared artifacts the user viewed. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."2514 },2515 {2516 "name": "data[].chat_metrics.distinct_skills_used_count",2517 "type": "number or null",2518 "required": true,2519 "description": "Number of distinct skills used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."2520 },2521 {2522 "name": "data[].chat_metrics.message_count",2523 "type": "number",2524 "required": true,2525 "description": "Number of messages sent"2526 },2527 {2528 "name": "data[].chat_metrics.shared_conversations_viewed_count",2529 "type": "number",2530 "required": true,2531 "description": "Number of times the user opened a shared conversation in a project"2532 },2533 {2534 "name": "data[].chat_metrics.thinking_message_count",2535 "type": "number",2536 "required": true,2537 "description": "Number of messages that used extended thinking"2538 },2539 {2540 "name": "data[].claude_code_metrics",2541 "type": "object",2542 "required": true,2543 "description": "Claude Code activity metrics for a single user on a given day."2544 },2545 {2546 "name": "data[].claude_code_metrics.core_metrics",2547 "type": "object",2548 "required": true,2549 "description": "Core Claude Code activity metrics for a single user on a given day."2550 },2551 {2552 "name": "data[].claude_code_metrics.tool_actions",2553 "type": "object",2554 "required": true,2555 "description": "Per-tool accepted/rejected counts for Claude Code file modification tools."2556 },2557 {2558 "name": "data[].cowork_metrics",2559 "type": "object",2560 "required": true,2561 "description": "Cowork activity metrics for a single user on a given day."2562 },2563 {2564 "name": "data[].cowork_metrics.action_count",2565 "type": "number",2566 "required": true,2567 "description": "Number of tool actions completed in Cowork sessions"2568 },2569 {2570 "name": "data[].cowork_metrics.artifacts_created_count",2571 "type": "number",2572 "required": true,2573 "description": "Number of artifacts created in Cowork sessions: an artifact counts once, on the day a session first saves it. Counted from 2026-08-17; 0 on earlier days. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it."2574 },2575 {2576 "name": "data[].cowork_metrics.connectors_used_count",2577 "type": "number",2578 "required": true,2579 "description": "Total number of connector invocations in Cowork sessions"2580 },2581 {2582 "name": "data[].cowork_metrics.dispatch_turn_count",2583 "type": "number",2584 "required": true,2585 "description": "Number of Dispatch (background agent) turns completed"2586 },2587 {2588 "name": "data[].cowork_metrics.distinct_connectors_used_count",2589 "type": "number or null",2590 "required": true,2591 "description": "Number of distinct connectors used in Cowork sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."2592 },2593 {2594 "name": "data[].cowork_metrics.distinct_session_count",2595 "type": "number or null",2596 "required": true,2597 "description": "Number of distinct Cowork sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."2598 },2599 {2600 "name": "data[].cowork_metrics.distinct_skills_used_count",2601 "type": "number or null",2602 "required": true,2603 "description": "Number of distinct skills used in Cowork sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."2604 },2605 {2606 "name": "data[].cowork_metrics.message_count",2607 "type": "number",2608 "required": true,2609 "description": "Number of messages sent in Cowork sessions"2610 },2611 {2612 "name": "data[].cowork_metrics.skills_used_count",2613 "type": "number",2614 "required": true,2615 "description": "Total number of skill invocations in Cowork sessions"2616 },2617 {2618 "name": "data[].cowork_metrics.distinct_plugins_used_count",2619 "type": "number or null",2620 "required": false,2621 "description": "Number of distinct plugins used in Cowork sessions. Null while Cowork plugin-use metrics are not enabled for this organization. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."2622 },2623 {2624 "name": "data[].cowork_metrics.edit_tool_count",2625 "type": "number or null",2626 "required": false,2627 "description": "Number of successful Edit tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization."2628 },2629 {2630 "name": "data[].cowork_metrics.file_edit_count",2631 "type": "number or null",2632 "required": false,2633 "description": "Number of successful file-edit tool calls (Edit, MultiEdit, Write, NotebookEdit) in Cowork sessions. Null, never 0, while the file-edit metrics are not enabled for this organization."2634 },2635 {2636 "name": "data[].cowork_metrics.multi_edit_tool_count",2637 "type": "number or null",2638 "required": false,2639 "description": "Number of successful MultiEdit tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization."2640 },2641 {2642 "name": "data[].cowork_metrics.notebook_edit_tool_count",2643 "type": "number or null",2644 "required": false,2645 "description": "Number of successful NotebookEdit tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization."2646 },2647 {2648 "name": "data[].cowork_metrics.plugins_used_count",2649 "type": "number or null",2650 "required": false,2651 "description": "Total number of plugin invocations in Cowork sessions. Null while Cowork plugin-use metrics are not enabled for this organization."2652 },2653 {2654 "name": "data[].cowork_metrics.sessions_with_file_edits_count",2655 "type": "number or null",2656 "required": false,2657 "description": "Number of distinct Cowork sessions with at least one successful file-edit tool call. Null while the file-edit metrics are not enabled for this organization. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."2658 },2659 {2660 "name": "data[].cowork_metrics.write_tool_count",2661 "type": "number or null",2662 "required": false,2663 "description": "Number of successful Write tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization."2664 },2665 {2666 "name": "data[].design_metrics",2667 "type": "object",2668 "required": true,2669 "description": "Claude Design activity metrics for a single user on a given day."2670 },2671 {2672 "name": "data[].design_metrics.distinct_projects_created_count",2673 "type": "number",2674 "required": true,2675 "description": "Number of distinct Claude Design projects created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it."2676 },2677 {2678 "name": "data[].design_metrics.distinct_projects_used_count",2679 "type": "number or null",2680 "required": true,2681 "description": "Number of distinct Claude Design projects the user worked in. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."2682 },2683 {2684 "name": "data[].design_metrics.distinct_session_count",2685 "type": "number or null",2686 "required": true,2687 "description": "Number of distinct Claude Design sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."2688 },2689 {2690 "name": "data[].design_metrics.message_count",2691 "type": "number",2692 "required": true,2693 "description": "Number of messages sent in Claude Design sessions"2694 },2695 {2696 "name": "data[].office_metrics",2697 "type": "object",2698 "required": true,2699 "description": "Office Agent activity metrics for a single user on a given day, broken out by Office product."2700 },2701 {2702 "name": "data[].office_metrics.excel",2703 "type": "BetaOfficeProductMetrics",2704 "required": true,2705 "description": "Office Agent activity metrics for a single user on a given day within one Office product."2706 },2707 {2708 "name": "data[].office_metrics.outlook",2709 "type": "BetaOfficeProductMetrics",2710 "required": true,2711 "description": "Office Agent activity metrics for a single user on a given day within one Office product."2712 },2713 {2714 "name": "data[].office_metrics.powerpoint",2715 "type": "BetaOfficeProductMetrics",2716 "required": true,2717 "description": "Office Agent activity metrics for a single user on a given day within one Office product."2718 },2719 {2720 "name": "data[].office_metrics.word",2721 "type": "BetaOfficeProductMetrics",2722 "required": true,2723 "description": "Office Agent activity metrics for a single user on a given day within one Office product."2724 },2725 {2726 "name": "data[].science_metrics",2727 "type": "object",2728 "required": true,2729 "description": "Claude Science activity metrics for a single user on a given day."2730 },2731 {2732 "name": "data[].science_metrics.delegation_count",2733 "type": "number",2734 "required": true,2735 "description": "Number of delegations (handoffs to a specialized agent) in Claude Science sessions"2736 },2737 {2738 "name": "data[].science_metrics.distinct_session_count",2739 "type": "number or null",2740 "required": true,2741 "description": "Number of distinct Claude Science sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."2742 },2743 {2744 "name": "data[].science_metrics.message_count",2745 "type": "number",2746 "required": true,2747 "description": "Number of messages sent in Claude Science sessions"2748 },2749 {2750 "name": "data[].science_metrics.remote_compute_job_count",2751 "type": "number",2752 "required": true,2753 "description": "Number of remote compute jobs launched from Claude Science sessions"2754 },2755 {2756 "name": "data[].science_metrics.skills_used_count",2757 "type": "number",2758 "required": true,2759 "description": "Total number of skill invocations in Claude Science sessions"2760 },2761 {2762 "name": "data[].web_search_count",2763 "type": "number",2764 "required": true,2765 "description": "Number of web searches performed"2766 },2767 {2768 "name": "data[].distinct_user_count",2769 "type": "number or null",2770 "required": false,2771 "description": "Number of distinct active users represented by this row. Only set for grouped rollups (`group_by[]`); null for per-user rows. In date-range mode, recomputed as an exact distinct count of the group's active members over the requested window, never a sum of per-day values."2772 },2773 {2774 "name": "data[].last_activity_date",2775 "type": "string or null",2776 "required": false,2777 "description": "Most recent UTC day (YYYY-MM-DD) on which the user had any counted activity, within the requested window: equal to the requested `date` in single-day mode, and to the latest active day from `starting_date` (inclusive) to `ending_date` (exclusive) in date-range rollup mode — never a day earlier than the window start. On filtered requests (`filter[]`) only days matching the filter count: with `filter[]=rbac_group_id:{id}` it is the last day the user was active while a member of that group, consistent with the row's other metrics. On grouped (`group_by[]`) rows it is the latest day any member of the group was active (the requested `date` in single-day mode). Omitted from the response while last-activity reporting is not enabled for this organization.",2778 "constraints": {2779 "format": "date"2780 }2781 },2782 {2783 "name": "data[].rbac_group_id",2784 "type": "string or null",2785 "required": false,2786 "description": "Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`."2787 },2788 {2789 "name": "data[].rbac_group_name",2790 "type": "string or null",2791 "required": false,2792 "description": "Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key."2793 },2794 {2795 "name": "data[].user",2796 "type": "BetaAnalyticsUser or null",2797 "required": false,2798 "description": "A user in the organization, identified by tagged id and email address."2799 },2800 {2801 "name": "data[].user.type",2802 "type": "\"user\"",2803 "required": true,2804 "description": "Object type. Always `user`.",2805 "default": "user"2806 },2807 {2808 "name": "data[].user.id",2809 "type": "string",2810 "required": true,2811 "description": "Tagged user identifier (e.g. `user_...`)"2812 },2813 {2814 "name": "data[].user.email_address",2815 "type": "string",2816 "required": true,2817 "description": "Email address of the user"2818 },2819 {2820 "name": "next_page",2821 "type": "string or null",2822 "required": true,2823 "description": "Opaque cursor for the next page, or null if no more results"2824 }2825 ],2826 "example": {2827 "data": [2828 {2829 "chat_metrics": {2830 "connectors_used_count": 0,2831 "distinct_artifacts_created_count": 0,2832 "distinct_connectors_used_count": 0,2833 "distinct_conversation_count": 0,2834 "distinct_files_uploaded_count": 0,2835 "distinct_projects_created_count": 0,2836 "distinct_projects_used_count": 0,2837 "distinct_shared_artifacts_viewed_count": 0,2838 "distinct_skills_used_count": 0,2839 "message_count": 0,2840 "shared_conversations_viewed_count": 0,2841 "thinking_message_count": 02842 },2843 "claude_code_metrics": {2844 "core_metrics": {2845 "artifacts_created_count": 0,2846 "commit_count": 0,2847 "distinct_session_count": 0,2848 "lines_of_code": {2849 "added_count": 0,2850 "removed_count": 02851 },2852 "pull_request_count": 02853 },2854 "tool_actions": {2855 "edit_tool": {2856 "accepted_count": 0,2857 "rejected_count": 02858 },2859 "multi_edit_tool": {2860 "accepted_count": 0,2861 "rejected_count": 02862 },2863 "notebook_edit_tool": {2864 "accepted_count": 0,2865 "rejected_count": 02866 },2867 "write_tool": {2868 "accepted_count": 0,2869 "rejected_count": 02870 }2871 }2872 },2873 "cowork_metrics": {2874 "action_count": 0,2875 "artifacts_created_count": 0,2876 "connectors_used_count": 0,2877 "dispatch_turn_count": 0,2878 "distinct_connectors_used_count": 0,2879 "distinct_session_count": 0,2880 "distinct_skills_used_count": 0,2881 "message_count": 0,2882 "skills_used_count": 0,2883 "distinct_plugins_used_count": 0,2884 "edit_tool_count": 0,2885 "file_edit_count": 0,2886 "multi_edit_tool_count": 0,2887 "notebook_edit_tool_count": 0,2888 "plugins_used_count": 0,2889 "sessions_with_file_edits_count": 0,2890 "write_tool_count": 02891 },2892 "design_metrics": {2893 "distinct_projects_created_count": 0,2894 "distinct_projects_used_count": 0,2895 "distinct_session_count": 0,2896 "message_count": 02897 },2898 "office_metrics": {2899 "excel": {2900 "connectors_used_count": 0,2901 "distinct_connectors_used_count": 0,2902 "distinct_session_count": 0,2903 "distinct_skills_used_count": 0,2904 "message_count": 0,2905 "skills_used_count": 02906 },2907 "outlook": {2908 "connectors_used_count": 0,2909 "distinct_connectors_used_count": 0,2910 "distinct_session_count": 0,2911 "distinct_skills_used_count": 0,2912 "message_count": 0,2913 "skills_used_count": 02914 },2915 "powerpoint": {2916 "connectors_used_count": 0,2917 "distinct_connectors_used_count": 0,2918 "distinct_session_count": 0,2919 "distinct_skills_used_count": 0,2920 "message_count": 0,2921 "skills_used_count": 02922 },2923 "word": {2924 "connectors_used_count": 0,2925 "distinct_connectors_used_count": 0,2926 "distinct_session_count": 0,2927 "distinct_skills_used_count": 0,2928 "message_count": 0,2929 "skills_used_count": 02930 }2931 },2932 "science_metrics": {2933 "delegation_count": 0,2934 "distinct_session_count": 0,2935 "message_count": 0,2936 "remote_compute_job_count": 0,2937 "skills_used_count": 02938 },2939 "web_search_count": 0,2940 "distinct_user_count": 0,2941 "last_activity_date": "2019-12-27",2942 "rbac_group_id": "rbac_group_id",2943 "rbac_group_name": "rbac_group_name",2944 "user": {2945 "id": "id",2946 "email_address": "email_address",2947 "type": "user"2948 }2949 }2950 ],2951 "next_page": "next_page"2952 },2953 "status": [2954 "DOCUMENTED"2955 ],2956 "sources": [2957 {2958 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/users/list",2959 "retrieved_at": "2026-09-18"2960 },2961 {2962 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics/users",2963 "retrieved_at": "2026-09-18"2964 }2965 ]2966 },2967 {2968 "provider": "anthropic",2969 "api_family": "admin",2970 "name": "APIKey",2971 "official_type_name": "BetaAPIKey",2972 "description": "Response object of GET /v1/organizations/api_keys/{api_key_id}",2973 "fields": [2974 {2975 "name": "type",2976 "type": "\"api_key\"",2977 "required": true,2978 "description": "Object type. For API Keys, this is always `\"api_key\"`.",2979 "default": "api_key"2980 },2981 {2982 "name": "id",2983 "type": "string",2984 "required": true,2985 "description": "ID of the API key."2986 },2987 {2988 "name": "created_at",2989 "type": "string",2990 "required": true,2991 "description": "RFC 3339 datetime string indicating when the API Key was created.",2992 "constraints": {2993 "format": "date-time"2994 }2995 },2996 {2997 "name": "created_by",2998 "type": "BetaAPIKeyCreatedBy or null",2999 "required": true,3000 "description": "The ID and type of the actor that created the API key, or `null` when the creator is not recorded (legacy, workload-identity-federated, or system-created keys)."3001 },3002 {3003 "name": "created_by.type",3004 "type": "\"service_account\" or \"user\"",3005 "required": true,3006 "description": "Type of the actor that created the object.",3007 "enum": [3008 "service_account",3009 "user"3010 ]3011 },3012 {3013 "name": "created_by.id",3014 "type": "string",3015 "required": true,3016 "description": "ID of the actor that created the object."3017 },3018 {3019 "name": "expires_at",3020 "type": "string or null",3021 "required": true,3022 "description": "RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires.",3023 "constraints": {3024 "format": "date-time"3025 }3026 },3027 {3028 "name": "name",3029 "type": "string",3030 "required": true,3031 "description": "Name of the API key."3032 },3033 {3034 "name": "partial_key_hint",3035 "type": "string or null",3036 "required": true,3037 "description": "Partially redacted hint for the API key."3038 },3039 {3040 "name": "principal",3041 "type": "BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null",3042 "required": true,3043 "description": "The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal."3044 },3045 {3046 "name": "principal.type",3047 "type": "\"user_actor\"",3048 "required": true,3049 "description": "Principal type. Always `\"user_actor\"` for a User.",3050 "default": "user_actor"3051 },3052 {3053 "name": "principal.user_id",3054 "type": "string",3055 "required": true,3056 "description": "ID of the User the API key acts as."3057 },3058 {3059 "name": "principal.type",3060 "type": "\"service_account_actor\"",3061 "required": true,3062 "description": "Principal type. Always `\"service_account_actor\"` for a Service Account.",3063 "default": "service_account_actor"3064 },3065 {3066 "name": "principal.service_account_id",3067 "type": "string",3068 "required": true,3069 "description": "ID of the Service Account the API key acts as."3070 },3071 {3072 "name": "scope",3073 "type": "BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope",3074 "required": true,3075 "description": "Where the API key belongs: its Workspace (`{\"type\": \"workspace\", \"workspace_id\": \"wrkspc_...\"}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{\"type\": \"organization\"}`) for a principal-bound API key that has no Workspace."3076 },3077 {3078 "name": "scope.type",3079 "type": "\"organization\"",3080 "required": true,3081 "description": "Scope type. Always `\"organization\"`: the API key has no Workspace. Only a principal-bound API key can have this scope.",3082 "default": "organization"3083 },3084 {3085 "name": "scope.type",3086 "type": "\"workspace\"",3087 "required": true,3088 "description": "Scope type. Always `\"workspace\"`: the API key belongs to one Workspace.",3089 "default": "workspace"3090 },3091 {3092 "name": "scope.workspace_id",3093 "type": "string",3094 "required": true,3095 "description": "ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace."3096 },3097 {3098 "name": "status",3099 "type": "\"active\" or \"archived\" or \"expired\" or \"inactive\"",3100 "required": true,3101 "description": "Status of the API key.",3102 "enum": [3103 "active",3104 "archived",3105 "expired",3106 "inactive"3107 ]3108 },3109 {3110 "name": "workspace_id",3111 "type": "string or null",3112 "required": true,3113 "description": "**Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart."3114 }3115 ],3116 "example": {3117 "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",3118 "created_at": "2024-10-30T23:58:27.427722Z",3119 "created_by": {3120 "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",3121 "type": "user"3122 },3123 "expires_at": "2024-10-30T23:58:27.427722Z",3124 "name": "Developer Key",3125 "partial_key_hint": "sk-ant-api03-R2D...igAA",3126 "principal": {3127 "type": "user_actor",3128 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"3129 },3130 "scope": {3131 "type": "workspace",3132 "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"3133 },3134 "status": "active",3135 "type": "api_key",3136 "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"3137 },3138 "status": [3139 "DOCUMENTED"3140 ],3141 "sources": [3142 {3143 "url": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/retrieve",3144 "retrieved_at": "2026-09-18"3145 }3146 ]3147 },3148 {3149 "provider": "anthropic",3150 "api_family": "admin",3151 "name": "ComplianceSettings",3152 "official_type_name": "BetaComplianceSettings",3153 "description": "Response object of GET /v1/organizations/compliance_settings",3154 "fields": [3155 {3156 "name": "type",3157 "type": "\"compliance_settings\"",3158 "required": true,3159 "description": "",3160 "default": "compliance_settings"3161 },3162 {3163 "name": "state",3164 "type": "BetaComplianceSettingsState",3165 "required": true,3166 "description": "Whether the Compliance API is enabled for this organization."3167 },3168 {3169 "name": "state.type",3170 "type": "\"enabled\"",3171 "required": true,3172 "description": "",3173 "default": "enabled"3174 },3175 {3176 "name": "state.type",3177 "type": "\"disabled\"",3178 "required": true,3179 "description": "",3180 "default": "disabled"3181 }3182 ],3183 "example": {3184 "state": {3185 "type": "enabled"3186 },3187 "type": "compliance_settings"3188 },3189 "status": [3190 "DOCUMENTED"3191 ],3192 "sources": [3193 {3194 "url": "https://platform.claude.com/docs/en/api/beta/organization/compliance_settings/retrieve",3195 "retrieved_at": "2026-09-18"3196 },3197 {3198 "url": "https://platform.claude.com/docs/en/api/beta/organization/compliance_settings",3199 "retrieved_at": "2026-09-18"3200 }3201 ]3202 },3203 {3204 "provider": "anthropic",3205 "api_family": "admin",3206 "name": "CostReport",3207 "official_type_name": "BetaCostReport",3208 "description": "Response object of GET /v1/organizations/cost_report",3209 "fields": [3210 {3211 "name": "data",3212 "type": "array of object",3213 "required": true,3214 "description": "List of time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no costs (their `results` list is empty). A page holds at most `limit` buckets."3215 },3216 {3217 "name": "data[].ending_at",3218 "type": "string",3219 "required": true,3220 "description": "End of the time bucket (exclusive) in RFC 3339 format.",3221 "constraints": {3222 "format": "date-time"3223 }3224 },3225 {3226 "name": "data[].results",3227 "type": "array of object",3228 "required": true,3229 "description": "List of cost items for this time bucket. There may be multiple items if one or more `group_by[]` parameters are specified."3230 },3231 {3232 "name": "data[].results[].amount",3233 "type": "string",3234 "required": true,3235 "description": "Cost amount in lowest currency units (e.g. cents) as a decimal string. For example, `\"123.45\"` in `\"USD\"` represents `$1.23`."3236 },3237 {3238 "name": "data[].results[].context_window",3239 "type": "\"0-200k\" or \"200k-1M\" or null",3240 "required": true,3241 "description": "Input context window used. `null` if not grouping by description or for non-token costs.",3242 "enum": [3243 "0-200k",3244 "200k-1M"3245 ]3246 },3247 {3248 "name": "data[].results[].cost_type",3249 "type": "\"code_execution\" or \"session_usage\" or \"tokens\" or \"web_search\" or null",3250 "required": true,3251 "description": "Type of cost. `null` if not grouping by description.",3252 "enum": [3253 "code_execution",3254 "session_usage",3255 "tokens",3256 "web_search"3257 ]3258 },3259 {3260 "name": "data[].results[].currency",3261 "type": "string",3262 "required": true,3263 "description": "Currency code for the cost amount. Currently always `\"USD\"`."3264 },3265 {3266 "name": "data[].results[].description",3267 "type": "string or null",3268 "required": true,3269 "description": "Description of the cost item. `null` if not grouping by description."3270 },3271 {3272 "name": "data[].results[].inference_geo",3273 "type": "\"global\" or \"not_available\" or \"us\" or null",3274 "required": true,3275 "description": "Inference geo used matching requests' `inference_geo` parameter if set, otherwise the workspace's `default_inference_geo`. For models that do not support specifying `inference_geo` the value is `\"not_available\"`. Always `null` if not grouping by inference geo.",3276 "enum": [3277 "global",3278 "not_available",3279 "us"3280 ]3281 },3282 {3283 "name": "data[].results[].model",3284 "type": "string or null",3285 "required": true,3286 "description": "Model name used. `null` if not grouping by description or for non-token costs."3287 },3288 {3289 "name": "data[].results[].service_tier",3290 "type": "\"batch\" or \"standard\" or null",3291 "required": true,3292 "description": "Service tier used. `null` if not grouping by description or for non-token costs.",3293 "enum": [3294 "batch",3295 "standard"3296 ]3297 },3298 {3299 "name": "data[].results[].token_type",3300 "type": "\"cache_creation.ephemeral_1h_input_tokens\" or \"cache_creation.ephemeral_5m_input_tokens\" or \"cache_read_input_tokens\" or 2 more or null",3301 "required": true,3302 "description": "Type of token. `null` if not grouping by description or for non-token costs.",3303 "enum": [3304 "cache_creation.ephemeral_1h_input_tokens",3305 "cache_creation.ephemeral_5m_input_tokens",3306 "cache_read_input_tokens",3307 "output_tokens",3308 "uncached_input_tokens"3309 ]3310 },3311 {3312 "name": "data[].results[].workspace_id",3313 "type": "string or null",3314 "required": true,3315 "description": "ID of the Workspace this cost is associated with. `null` if not grouping by workspace or for the default workspace."3316 },3317 {3318 "name": "data[].starting_at",3319 "type": "string",3320 "required": true,3321 "description": "Start of the time bucket (inclusive) in RFC 3339 format.",3322 "constraints": {3323 "format": "date-time"3324 }3325 },3326 {3327 "name": "has_more",3328 "type": "boolean",3329 "required": true,3330 "description": "Indicates if there are more results."3331 },3332 {3333 "name": "next_page",3334 "type": "string or null",3335 "required": true,3336 "description": "Opaque cursor for the next page, or `null` when `has_more` is false. Pass it as the `page` parameter in the next request."3337 }3338 ],3339 "example": {3340 "data": [3341 {3342 "ending_at": "2025-08-02T00:00:00Z",3343 "results": [3344 {3345 "amount": "123.78912",3346 "context_window": "0-200k",3347 "cost_type": "tokens",3348 "currency": "USD",3349 "description": "Claude Opus 5 Usage - Input Tokens",3350 "inference_geo": "global",3351 "model": "claude-opus-5",3352 "service_tier": "standard",3353 "token_type": "uncached_input_tokens",3354 "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"3355 }3356 ],3357 "starting_at": "2025-08-01T00:00:00Z"3358 }3359 ],3360 "has_more": true,3361 "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="3362 },3363 "status": [3364 "DOCUMENTED"3365 ],3366 "sources": [3367 {3368 "url": "https://platform.claude.com/docs/en/api/beta/organization/cost_report/retrieve",3369 "retrieved_at": "2026-09-18"3370 },3371 {3372 "url": "https://platform.claude.com/docs/en/api/beta/organization/cost_report",3373 "retrieved_at": "2026-09-18"3374 }3375 ]3376 },3377 {3378 "provider": "anthropic",3379 "api_family": "admin",3380 "name": "ExternalKey",3381 "official_type_name": "BetaExternalKey",3382 "description": "CMEK external key config belonging to the caller's organization. Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt).",3383 "fields": [3384 {3385 "name": "type",3386 "type": "\"external_key\"",3387 "required": true,3388 "description": "",3389 "default": "external_key"3390 },3391 {3392 "name": "id",3393 "type": "string",3394 "required": true,3395 "description": "Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN."3396 },3397 {3398 "name": "attachment",3399 "type": "BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment",3400 "required": true,3401 "description": "Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted."3402 },3403 {3404 "name": "attachment.type",3405 "type": "\"attached\"",3406 "required": true,3407 "description": "",3408 "default": "attached"3409 },3410 {3411 "name": "attachment.type",3412 "type": "\"unattached\"",3413 "required": true,3414 "description": "",3415 "default": "unattached"3416 },3417 {3418 "name": "created_at",3419 "type": "string",3420 "required": true,3421 "description": "",3422 "constraints": {3423 "format": "date-time"3424 }3425 },3426 {3427 "name": "display_name",3428 "type": "string or null",3429 "required": true,3430 "description": "Human-friendly display name. Null if none was set."3431 },3432 {3433 "name": "geo",3434 "type": "string",3435 "required": true,3436 "description": "Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips."3437 },3438 {3439 "name": "provider_config",3440 "type": "BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig",3441 "required": true,3442 "description": "KMS provider identity and auth coordinates."3443 },3444 {3445 "name": "provider_config.type",3446 "type": "\"aws\"",3447 "required": true,3448 "description": ""3449 },3450 {3451 "name": "provider_config.kms_arn",3452 "type": "string",3453 "required": true,3454 "description": "Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.",3455 "constraints": {3456 "maxLength": "2048"3457 }3458 },3459 {3460 "name": "provider_config.region",3461 "type": "string or null",3462 "required": false,3463 "description": "AWS region. Derived from `kms_arn` if omitted."3464 },3465 {3466 "name": "provider_config.role_arn",3467 "type": "string or null",3468 "required": false,3469 "description": "**Deprecated** IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored."3470 },3471 {3472 "name": "provider_config.type",3473 "type": "\"gcp\"",3474 "required": true,3475 "description": ""3476 },3477 {3478 "name": "provider_config.key_name",3479 "type": "string",3480 "required": true,3481 "description": "Full resource name of the Cloud KMS key."3482 },3483 {3484 "name": "provider_config.type",3485 "type": "\"azure\"",3486 "required": true,3487 "description": ""3488 },3489 {3490 "name": "provider_config.key_name",3491 "type": "string",3492 "required": true,3493 "description": "Name of the key within the vault."3494 },3495 {3496 "name": "provider_config.tenant_id",3497 "type": "string",3498 "required": true,3499 "description": "Azure AD tenant ID."3500 },3501 {3502 "name": "provider_config.vault_uri",3503 "type": "string",3504 "required": true,3505 "description": "Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`."3506 },3507 {3508 "name": "provider_config.client_id",3509 "type": "string or null",3510 "required": false,3511 "description": "Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory."3512 },3513 {3514 "name": "updated_at",3515 "type": "string",3516 "required": true,3517 "description": "",3518 "constraints": {3519 "format": "date-time"3520 }3521 }3522 ],3523 "example": {3524 "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",3525 "attachment": {3526 "type": "attached"3527 },3528 "created_at": "2024-10-30T23:58:27.427722Z",3529 "display_name": "prod-us-key",3530 "geo": "us",3531 "provider_config": {3532 "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",3533 "type": "aws",3534 "region": "us-east-1",3535 "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"3536 },3537 "type": "external_key",3538 "updated_at": "2024-10-30T23:58:27.427722Z"3539 },3540 "status": [3541 "DOCUMENTED"3542 ],3543 "sources": [3544 {3545 "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create",3546 "retrieved_at": "2026-09-18"3547 },3548 {3549 "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys",3550 "retrieved_at": "2026-09-18"3551 }3552 ]3553 },3554 {3555 "provider": "anthropic",3556 "api_family": "admin",3557 "name": "FederationIssuer",3558 "official_type_name": "BetaFederationIssuer",3559 "description": "Registered external OIDC identity provider. Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly.",3560 "fields": [3561 {3562 "name": "type",3563 "type": "\"federation_issuer\"",3564 "required": true,3565 "description": "",3566 "default": "federation_issuer"3567 },3568 {3569 "name": "id",3570 "type": "string",3571 "required": true,3572 "description": "Tagged ID of the federation issuer."3573 },3574 {3575 "name": "archived_at",3576 "type": "string or null",3577 "required": true,3578 "description": "If set, all rules referencing this issuer reject token exchange.",3579 "constraints": {3580 "format": "date-time"3581 }3582 },3583 {3584 "name": "archived_by_actor_id",3585 "type": "string or null",3586 "required": true,3587 "description": "Tagged ID (`user_`/`svac_`) of the actor that archived this issuer."3588 },3589 {3590 "name": "check_jti",3591 "type": "boolean",3592 "required": true,3593 "description": "Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement."3594 },3595 {3596 "name": "created_at",3597 "type": "string",3598 "required": true,3599 "description": "When this issuer was created.",3600 "constraints": {3601 "format": "date-time"3602 }3603 },3604 {3605 "name": "created_by_actor_id",3606 "type": "string or null",3607 "required": true,3608 "description": "Tagged ID (`user_`/`svac_`) of the actor that created this issuer."3609 },3610 {3611 "name": "issuer_url",3612 "type": "string",3613 "required": true,3614 "description": "The `iss` claim value. Incoming JWTs must match exactly."3615 },3616 {3617 "name": "jwks",3618 "type": "BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline",3619 "required": true,3620 "description": "How signing keys are obtained for signature verification."3621 },3622 {3623 "name": "jwks.type",3624 "type": "\"discovery\"",3625 "required": true,3626 "description": ""3627 },3628 {3629 "name": "jwks.ca_cert_pem",3630 "type": "string or null",3631 "required": false,3632 "description": "Optional custom CA (PEM) for TLS verification of the JWKS fetch.",3633 "constraints": {3634 "maxLength": "8192"3635 }3636 },3637 {3638 "name": "jwks.discovery_base",3639 "type": "string or null",3640 "required": false,3641 "description": "Set when the discovery URL differs from `issuer_url`."3642 },3643 {3644 "name": "jwks.type",3645 "type": "\"explicit_url\"",3646 "required": true,3647 "description": ""3648 },3649 {3650 "name": "jwks.url",3651 "type": "string",3652 "required": true,3653 "description": "JWKS endpoint.",3654 "constraints": {3655 "minLength": "1"3656 }3657 },3658 {3659 "name": "jwks.ca_cert_pem",3660 "type": "string or null",3661 "required": false,3662 "description": "Optional custom CA (PEM) for TLS verification of the JWKS fetch.",3663 "constraints": {3664 "maxLength": "8192"3665 }3666 },3667 {3668 "name": "jwks.type",3669 "type": "\"inline\"",3670 "required": true,3671 "description": ""3672 },3673 {3674 "name": "jwks.keys",3675 "type": "array of map[unknown]",3676 "required": true,3677 "description": "Inline JWK objects.",3678 "constraints": {3679 "minItems": "1"3680 }3681 },3682 {3683 "name": "jwks_polling_disabled_at",3684 "type": "string or null",3685 "required": true,3686 "description": "If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session.",3687 "constraints": {3688 "format": "date-time"3689 }3690 },3691 {3692 "name": "max_jwt_lifetime_seconds",3693 "type": "number",3694 "required": true,3695 "description": "Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected."3696 },3697 {3698 "name": "name",3699 "type": "string",3700 "required": true,3701 "description": "Admin-chosen slug identifier."3702 },3703 {3704 "name": "poll_status",3705 "type": "BetaFederationIssuerPollStatus or null",3706 "required": true,3707 "description": "Status of automatic JWKS polling for a federation issuer. Anthropic periodically fetches the issuer's signing keys in the background. These fields summarize the most recent fetches so the health of the JWKS endpoint can be monitored."3708 },3709 {3710 "name": "poll_status.consecutive_failures",3711 "type": "number",3712 "required": true,3713 "description": "Consecutive fetch failures since the last success."3714 },3715 {3716 "name": "poll_status.last_fetched_at",3717 "type": "string or null",3718 "required": true,3719 "description": "When the last successful fetch completed.",3720 "constraints": {3721 "format": "date-time"3722 }3723 },3724 {3725 "name": "poll_status.next_poll_at",3726 "type": "string or null",3727 "required": true,3728 "description": "When the next fetch is scheduled. Null if paused.",3729 "constraints": {3730 "format": "date-time"3731 }3732 },3733 {3734 "name": "updated_at",3735 "type": "string",3736 "required": true,3737 "description": "When this issuer was last updated.",3738 "constraints": {3739 "format": "date-time"3740 }3741 },3742 {3743 "name": "updated_by_actor_id",3744 "type": "string or null",3745 "required": true,3746 "description": "Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer."3747 }3748 ],3749 "example": {3750 "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK",3751 "archived_at": "2019-12-27T18:11:19.117Z",3752 "archived_by_actor_id": "archived_by_actor_id",3753 "check_jti": true,3754 "created_at": "2024-10-30T23:58:27.427722Z",3755 "created_by_actor_id": "created_by_actor_id",3756 "issuer_url": "https://token.actions.githubusercontent.com",3757 "jwks": {3758 "type": "discovery",3759 "ca_cert_pem": "ca_cert_pem",3760 "discovery_base": "discovery_base"3761 },3762 "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z",3763 "max_jwt_lifetime_seconds": 0,3764 "name": "github-actions",3765 "poll_status": {3766 "consecutive_failures": 0,3767 "last_fetched_at": "2019-12-27T18:11:19.117Z",3768 "next_poll_at": "2019-12-27T18:11:19.117Z"3769 },3770 "type": "federation_issuer",3771 "updated_at": "2024-10-30T23:58:27.427722Z",3772 "updated_by_actor_id": "updated_by_actor_id"3773 },3774 "status": [3775 "DOCUMENTED"3776 ],3777 "sources": [3778 {3779 "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create",3780 "retrieved_at": "2026-09-18"3781 },3782 {3783 "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers",3784 "retrieved_at": "2026-09-18"3785 },3786 {3787 "url": "https://platform.claude.com/docs/en/api/beta/organization/federation",3788 "retrieved_at": "2026-09-18"3789 }3790 ]3791 },3792 {3793 "provider": "anthropic",3794 "api_family": "admin",3795 "name": "FederationRule",3796 "official_type_name": "BetaFederationRule",3797 "description": "Authorization rule binding an external OIDC identity to Anthropic. Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this.",3798 "fields": [3799 {3800 "name": "type",3801 "type": "\"federation_rule\"",3802 "required": true,3803 "description": "",3804 "default": "federation_rule"3805 },3806 {3807 "name": "id",3808 "type": "string",3809 "required": true,3810 "description": "Tagged ID of the federation rule."3811 },3812 {3813 "name": "applies_to_all_workspaces",3814 "type": "boolean",3815 "required": true,3816 "description": "When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time."3817 },3818 {3819 "name": "archived_at",3820 "type": "string or null",3821 "required": true,3822 "description": "If set, this rule is archived and rejects token exchange.",3823 "constraints": {3824 "format": "date-time"3825 }3826 },3827 {3828 "name": "archived_by_actor_id",3829 "type": "string or null",3830 "required": true,3831 "description": "Tagged ID (`user_`/`svac_`) of the actor that archived this rule."3832 },3833 {3834 "name": "attributes",3835 "type": "map[string] or null",3836 "required": true,3837 "description": "CEL expressions extracting named values from claims. Not yet supported; always null."3838 },3839 {3840 "name": "created_at",3841 "type": "string",3842 "required": true,3843 "description": "When this rule was created.",3844 "constraints": {3845 "format": "date-time"3846 }3847 },3848 {3849 "name": "created_by_actor_id",3850 "type": "string or null",3851 "required": true,3852 "description": "Tagged ID (`user_`/`svac_`) of the actor that created this rule."3853 },3854 {3855 "name": "description",3856 "type": "string or null",3857 "required": true,3858 "description": "Optional free-text description."3859 },3860 {3861 "name": "issuer_id",3862 "type": "string",3863 "required": true,3864 "description": "Tagged ID of the issuer whose tokens this rule accepts."3865 },3866 {3867 "name": "issuer_name",3868 "type": "string or null",3869 "required": true,3870 "description": "Issuer's display name at read time."3871 },3872 {3873 "name": "match",3874 "type": "BetaFederationRuleMatch",3875 "required": true,3876 "description": "Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass."3877 },3878 {3879 "name": "match.audience",3880 "type": "string or null",3881 "required": false,3882 "description": "Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default.",3883 "constraints": {3884 "maxLength": "1024"3885 }3886 },3887 {3888 "name": "match.claims",3889 "type": "map[string] or null",3890 "required": false,3891 "description": "Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims."3892 },3893 {3894 "name": "match.condition",3895 "type": "string or null",3896 "required": false,3897 "description": "CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400.",3898 "constraints": {3899 "maxLength": "4096"3900 }3901 },3902 {3903 "name": "match.subject_prefix",3904 "type": "string or null",3905 "required": false,3906 "description": "Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`.",3907 "constraints": {3908 "maxLength": "1024"3909 }3910 },3911 {3912 "name": "name",3913 "type": "string",3914 "required": true,3915 "description": "Admin-chosen slug identifier."3916 },3917 {3918 "name": "oauth_scope",3919 "type": "string",3920 "required": true,3921 "description": "Space-separated OAuth scopes granted on the minted token."3922 },3923 {3924 "name": "target",3925 "type": "BetaServiceAccountTarget",3926 "required": true,3927 "description": "Identity that tokens minted via this rule act as. Currently always a `service_account` target."3928 },3929 {3930 "name": "target.type",3931 "type": "\"service_account\"",3932 "required": true,3933 "description": ""3934 },3935 {3936 "name": "target.service_account_id",3937 "type": "string",3938 "required": true,3939 "description": "Tagged ID of the service account to mint tokens for."3940 },3941 {3942 "name": "target.service_account_name",3943 "type": "string or null",3944 "required": false,3945 "description": "Service account's display name at read time. Ignored on writes."3946 },3947 {3948 "name": "token_lifetime_seconds",3949 "type": "number",3950 "required": true,3951 "description": "Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds."3952 },3953 {3954 "name": "updated_at",3955 "type": "string",3956 "required": true,3957 "description": "When this rule was last updated.",3958 "constraints": {3959 "format": "date-time"3960 }3961 },3962 {3963 "name": "updated_by_actor_id",3964 "type": "string or null",3965 "required": true,3966 "description": "Tagged ID (`user_`/`svac_`) of the actor that last updated this rule."3967 },3968 {3969 "name": "workspace_id",3970 "type": "string or null",3971 "required": true,3972 "description": "Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement."3973 },3974 {3975 "name": "workspace_ids",3976 "type": "array of string",3977 "required": true,3978 "description": "Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty)."3979 }3980 ],3981 "example": {3982 "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",3983 "applies_to_all_workspaces": true,3984 "archived_at": "2019-12-27T18:11:19.117Z",3985 "archived_by_actor_id": "archived_by_actor_id",3986 "attributes": {3987 "foo": "string"3988 },3989 "created_at": "2024-10-30T23:58:27.427722Z",3990 "created_by_actor_id": "created_by_actor_id",3991 "description": "description",3992 "issuer_id": "issuer_id",3993 "issuer_name": "issuer_name",3994 "match": {3995 "audience": "audience",3996 "claims": {3997 "foo": "string"3998 },3999 "condition": "condition",4000 "subject_prefix": "subject_prefix"4001 },4002 "name": "prod-deploy-pipeline",4003 "oauth_scope": "oauth_scope",4004 "target": {4005 "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK",4006 "type": "service_account",4007 "service_account_name": "service_account_name"4008 },4009 "token_lifetime_seconds": 0,4010 "type": "federation_rule",4011 "updated_at": "2024-10-30T23:58:27.427722Z",4012 "updated_by_actor_id": "updated_by_actor_id",4013 "workspace_id": "workspace_id",4014 "workspace_ids": [4015 "string"4016 ]4017 },4018 "status": [4019 "DOCUMENTED"4020 ],4021 "sources": [4022 {4023 "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",4024 "retrieved_at": "2026-09-18"4025 },4026 {4027 "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules",4028 "retrieved_at": "2026-09-18"4029 }4030 ]4031 },4032 {4033 "provider": "anthropic",4034 "api_family": "admin",4035 "name": "FederationRuleWorkspace",4036 "official_type_name": "BetaFederationRuleWorkspace",4037 "description": "Response object of POST /v1/organizations/federation_rules/{federation_rule_id}/workspaces",4038 "fields": [4039 {4040 "name": "type",4041 "type": "\"federation_rule_workspace\"",4042 "required": true,4043 "description": "",4044 "default": "federation_rule_workspace"4045 },4046 {4047 "name": "created_at",4048 "type": "string",4049 "required": true,4050 "description": "When this workspace was enabled for the rule.",4051 "constraints": {4052 "format": "date-time"4053 }4054 },4055 {4056 "name": "created_by_actor_id",4057 "type": "string or null",4058 "required": true,4059 "description": "Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known."4060 },4061 {4062 "name": "federation_rule_id",4063 "type": "string",4064 "required": true,4065 "description": "Tagged ID of the federation rule."4066 },4067 {4068 "name": "workspace_id",4069 "type": "string",4070 "required": true,4071 "description": "Tagged ID of the workspace this rule is enabled for."4072 },4073 {4074 "name": "workspace_name",4075 "type": "string or null",4076 "required": true,4077 "description": "Workspace display name. Populated when listing; null in the enable response."4078 }4079 ],4080 "example": {4081 "created_at": "2024-10-30T23:58:27.427722Z",4082 "created_by_actor_id": "created_by_actor_id",4083 "federation_rule_id": "federation_rule_id",4084 "type": "federation_rule_workspace",4085 "workspace_id": "workspace_id",4086 "workspace_name": "workspace_name"4087 },4088 "status": [4089 "DOCUMENTED"4090 ],4091 "sources": [4092 {4093 "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/add",4094 "retrieved_at": "2026-09-18"4095 },4096 {4097 "url": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces",4098 "retrieved_at": "2026-09-18"4099 }4100 ]4101 },4102 {4103 "provider": "anthropic",4104 "api_family": "admin",4105 "name": "OrganizationInvite",4106 "official_type_name": "BetaOrganizationInvite",4107 "description": "Response object of POST /v1/organizations/invites",4108 "fields": [4109 {4110 "name": "type",4111 "type": "\"invite\"",4112 "required": true,4113 "description": "Object type. For Invites, this is always `\"invite\"`.",4114 "default": "invite"4115 },4116 {4117 "name": "id",4118 "type": "string",4119 "required": true,4120 "description": "ID of the Invite."4121 },4122 {4123 "name": "accepted_at",4124 "type": "string or null",4125 "required": true,4126 "description": "RFC 3339 datetime string indicating when the Invite was accepted, or null.",4127 "constraints": {4128 "format": "date-time"4129 }4130 },4131 {4132 "name": "email",4133 "type": "string",4134 "required": true,4135 "description": "Email of the User being invited."4136 },4137 {4138 "name": "expires_at",4139 "type": "string",4140 "required": true,4141 "description": "RFC 3339 datetime string indicating when the Invite expires.",4142 "constraints": {4143 "format": "date-time"4144 }4145 },4146 {4147 "name": "invited_at",4148 "type": "string",4149 "required": true,4150 "description": "RFC 3339 datetime string indicating when the Invite was created.",4151 "constraints": {4152 "format": "date-time"4153 }4154 },4155 {4156 "name": "rbac_group_ids",4157 "type": "array of string",4158 "required": true,4159 "description": "RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none."4160 },4161 {4162 "name": "role",4163 "type": "BetaOrganizationRole",4164 "required": true,4165 "description": "Organization role of the User.",4166 "enum": [4167 "admin",4168 "billing",4169 "claude_code_user",4170 "developer",4171 "managed",4172 "membership_admin",4173 "owner",4174 "primary_owner",4175 "user"4176 ]4177 },4178 {4179 "name": "status",4180 "type": "\"accepted\" or \"deleted\" or \"expired\" or \"pending\"",4181 "required": true,4182 "description": "Status of the Invite.",4183 "enum": [4184 "accepted",4185 "deleted",4186 "expired",4187 "pending"4188 ]4189 }4190 ],4191 "example": {4192 "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",4193 "accepted_at": "2019-12-27T18:11:19.117Z",4194 "email": "user@emaildomain.com",4195 "expires_at": "2024-11-20T23:58:27.427722Z",4196 "invited_at": "2024-10-30T23:58:27.427722Z",4197 "rbac_group_ids": [4198 "string"4199 ],4200 "role": "admin",4201 "status": "pending",4202 "type": "invite"4203 },4204 "status": [4205 "DOCUMENTED"4206 ],4207 "sources": [4208 {4209 "url": "https://platform.claude.com/docs/en/api/beta/organization/invites/create",4210 "retrieved_at": "2026-09-18"4211 },4212 {4213 "url": "https://platform.claude.com/docs/en/api/beta/organization/invites",4214 "retrieved_at": "2026-09-18"4215 }4216 ]4217 },4218 {4219 "provider": "anthropic",4220 "api_family": "admin",4221 "name": "Organization",4222 "official_type_name": "BetaOrganization",4223 "description": "Response object of GET /v1/organizations/me",4224 "fields": [4225 {4226 "name": "type",4227 "type": "\"organization\"",4228 "required": true,4229 "description": "Object type. For Organizations, this is always `\"organization\"`.",4230 "default": "organization"4231 },4232 {4233 "name": "id",4234 "type": "string",4235 "required": true,4236 "description": "ID of the Organization.",4237 "constraints": {4238 "format": "uuid"4239 }4240 },4241 {4242 "name": "name",4243 "type": "string",4244 "required": true,4245 "description": "Name of the Organization."4246 }4247 ],4248 "example": {4249 "id": "12345678-1234-5678-1234-567812345678",4250 "name": "Organization Name",4251 "type": "organization"4252 },4253 "status": [4254 "DOCUMENTED",4255 "LIVE_VERIFIED"4256 ],4257 "sources": [4258 {4259 "url": "https://platform.claude.com/docs/en/api/beta/organization/retrieve",4260 "retrieved_at": "2026-09-18"4261 }4262 ]4263 },4264 {4265 "provider": "anthropic",4266 "api_family": "admin",4267 "name": "RBACGroup",4268 "official_type_name": "BetaRBACGroup",4269 "description": "Response object of POST /v1/organizations/rbac_groups",4270 "fields": [4271 {4272 "name": "type",4273 "type": "\"rbac_group\"",4274 "required": true,4275 "description": "Object type. For RBAC Groups, this is always `\"rbac_group\"`.",4276 "default": "rbac_group"4277 },4278 {4279 "name": "id",4280 "type": "string",4281 "required": true,4282 "description": "ID of the RBAC Group."4283 },4284 {4285 "name": "created_at",4286 "type": "string",4287 "required": true,4288 "description": "RFC 3339 timestamp of when the RBAC Group was created.",4289 "constraints": {4290 "format": "date-time"4291 }4292 },4293 {4294 "name": "name",4295 "type": "string",4296 "required": true,4297 "description": "Name of the RBAC Group. Not uniqueness-enforced."4298 },4299 {4300 "name": "roles",4301 "type": "array of string or null",4302 "required": true,4303 "description": "RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list."4304 },4305 {4306 "name": "source_type",4307 "type": "\"direct\" or \"scim\"",4308 "required": true,4309 "description": "How the RBAC Group was created: `\"direct\"` for groups created directly (for example, in the organization's admin settings), `\"scim\"` for groups provisioned by the identity provider.",4310 "enum": [4311 "direct",4312 "scim"4313 ]4314 },4315 {4316 "name": "updated_at",4317 "type": "string",4318 "required": true,4319 "description": "RFC 3339 timestamp of when the RBAC Group was last updated.",4320 "constraints": {4321 "format": "date-time"4322 }4323 }4324 ],4325 "example": {4326 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",4327 "created_at": "2024-10-30T23:58:27.427722Z",4328 "name": "Engineering",4329 "roles": [4330 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"4331 ],4332 "source_type": "direct",4333 "type": "rbac_group",4334 "updated_at": "2024-10-30T23:58:27.427722Z"4335 },4336 "status": [4337 "DOCUMENTED"4338 ],4339 "sources": [4340 {4341 "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/create",4342 "retrieved_at": "2026-09-18"4343 }4344 ]4345 },4346 {4347 "provider": "anthropic",4348 "api_family": "admin",4349 "name": "RBACGroupDeleted",4350 "official_type_name": "BetaRBACGroupDeleted",4351 "description": "Response object of DELETE /v1/organizations/rbac_groups/{group_id}",4352 "fields": [4353 {4354 "name": "type",4355 "type": "\"rbac_group_deleted\"",4356 "required": true,4357 "description": "Deleted object type. For RBAC Groups, this is always `\"rbac_group_deleted\"`.",4358 "default": "rbac_group_deleted"4359 },4360 {4361 "name": "id",4362 "type": "string",4363 "required": true,4364 "description": "ID of the RBAC Group."4365 }4366 ],4367 "example": {4368 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",4369 "type": "rbac_group_deleted"4370 },4371 "status": [4372 "DOCUMENTED"4373 ],4374 "sources": [4375 {4376 "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/delete",4377 "retrieved_at": "2026-09-18"4378 }4379 ]4380 },4381 {4382 "provider": "anthropic",4383 "api_family": "admin",4384 "name": "RBACGroupMember",4385 "official_type_name": "BetaRBACGroupMember",4386 "description": "Response object of POST /v1/organizations/rbac_groups/{group_id}/members",4387 "fields": [4388 {4389 "name": "type",4390 "type": "\"rbac_group_member\"",4391 "required": true,4392 "description": "Object type. For RBAC Group Members, this is always `\"rbac_group_member\"`.",4393 "default": "rbac_group_member"4394 },4395 {4396 "name": "created_at",4397 "type": "string",4398 "required": true,4399 "description": "RFC 3339 timestamp of when the User was added to the RBAC Group.",4400 "constraints": {4401 "format": "date-time"4402 }4403 },4404 {4405 "name": "email",4406 "type": "string",4407 "required": true,4408 "description": "Email of the User."4409 },4410 {4411 "name": "group_id",4412 "type": "string",4413 "required": true,4414 "description": "ID of the RBAC Group."4415 },4416 {4417 "name": "user_id",4418 "type": "string",4419 "required": true,4420 "description": "ID of the User."4421 }4422 ],4423 "example": {4424 "created_at": "2024-10-30T23:58:27.427722Z",4425 "email": "user@emaildomain.com",4426 "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",4427 "type": "rbac_group_member",4428 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"4429 },4430 "status": [4431 "DOCUMENTED"4432 ],4433 "sources": [4434 {4435 "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/create",4436 "retrieved_at": "2026-09-18"4437 }4438 ]4439 },4440 {4441 "provider": "anthropic",4442 "api_family": "admin",4443 "name": "RBACGroupMemberDeleted",4444 "official_type_name": "BetaRBACGroupMemberDeleted",4445 "description": "Response object of DELETE /v1/organizations/rbac_groups/{group_id}/members/{user_id}",4446 "fields": [4447 {4448 "name": "type",4449 "type": "\"rbac_group_member_deleted\"",4450 "required": true,4451 "description": "Deleted object type. For RBAC Group Members, this is always `\"rbac_group_member_deleted\"`.",4452 "default": "rbac_group_member_deleted"4453 },4454 {4455 "name": "group_id",4456 "type": "string",4457 "required": true,4458 "description": "ID of the RBAC Group."4459 },4460 {4461 "name": "user_id",4462 "type": "string",4463 "required": true,4464 "description": "ID of the User."4465 }4466 ],4467 "example": {4468 "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",4469 "type": "rbac_group_member_deleted",4470 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"4471 },4472 "status": [4473 "DOCUMENTED"4474 ],4475 "sources": [4476 {4477 "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/delete",4478 "retrieved_at": "2026-09-18"4479 }4480 ]4481 },4482 {4483 "provider": "anthropic",4484 "api_family": "admin",4485 "name": "RBACRole",4486 "official_type_name": "BetaRBACRole",4487 "description": "Response object of GET /v1/organizations/rbac_roles/{role_id}",4488 "fields": [4489 {4490 "name": "type",4491 "type": "\"rbac_role\"",4492 "required": true,4493 "description": "Object type. For RBAC Roles, this is always `\"rbac_role\"`.",4494 "default": "rbac_role"4495 },4496 {4497 "name": "id",4498 "type": "string",4499 "required": true,4500 "description": "ID of the RBAC Role."4501 },4502 {4503 "name": "created_at",4504 "type": "string",4505 "required": true,4506 "description": "RFC 3339 datetime string indicating when the RBAC Role was created.",4507 "constraints": {4508 "format": "date-time"4509 }4510 },4511 {4512 "name": "name",4513 "type": "string",4514 "required": true,4515 "description": "Name of the RBAC Role."4516 },4517 {4518 "name": "updated_at",4519 "type": "string",4520 "required": true,4521 "description": "RFC 3339 datetime string indicating when the RBAC Role was last updated.",4522 "constraints": {4523 "format": "date-time"4524 }4525 }4526 ],4527 "example": {4528 "id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s",4529 "created_at": "2024-10-30T23:58:27.427722Z",4530 "name": "Project Editor",4531 "type": "rbac_role",4532 "updated_at": "2024-10-30T23:58:27.427722Z"4533 },4534 "status": [4535 "DOCUMENTED"4536 ],4537 "sources": [4538 {4539 "url": "https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/retrieve",4540 "retrieved_at": "2026-09-18"4541 }4542 ]4543 },4544 {4545 "provider": "anthropic",4546 "api_family": "admin",4547 "name": "ServiceAccount",4548 "official_type_name": "BetaServiceAccount",4549 "description": "Named non-human identity within the caller's organization. A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules).",4550 "fields": [4551 {4552 "name": "type",4553 "type": "\"service_account\"",4554 "required": true,4555 "description": "",4556 "default": "service_account"4557 },4558 {4559 "name": "id",4560 "type": "string",4561 "required": true,4562 "description": "Tagged ID of the service account."4563 },4564 {4565 "name": "archived_at",4566 "type": "string or null",4567 "required": true,4568 "description": "If set, this service account is archived.",4569 "constraints": {4570 "format": "date-time"4571 }4572 },4573 {4574 "name": "archived_by_actor_id",4575 "type": "string or null",4576 "required": true,4577 "description": "Tagged ID (`user_`/`svac_`) of the actor that archived this service account."4578 },4579 {4580 "name": "created_at",4581 "type": "string",4582 "required": true,4583 "description": "When this service account was created.",4584 "constraints": {4585 "format": "date-time"4586 }4587 },4588 {4589 "name": "created_by_actor_id",4590 "type": "string or null",4591 "required": true,4592 "description": "Tagged ID (`user_`/`svac_`) of the actor that created this service account."4593 },4594 {4595 "name": "description",4596 "type": "string or null",4597 "required": true,4598 "description": "Optional free-text description."4599 },4600 {4601 "name": "name",4602 "type": "string",4603 "required": true,4604 "description": "Admin-chosen slug identifier."4605 },4606 {4607 "name": "organization_role",4608 "type": "\"admin\" or \"developer\"",4609 "required": true,4610 "description": "Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console.",4611 "enum": [4612 "admin",4613 "developer"4614 ]4615 },4616 {4617 "name": "updated_at",4618 "type": "string",4619 "required": true,4620 "description": "When this service account was last updated.",4621 "constraints": {4622 "format": "date-time"4623 }4624 },4625 {4626 "name": "updated_by_actor_id",4627 "type": "string or null",4628 "required": true,4629 "description": "Tagged ID (`user_`/`svac_`) of the actor that last updated this service account."4630 }4631 ],4632 "example": {4633 "id": "svac_01SDCCSbTxrXDpWc1phhtcfK",4634 "archived_at": "2019-12-27T18:11:19.117Z",4635 "archived_by_actor_id": "archived_by_actor_id",4636 "created_at": "2024-10-30T23:58:27.427722Z",4637 "created_by_actor_id": "created_by_actor_id",4638 "description": "description",4639 "name": "ci-deploy-bot",4640 "organization_role": "admin",4641 "type": "service_account",4642 "updated_at": "2024-10-30T23:58:27.427722Z",4643 "updated_by_actor_id": "updated_by_actor_id"4644 },4645 "status": [4646 "DOCUMENTED"4647 ],4648 "sources": [4649 {4650 "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/create",4651 "retrieved_at": "2026-09-18"4652 },4653 {4654 "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts",4655 "retrieved_at": "2026-09-18"4656 }4657 ]4658 },4659 {4660 "provider": "anthropic",4661 "api_family": "admin",4662 "name": "ServiceAccountWorkspaceMember",4663 "official_type_name": "BetaServiceAccountWorkspaceMember",4664 "description": "Response object of POST /v1/organizations/service_accounts/{service_account_id}/workspaces",4665 "fields": [4666 {4667 "name": "type",4668 "type": "\"service_account_workspace_member\"",4669 "required": true,4670 "description": "",4671 "default": "service_account_workspace_member"4672 },4673 {4674 "name": "created_by_actor_id",4675 "type": "string or null",4676 "required": true,4677 "description": "Tagged ID (`user_...`/`svac_...`) of the actor who created this membership."4678 },4679 {4680 "name": "implicit",4681 "type": "boolean or null",4682 "required": true,4683 "description": "True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed."4684 },4685 {4686 "name": "service_account_id",4687 "type": "string",4688 "required": true,4689 "description": "Tagged service account ID (`svac_...`)."4690 },4691 {4692 "name": "workspace_id",4693 "type": "string",4694 "required": true,4695 "description": "Tagged workspace ID (`wrkspc_...`)."4696 },4697 {4698 "name": "workspace_role",4699 "type": "BetaWorkspaceRole",4700 "required": true,4701 "description": "Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.",4702 "enum": [4703 "workspace_admin",4704 "workspace_billing",4705 "workspace_developer",4706 "workspace_restricted_developer",4707 "workspace_user"4708 ]4709 }4710 ],4711 "example": {4712 "created_by_actor_id": "created_by_actor_id",4713 "implicit": true,4714 "service_account_id": "service_account_id",4715 "type": "service_account_workspace_member",4716 "workspace_id": "workspace_id",4717 "workspace_role": "workspace_admin"4718 },4719 "status": [4720 "DOCUMENTED"4721 ],4722 "sources": [4723 {4724 "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/add",4725 "retrieved_at": "2026-09-18"4726 },4727 {4728 "url": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces",4729 "retrieved_at": "2026-09-18"4730 }4731 ]4732 },4733 {4734 "provider": "anthropic",4735 "api_family": "admin",4736 "name": "SpendLimitIncreaseRequest",4737 "official_type_name": "BetaSpendLimitIncreaseRequest",4738 "description": "Response object of GET /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}",4739 "fields": [4740 {4741 "name": "type",4742 "type": "\"spend_limit_increase_request\"",4743 "required": true,4744 "description": "",4745 "default": "spend_limit_increase_request"4746 },4747 {4748 "name": "id",4749 "type": "string",4750 "required": true,4751 "description": ""4752 },4753 {4754 "name": "actor",4755 "type": "object",4756 "required": true,4757 "description": "A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts."4758 },4759 {4760 "name": "actor.type",4761 "type": "\"user_actor\"",4762 "required": true,4763 "description": "Actor type. Always `user_actor`.",4764 "default": "user_actor"4765 },4766 {4767 "name": "actor.deleted",4768 "type": "boolean",4769 "required": true,4770 "description": "True only when the underlying account has been deleted.",4771 "default": "false"4772 },4773 {4774 "name": "actor.email_address",4775 "type": "string or null",4776 "required": true,4777 "description": "The user's email address. Null when the account is unavailable or has been deleted."4778 },4779 {4780 "name": "actor.name",4781 "type": "string or null",4782 "required": true,4783 "description": "The user's current display name. Null when the account is unavailable, has been deleted, or has no name set."4784 },4785 {4786 "name": "actor.user_id",4787 "type": "string",4788 "required": true,4789 "description": "Tagged ID of the user."4790 },4791 {4792 "name": "created_at",4793 "type": "string",4794 "required": true,4795 "description": "",4796 "constraints": {4797 "format": "date-time"4798 }4799 },4800 {4801 "name": "period",4802 "type": "\"daily\" or \"monthly\" or \"weekly\"",4803 "required": true,4804 "description": "",4805 "enum": [4806 "daily",4807 "monthly",4808 "weekly"4809 ]4810 },4811 {4812 "name": "resolved_at",4813 "type": "string or null",4814 "required": true,4815 "description": "",4816 "constraints": {4817 "format": "date-time"4818 }4819 },4820 {4821 "name": "resolved_by",4822 "type": "UserActor or ScopedAPIKeyActor or null",4823 "required": true,4824 "description": ""4825 },4826 {4827 "name": "resolved_by.type",4828 "type": "\"user_actor\"",4829 "required": true,4830 "description": "Actor type. Always `user_actor`.",4831 "default": "user_actor"4832 },4833 {4834 "name": "resolved_by.deleted",4835 "type": "boolean",4836 "required": true,4837 "description": "True only when the underlying account has been deleted.",4838 "default": "false"4839 },4840 {4841 "name": "resolved_by.email_address",4842 "type": "string or null",4843 "required": true,4844 "description": "The user's email address. Null when the account is unavailable or has been deleted."4845 },4846 {4847 "name": "resolved_by.name",4848 "type": "string or null",4849 "required": true,4850 "description": "The user's current display name. Null when the account is unavailable, has been deleted, or has no name set."4851 },4852 {4853 "name": "resolved_by.user_id",4854 "type": "string",4855 "required": true,4856 "description": "Tagged ID of the user."4857 },4858 {4859 "name": "resolved_by.type",4860 "type": "\"scoped_api_key_actor\"",4861 "required": true,4862 "description": "",4863 "default": "scoped_api_key_actor"4864 },4865 {4866 "name": "resolved_by.scoped_api_key_id",4867 "type": "string",4868 "required": true,4869 "description": ""4870 },4871 {4872 "name": "spend_summary",4873 "type": "BetaSpendSummary or null",4874 "required": true,4875 "description": "Per-member effective-limit report row (`GET /spend_limits/effective`)."4876 },4877 {4878 "name": "spend_summary.actor",4879 "type": "UserActor or ScopedAPIKeyActor",4880 "required": true,4881 "description": ""4882 },4883 {4884 "name": "spend_summary.amount",4885 "type": "string or null",4886 "required": true,4887 "description": "Effective limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD). `null` means no limit applies for this row's `period` — each period resolves independently, so another period may still cap this member."4888 },4889 {4890 "name": "spend_summary.currency",4891 "type": "string",4892 "required": true,4893 "description": "ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`."4894 },4895 {4896 "name": "spend_summary.period",4897 "type": "\"daily\" or \"monthly\" or \"weekly\"",4898 "required": true,4899 "description": "Period this row's effective limit and spend are reported for.",4900 "enum": [4901 "daily",4902 "monthly",4903 "weekly"4904 ]4905 },4906 {4907 "name": "spend_summary.period_to_date_spend",4908 "type": "string",4909 "required": true,4910 "description": "The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `\"12050.5\"`) — metered usage is not rounded to whole cents. Reads as `\"0\"` when the spend reading is temporarily unavailable."4911 },4912 {4913 "name": "spend_summary.scope",4914 "type": "User or SeatTier or RBACGroup or 3 more",4915 "required": true,4916 "description": ""4917 },4918 {4919 "name": "spend_summary.source",4920 "type": "User or SeatTier or RBACGroup or 3 more",4921 "required": true,4922 "description": ""4923 },4924 {4925 "name": "spend_summary.spend_limit_id",4926 "type": "string",4927 "required": true,4928 "description": ""4929 },4930 {4931 "name": "status",4932 "type": "\"approved\" or \"denied\" or \"pending\"",4933 "required": true,4934 "description": "",4935 "enum": [4936 "approved",4937 "denied",4938 "pending"4939 ]4940 }4941 ],4942 "example": {4943 "id": "id",4944 "actor": {4945 "deleted": true,4946 "email_address": "email_address",4947 "name": "name",4948 "type": "user_actor",4949 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"4950 },4951 "created_at": "2019-12-27T18:11:19.117Z",4952 "period": "monthly",4953 "resolved_at": "2019-12-27T18:11:19.117Z",4954 "resolved_by": {4955 "deleted": true,4956 "email_address": "email_address",4957 "name": "name",4958 "type": "user_actor",4959 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"4960 },4961 "spend_summary": {4962 "actor": {4963 "deleted": true,4964 "email_address": "email_address",4965 "name": "name",4966 "type": "user_actor",4967 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"4968 },4969 "amount": "50000",4970 "currency": "USD",4971 "period": "monthly",4972 "period_to_date_spend": "12050.5",4973 "scope": {4974 "type": "user",4975 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"4976 },4977 "source": {4978 "type": "user",4979 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"4980 },4981 "spend_limit_id": "spend_limit_id"4982 },4983 "status": "approved",4984 "type": "spend_limit_increase_request"4985 },4986 "status": [4987 "DOCUMENTED"4988 ],4989 "sources": [4990 {4991 "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/retrieve",4992 "retrieved_at": "2026-09-18"4993 }4994 ]4995 },4996 {4997 "provider": "anthropic",4998 "api_family": "admin",4999 "name": "SpendLimit",5000 "official_type_name": "BetaSpendLimit",5001 "description": "A configured spend limit: a cap on metered spend for one scope and period.",5002 "fields": [5003 {5004 "name": "type",5005 "type": "\"spend_limit\"",5006 "required": true,5007 "description": "Object type. Always `spend_limit`.",5008 "default": "spend_limit"5009 },5010 {5011 "name": "id",5012 "type": "string",5013 "required": true,5014 "description": "Unique tagged ID of the spend limit (`spl_...`)."5015 },5016 {5017 "name": "amount",5018 "type": "string or null",5019 "required": true,5020 "description": "Limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD): \"50000\" is $500.00. `null` means no numeric cap is configured at this scope — see the effective report for whether a limit applies."5021 },5022 {5023 "name": "created_at",5024 "type": "string",5025 "required": true,5026 "description": "RFC 3339 datetime at which the spend limit was created.",5027 "constraints": {5028 "format": "date-time"5029 }5030 },5031 {5032 "name": "currency",5033 "type": "string",5034 "required": true,5035 "description": "ISO 4217 code of the organization's billing currency; the unit for `amount`."5036 },5037 {5038 "name": "period",5039 "type": "\"daily\" or \"monthly\" or \"weekly\"",5040 "required": true,5041 "description": "Length of the window the limit resets over. `amount` caps spend within each period.",5042 "enum": [5043 "daily",5044 "monthly",5045 "weekly"5046 ]5047 },5048 {5049 "name": "scope",5050 "type": "User or SeatTier or RBACGroup or 3 more",5051 "required": true,5052 "description": "What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope."5053 },5054 {5055 "name": "scope.type",5056 "type": "\"user\"",5057 "required": true,5058 "description": "Scope type. Always `user` for this scope.",5059 "default": "user"5060 },5061 {5062 "name": "scope.user_id",5063 "type": "string",5064 "required": true,5065 "description": "Tagged ID of the member the spend limit applies to."5066 },5067 {5068 "name": "scope.type",5069 "type": "\"seat_tier\"",5070 "required": true,5071 "description": "",5072 "default": "seat_tier"5073 },5074 {5075 "name": "scope.seat_tier",5076 "type": "string",5077 "required": true,5078 "description": ""5079 },5080 {5081 "name": "scope.type",5082 "type": "\"rbac_group\"",5083 "required": true,5084 "description": "",5085 "default": "rbac_group"5086 },5087 {5088 "name": "scope.rbac_group_id",5089 "type": "string",5090 "required": true,5091 "description": ""5092 },5093 {5094 "name": "scope.type",5095 "type": "\"organization_service\"",5096 "required": true,5097 "description": "",5098 "default": "organization_service"5099 },5100 {5101 "name": "scope.service",5102 "type": "string",5103 "required": true,5104 "description": ""5105 },5106 {5107 "name": "scope.type",5108 "type": "\"organization\"",5109 "required": true,5110 "description": "",5111 "default": "organization"5112 },5113 {5114 "name": "scope.type",5115 "type": "\"workspace\"",5116 "required": true,5117 "description": "Scope type. Always `workspace` for this scope.",5118 "default": "workspace"5119 },5120 {5121 "name": "scope.workspace_id",5122 "type": "string",5123 "required": true,5124 "description": "Tagged ID of the workspace the spend limit applies to."5125 },5126 {5127 "name": "updated_at",5128 "type": "string",5129 "required": true,5130 "description": "RFC 3339 datetime at which the spend limit was last modified.",5131 "constraints": {5132 "format": "date-time"5133 }5134 }5135 ],5136 "example": {5137 "id": "id",5138 "amount": "50000",5139 "created_at": "2019-12-27T18:11:19.117Z",5140 "currency": "USD",5141 "period": "monthly",5142 "scope": {5143 "type": "user",5144 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"5145 },5146 "type": "spend_limit",5147 "updated_at": "2019-12-27T18:11:19.117Z"5148 },5149 "status": [5150 "DOCUMENTED"5151 ],5152 "sources": [5153 {5154 "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/create",5155 "retrieved_at": "2026-09-18"5156 },5157 {5158 "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits",5159 "retrieved_at": "2026-09-18"5160 }5161 ]5162 },5163 {5164 "provider": "anthropic",5165 "api_family": "admin",5166 "name": "OrganizationTunnel",5167 "official_type_name": "BetaOrganizationTunnel",5168 "description": "Response object of GET /v1/organizations/tunnels/{tunnel_id}",5169 "fields": [5170 {5171 "name": "type",5172 "type": "\"tunnel\"",5173 "required": true,5174 "description": "Object type. Always `tunnel` for Tunnels.",5175 "default": "tunnel"5176 },5177 {5178 "name": "id",5179 "type": "string",5180 "required": true,5181 "description": "ID of the Tunnel."5182 },5183 {5184 "name": "archived_at",5185 "type": "string or null",5186 "required": true,5187 "description": "RFC 3339 datetime string indicating when the Tunnel was archived, or `null` if it is not archived.",5188 "constraints": {5189 "format": "date-time"5190 }5191 },5192 {5193 "name": "created_at",5194 "type": "string",5195 "required": true,5196 "description": "RFC 3339 datetime string indicating when the Tunnel was created.",5197 "constraints": {5198 "format": "date-time"5199 }5200 },5201 {5202 "name": "display_name",5203 "type": "string or null",5204 "required": true,5205 "description": "Human-readable name for the Tunnel (1–255 characters), or `null` if unset."5206 },5207 {5208 "name": "domain",5209 "type": "string",5210 "required": true,5211 "description": "Anthropic-assigned hostname for the Tunnel. MCP server URLs whose host is a subdomain of this value are routed through the Tunnel. Globally unique and never reused, even after the Tunnel is archived."5212 },5213 {5214 "name": "workspace_id",5215 "type": "string or null",5216 "required": true,5217 "description": "ID of the Workspace this Tunnel belongs to, or `null` for the default Workspace. Immutable after creation."5218 }5219 ],5220 "example": {5221 "id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",5222 "archived_at": "2024-11-01T23:59:27.427722Z",5223 "created_at": "2024-10-30T23:58:27.427722Z",5224 "display_name": "Production",5225 "domain": "a1b2c3d4.tunnel.anthropic.com",5226 "type": "tunnel",5227 "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"5228 },5229 "status": [5230 "DOCUMENTED"5231 ],5232 "sources": [5233 {5234 "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/retrieve",5235 "retrieved_at": "2026-09-18"5236 }5237 ]5238 },5239 {5240 "provider": "anthropic",5241 "api_family": "admin",5242 "name": "OrganizationTunnelCertificate",5243 "official_type_name": "BetaOrganizationTunnelCertificate",5244 "description": "Response object of POST /v1/organizations/tunnels/{tunnel_id}/certificates",5245 "fields": [5246 {5247 "name": "type",5248 "type": "\"tunnel_certificate\"",5249 "required": true,5250 "description": "Object type. Always `tunnel_certificate` for Tunnel Certificates.",5251 "default": "tunnel_certificate"5252 },5253 {5254 "name": "id",5255 "type": "string",5256 "required": true,5257 "description": "ID of the Tunnel Certificate."5258 },5259 {5260 "name": "archived_at",5261 "type": "string or null",5262 "required": true,5263 "description": "RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived.",5264 "constraints": {5265 "format": "date-time"5266 }5267 },5268 {5269 "name": "created_at",5270 "type": "string",5271 "required": true,5272 "description": "RFC 3339 datetime string indicating when the certificate was registered.",5273 "constraints": {5274 "format": "date-time"5275 }5276 },5277 {5278 "name": "expires_at",5279 "type": "string or null",5280 "required": true,5281 "description": "RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire.",5282 "constraints": {5283 "format": "date-time"5284 }5285 },5286 {5287 "name": "fingerprint",5288 "type": "string",5289 "required": true,5290 "description": "The certificate's SHA-256 fingerprint, as a lowercase hex string."5291 },5292 {5293 "name": "tunnel_id",5294 "type": "string",5295 "required": true,5296 "description": "ID of the Tunnel this certificate is registered against."5297 }5298 ],5299 "example": {5300 "id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",5301 "archived_at": "2024-11-01T23:59:27.427722Z",5302 "created_at": "2024-10-30T23:58:27.427722Z",5303 "expires_at": "2024-10-30T23:58:27.427722Z",5304 "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",5305 "tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",5306 "type": "tunnel_certificate"5307 },5308 "status": [5309 "DOCUMENTED"5310 ],5311 "sources": [5312 {5313 "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/create",5314 "retrieved_at": "2026-09-18"5315 },5316 {5317 "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates",5318 "retrieved_at": "2026-09-18"5319 }5320 ]5321 },5322 {5323 "provider": "anthropic",5324 "api_family": "admin",5325 "name": "OrganizationTunnelToken",5326 "official_type_name": "BetaOrganizationTunnelToken",5327 "description": "Response object of POST /v1/organizations/tunnels/{tunnel_id}/reveal_token",5328 "fields": [5329 {5330 "name": "type",5331 "type": "\"tunnel_token\"",5332 "required": true,5333 "description": "Object type. Always `tunnel_token` for Tunnel Tokens.",5334 "default": "tunnel_token"5335 },5336 {5337 "name": "id",5338 "type": "string",5339 "required": true,5340 "description": "Stable identifier for the current token value. Changes when the token is rotated."5341 },5342 {5343 "name": "tunnel_token",5344 "type": "string",5345 "required": true,5346 "description": "The tunnel's connection token."5347 }5348 ],5349 "example": {5350 "id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0",5351 "tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==",5352 "type": "tunnel_token"5353 },5354 "status": [5355 "DOCUMENTED"5356 ],5357 "sources": [5358 {5359 "url": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/reveal_token",5360 "retrieved_at": "2026-09-18"5361 }5362 ]5363 },5364 {5365 "provider": "anthropic",5366 "api_family": "admin",5367 "name": "ClaudeCodeUsageReport",5368 "official_type_name": "BetaClaudeCodeUsageReport",5369 "description": "Response object of GET /v1/organizations/usage_report/claude_code",5370 "fields": [5371 {5372 "name": "data",5373 "type": "array of object",5374 "required": true,5375 "description": "List of Claude Code usage records for the requested date."5376 },5377 {5378 "name": "data[].actor",5379 "type": "UserActor or APIActor",5380 "required": true,5381 "description": "The user or API key that performed the Claude Code actions."5382 },5383 {5384 "name": "data[].core_metrics",5385 "type": "object",5386 "required": true,5387 "description": "Core productivity metrics measuring Claude Code usage and impact."5388 },5389 {5390 "name": "data[].core_metrics.commits_by_claude_code",5391 "type": "number",5392 "required": true,5393 "description": "Number of git commits created through Claude Code's commit functionality."5394 },5395 {5396 "name": "data[].core_metrics.lines_of_code",5397 "type": "object",5398 "required": true,5399 "description": "Statistics on code changes made through Claude Code."5400 },5401 {5402 "name": "data[].core_metrics.num_sessions",5403 "type": "number",5404 "required": true,5405 "description": "Number of distinct Claude Code sessions initiated by this actor."5406 },5407 {5408 "name": "data[].core_metrics.pull_requests_by_claude_code",5409 "type": "number",5410 "required": true,5411 "description": "Number of pull requests created through Claude Code's PR functionality."5412 },5413 {5414 "name": "data[].customer_type",5415 "type": "\"api\" or \"subscription\"",5416 "required": true,5417 "description": "Type of customer account (api for API customers, subscription for Pro/Team customers).",5418 "enum": [5419 "api",5420 "subscription"5421 ]5422 },5423 {5424 "name": "data[].date",5425 "type": "string",5426 "required": true,5427 "description": "UTC day the usage metrics cover, as an RFC 3339 timestamp at midnight UTC (for example `2025-08-08T00:00:00Z`).",5428 "constraints": {5429 "format": "date-time"5430 }5431 },5432 {5433 "name": "data[].is_remote",5434 "type": "boolean",5435 "required": true,5436 "description": "Whether the usage came from remote Claude Code sessions, such as Claude Code on the web. Remote and local usage are reported as separate rows."5437 },5438 {5439 "name": "data[].model_breakdown",5440 "type": "array of object",5441 "required": true,5442 "description": "Token usage and cost breakdown by AI model used."5443 },5444 {5445 "name": "data[].model_breakdown[].estimated_cost",5446 "type": "object",5447 "required": true,5448 "description": "Estimated cost for using this model"5449 },5450 {5451 "name": "data[].model_breakdown[].model",5452 "type": "string",5453 "required": true,5454 "description": "Name of the AI model used for Claude Code interactions."5455 },5456 {5457 "name": "data[].model_breakdown[].tokens",5458 "type": "object",5459 "required": true,5460 "description": "Token usage breakdown for this model"5461 },5462 {5463 "name": "data[].organization_id",5464 "type": "string",5465 "required": true,5466 "description": "ID of the organization that owns the Claude Code usage."5467 },5468 {5469 "name": "data[].terminal_type",5470 "type": "string",5471 "required": true,5472 "description": "Type of terminal or environment where Claude Code was used."5473 },5474 {5475 "name": "data[].tool_actions",5476 "type": "map[object]",5477 "required": true,5478 "description": "Breakdown of tool action acceptance and rejection rates by tool type."5479 },5480 {5481 "name": "data[].tool_actions.accepted",5482 "type": "number",5483 "required": true,5484 "description": "Number of tool action proposals that the user accepted."5485 },5486 {5487 "name": "data[].tool_actions.rejected",5488 "type": "number",5489 "required": true,5490 "description": "Number of tool action proposals that the user rejected."5491 },5492 {5493 "name": "data[].subscription_type",5494 "type": "\"enterprise\" or \"team\" or null",5495 "required": false,5496 "description": "Subscription tier for subscription customers. `null` for API customers.",5497 "enum": [5498 "enterprise",5499 "team"5500 ]5501 },5502 {5503 "name": "has_more",5504 "type": "boolean",5505 "required": true,5506 "description": "True if there are more records available beyond the current page."5507 },5508 {5509 "name": "next_page",5510 "type": "string or null",5511 "required": true,5512 "description": "Opaque cursor token for fetching the next page of results, or null if no more pages are available."5513 }5514 ],5515 "example": {5516 "data": [5517 {5518 "actor": {5519 "email_address": "user@emaildomain.com",5520 "type": "user_actor"5521 },5522 "core_metrics": {5523 "commits_by_claude_code": 8,5524 "lines_of_code": {5525 "added": 342,5526 "removed": 1285527 },5528 "num_sessions": 15,5529 "pull_requests_by_claude_code": 25530 },5531 "customer_type": "api",5532 "date": "2025-08-08T00:00:00Z",5533 "is_remote": false,5534 "model_breakdown": [5535 {5536 "estimated_cost": {5537 "amount": 186,5538 "currency": "USD"5539 },5540 "model": "claude-opus-5",5541 "tokens": {5542 "cache_creation": 2340,5543 "cache_read": 8790,5544 "input": 45230,5545 "output": 124505546 }5547 },5548 {5549 "estimated_cost": {5550 "amount": 42,5551 "currency": "USD"5552 },5553 "model": "claude-sonnet-5",5554 "tokens": {5555 "cache_creation": 890,5556 "cache_read": 3420,5557 "input": 23100,5558 "output": 56805559 }5560 }5561 ],5562 "organization_id": "12345678-1234-5678-1234-567812345678",5563 "terminal_type": "iTerm.app",5564 "tool_actions": {5565 "edit_tool": {5566 "accepted": 25,5567 "rejected": 35568 },5569 "multi_edit_tool": {5570 "accepted": 12,5571 "rejected": 15572 },5573 "notebook_edit_tool": {5574 "accepted": 5,5575 "rejected": 25576 },5577 "write_tool": {5578 "accepted": 8,5579 "rejected": 05580 }5581 },5582 "subscription_type": "enterprise"5583 }5584 ],5585 "has_more": true,5586 "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="5587 },5588 "status": [5589 "DOCUMENTED"5590 ],5591 "sources": [5592 {5593 "url": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_claude_code",5594 "retrieved_at": "2026-09-18"5595 }5596 ]5597 },5598 {5599 "provider": "anthropic",5600 "api_family": "admin",5601 "name": "MessagesUsageReport",5602 "official_type_name": "BetaMessagesUsageReport",5603 "description": "Response object of GET /v1/organizations/usage_report/messages",5604 "fields": [5605 {5606 "name": "data",5607 "type": "array of object",5608 "required": true,5609 "description": "List of time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no usage (their `results` list is empty). A page holds at most `limit` buckets."5610 },5611 {5612 "name": "data[].ending_at",5613 "type": "string",5614 "required": true,5615 "description": "End of the time bucket (exclusive) in RFC 3339 format.",5616 "constraints": {5617 "format": "date-time"5618 }5619 },5620 {5621 "name": "data[].results",5622 "type": "array of object",5623 "required": true,5624 "description": "List of usage items for this time bucket. There may be multiple items if one or more `group_by[]` parameters are specified."5625 },5626 {5627 "name": "data[].results[].account_id",5628 "type": "string or null",5629 "required": true,5630 "description": "ID of the user account that made the request. `null` if not grouping by account or for non-OAuth requests."5631 },5632 {5633 "name": "data[].results[].api_key_id",5634 "type": "string or null",5635 "required": true,5636 "description": "ID of the API key used. `null` if not grouping by API key or for usage in the Anthropic Console."5637 },5638 {5639 "name": "data[].results[].cache_creation",5640 "type": "BetaCacheCreation",5641 "required": true,5642 "description": "The number of input tokens for cache creation."5643 },5644 {5645 "name": "data[].results[].cache_read_input_tokens",5646 "type": "number",5647 "required": true,5648 "description": "The number of input tokens read from the cache."5649 },5650 {5651 "name": "data[].results[].context_window",5652 "type": "\"0-200k\" or \"200k-1M\" or null",5653 "required": true,5654 "description": "Context window used. `null` if not grouping by context window.",5655 "enum": [5656 "0-200k",5657 "200k-1M"5658 ]5659 },5660 {5661 "name": "data[].results[].inference_geo",5662 "type": "\"global\" or \"not_available\" or \"us\" or null",5663 "required": true,5664 "description": "Inference geo used matching requests' `inference_geo` parameter if set, otherwise the workspace's `default_inference_geo`. For models that do not support specifying `inference_geo` the value is `\"not_available\"`. Always `null` if not grouping by inference geo.",5665 "enum": [5666 "global",5667 "not_available",5668 "us"5669 ]5670 },5671 {5672 "name": "data[].results[].model",5673 "type": "string or null",5674 "required": true,5675 "description": "Model used. `null` if not grouping by model."5676 },5677 {5678 "name": "data[].results[].output_tokens",5679 "type": "number",5680 "required": true,5681 "description": "The number of output tokens generated."5682 },5683 {5684 "name": "data[].results[].server_tool_use",5685 "type": "object",5686 "required": true,5687 "description": "Server-side tool usage metrics."5688 },5689 {5690 "name": "data[].results[].service_account_id",5691 "type": "string or null",5692 "required": true,5693 "description": "ID of the service account that made the request. `null` if not grouping by service account or for non-OIDC-federation requests."5694 },5695 {5696 "name": "data[].results[].service_tier",5697 "type": "\"batch\" or \"flex\" or \"flex_discount\" or 3 more or null",5698 "required": true,5699 "description": "Service tier used. `null` if not grouping by service tier.",5700 "enum": [5701 "batch",5702 "flex",5703 "flex_discount",5704 "priority",5705 "priority_on_demand",5706 "standard"5707 ]5708 },5709 {5710 "name": "data[].results[].uncached_input_tokens",5711 "type": "number",5712 "required": true,5713 "description": "The number of uncached input tokens processed."5714 },5715 {5716 "name": "data[].results[].workspace_id",5717 "type": "string or null",5718 "required": true,5719 "description": "ID of the Workspace used. `null` if not grouping by workspace or for the default workspace."5720 },5721 {5722 "name": "data[].starting_at",5723 "type": "string",5724 "required": true,5725 "description": "Start of the time bucket (inclusive) in RFC 3339 format.",5726 "constraints": {5727 "format": "date-time"5728 }5729 },5730 {5731 "name": "has_more",5732 "type": "boolean",5733 "required": true,5734 "description": "Indicates if there are more results."5735 },5736 {5737 "name": "next_page",5738 "type": "string or null",5739 "required": true,5740 "description": "Opaque cursor for the next page, or `null` when `has_more` is false. Pass it as the `page` parameter in the next request."5741 }5742 ],5743 "example": {5744 "data": [5745 {5746 "ending_at": "2025-08-02T00:00:00Z",5747 "results": [5748 {5749 "account_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",5750 "api_key_id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",5751 "cache_creation": {5752 "ephemeral_1h_input_tokens": 0,5753 "ephemeral_5m_input_tokens": 05754 },5755 "cache_read_input_tokens": 200,5756 "context_window": "0-200k",5757 "inference_geo": "global",5758 "model": "claude-opus-5",5759 "output_tokens": 500,5760 "server_tool_use": {5761 "web_search_requests": 105762 },5763 "service_account_id": "svac_01Hk3R9TWxq7CfQak00OiVw4",5764 "service_tier": "standard",5765 "uncached_input_tokens": 1500,5766 "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"5767 }5768 ],5769 "starting_at": "2025-08-01T00:00:00Z"5770 }5771 ],5772 "has_more": true,5773 "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="5774 },5775 "status": [5776 "DOCUMENTED"5777 ],5778 "sources": [5779 {5780 "url": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",5781 "retrieved_at": "2026-09-18"5782 },5783 {5784 "url": "https://platform.claude.com/docs/en/api/beta/organization/usage_report",5785 "retrieved_at": "2026-09-18"5786 }5787 ]5788 },5789 {5790 "provider": "anthropic",5791 "api_family": "admin",5792 "name": "OrganizationUser",5793 "official_type_name": "BetaOrganizationUser",5794 "description": "Response object of GET /v1/organizations/users/{user_id}",5795 "fields": [5796 {5797 "name": "type",5798 "type": "\"user\"",5799 "required": true,5800 "description": "Object type. For Users, this is always `\"user\"`.",5801 "default": "user"5802 },5803 {5804 "name": "id",5805 "type": "string",5806 "required": true,5807 "description": "ID of the User."5808 },5809 {5810 "name": "added_at",5811 "type": "string",5812 "required": true,5813 "description": "RFC 3339 datetime string indicating when the User joined the Organization.",5814 "constraints": {5815 "format": "date-time"5816 }5817 },5818 {5819 "name": "email",5820 "type": "string",5821 "required": true,5822 "description": "Email of the User."5823 },5824 {5825 "name": "name",5826 "type": "string",5827 "required": true,5828 "description": "Name of the User."5829 },5830 {5831 "name": "role",5832 "type": "BetaOrganizationRole",5833 "required": true,5834 "description": "Organization role of the User.",5835 "enum": [5836 "admin",5837 "billing",5838 "claude_code_user",5839 "developer",5840 "managed",5841 "membership_admin",5842 "owner",5843 "primary_owner",5844 "user"5845 ]5846 }5847 ],5848 "example": {5849 "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",5850 "added_at": "2024-10-30T23:58:27.427722Z",5851 "email": "user@emaildomain.com",5852 "name": "Jane Doe",5853 "role": "admin",5854 "type": "user"5855 },5856 "status": [5857 "DOCUMENTED"5858 ],5859 "sources": [5860 {5861 "url": "https://platform.claude.com/docs/en/api/beta/organization/users/retrieve",5862 "retrieved_at": "2026-09-18"5863 }5864 ]5865 },5866 {5867 "provider": "anthropic",5868 "api_family": "admin",5869 "name": "Workspace",5870 "official_type_name": "BetaWorkspace",5871 "description": "Response object of POST /v1/organizations/workspaces",5872 "fields": [5873 {5874 "name": "type",5875 "type": "\"workspace\"",5876 "required": true,5877 "description": "Object type. For Workspaces, this is always `\"workspace\"`.",5878 "default": "workspace"5879 },5880 {5881 "name": "id",5882 "type": "string",5883 "required": true,5884 "description": "ID of the Workspace."5885 },5886 {5887 "name": "archived_at",5888 "type": "string or null",5889 "required": true,5890 "description": "RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.",5891 "constraints": {5892 "format": "date-time"5893 }5894 },5895 {5896 "name": "compartment_id",5897 "type": "string",5898 "required": true,5899 "description": "Identifier for this Workspace's encryption compartment. When you configure a customer-managed encryption key (CMEK) on AWS, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: the key is validated against this Workspace's own value when it is attached, so if your key policy uses the compartment condition, add this value to it before attaching the key."5900 },5901 {5902 "name": "created_at",5903 "type": "string",5904 "required": true,5905 "description": "RFC 3339 datetime string indicating when the Workspace was created.",5906 "constraints": {5907 "format": "date-time"5908 }5909 },5910 {5911 "name": "data_residency",5912 "type": "BetaDataResidency",5913 "required": true,5914 "description": "Data residency configuration."5915 },5916 {5917 "name": "data_residency.allowed_inference_geos",5918 "type": "array of BetaAllowedInferenceGeo or \"unrestricted\"",5919 "required": true,5920 "description": "Permitted inference geo values. 'unrestricted' means all geos are allowed."5921 },5922 {5923 "name": "data_residency.default_inference_geo",5924 "type": "\"global\" or \"us\"",5925 "required": true,5926 "description": "Default inference geo applied when requests omit the parameter.",5927 "enum": [5928 "global",5929 "us"5930 ]5931 },5932 {5933 "name": "data_residency.workspace_geo",5934 "type": "\"us\"",5935 "required": true,5936 "description": "Geographic region for workspace data storage. Immutable after creation."5937 },5938 {5939 "name": "display_color",5940 "type": "string",5941 "required": true,5942 "description": "Hex color code representing the Workspace in the Anthropic Console."5943 },5944 {5945 "name": "external_key_id",5946 "type": "string or null",5947 "required": true,5948 "description": "ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same."5949 },5950 {5951 "name": "name",5952 "type": "string",5953 "required": true,5954 "description": "Name of the Workspace."5955 },5956 {5957 "name": "tags",5958 "type": "map[string]",5959 "required": true,5960 "description": "User-defined tags as string key-value pairs. Keys may not begin with `anthropic`."5961 }5962 ],5963 "example": {5964 "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",5965 "archived_at": "2024-11-01T23:59:27.427722Z",5966 "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",5967 "created_at": "2024-10-30T23:58:27.427722Z",5968 "data_residency": {5969 "allowed_inference_geos": "unrestricted",5970 "default_inference_geo": "global",5971 "workspace_geo": "us"5972 },5973 "display_color": "#6C5BB9",5974 "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",5975 "name": "Workspace Name",5976 "tags": {5977 "env": "prod",5978 "team": "platform"5979 },5980 "type": "workspace"5981 },5982 "status": [5983 "DOCUMENTED"5984 ],5985 "sources": [5986 {5987 "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/create",5988 "retrieved_at": "2026-09-18"5989 }5990 ]5991 },5992 {5993 "provider": "anthropic",5994 "api_family": "admin",5995 "name": "WorkspaceMember",5996 "official_type_name": "BetaWorkspaceMember",5997 "description": "Response object of POST /v1/organizations/workspaces/{workspace_id}/members",5998 "fields": [5999 {6000 "name": "type",6001 "type": "\"workspace_member\"",6002 "required": true,6003 "description": "Object type. For Workspace Members, this is always `\"workspace_member\"`.",6004 "default": "workspace_member"6005 },6006 {6007 "name": "user_id",6008 "type": "string",6009 "required": true,6010 "description": "ID of the User."6011 },6012 {6013 "name": "workspace_id",6014 "type": "string",6015 "required": true,6016 "description": "ID of the Workspace."6017 },6018 {6019 "name": "workspace_role",6020 "type": "BetaWorkspaceRole",6021 "required": true,6022 "description": "Role of the Workspace Member.",6023 "enum": [6024 "workspace_admin",6025 "workspace_billing",6026 "workspace_developer",6027 "workspace_restricted_developer",6028 "workspace_user"6029 ]6030 }6031 ],6032 "example": {6033 "type": "workspace_member",6034 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",6035 "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",6036 "workspace_role": "workspace_admin"6037 },6038 "status": [6039 "DOCUMENTED"6040 ],6041 "sources": [6042 {6043 "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/add",6044 "retrieved_at": "2026-09-18"6045 }6046 ]6047 },6048 {6049 "provider": "anthropic",6050 "api_family": "skills",6051 "name": "Skill",6052 "official_type_name": "BetaSkill",6053 "description": "Response object of POST /v1/skills",6054 "fields": [6055 {6056 "name": "type",6057 "type": "\"skill\"",6058 "required": true,6059 "description": "Object type. For Skills, this is always `\"skill\"`.",6060 "default": "skill"6061 },6062 {6063 "name": "id",6064 "type": "string",6065 "required": true,6066 "description": "Unique identifier for the skill. The format and length of IDs may change over time."6067 },6068 {6069 "name": "created_at",6070 "type": "string",6071 "required": true,6072 "description": "ISO 8601 timestamp of when the skill was created.",6073 "constraints": {6074 "format": "date-time"6075 }6076 },6077 {6078 "name": "display_name",6079 "type": "string",6080 "required": true,6081 "description": "Human-readable, single-line label for the Skill. Maximum 255 characters. Always set: derived from the SKILL.md frontmatter `name` when omitted at creation. Not unique."6082 },6083 {6084 "name": "latest_version_id",6085 "type": "string",6086 "required": true,6087 "description": "ID of the newest Skill Version — what `latest` references resolve to. Always set: a Skill holds at least one version."6088 },6089 {6090 "name": "source",6091 "type": "BetaSkillSource",6092 "required": true,6093 "description": "Where the Skill comes from. Possible values: * `\"custom\"`: authored by the platform user; private to their workspace * `\"anthropic\"`: published by Anthropic; shared and read-only * `\"anthropic_example\"`: Anthropic-published sample Skill * `\"plugin\"`: resolved from an installed plugin"6094 },6095 {6096 "name": "source.type",6097 "type": "\"custom\" or \"anthropic\" or \"anthropic_example\" or \"plugin\"",6098 "required": true,6099 "description": "Where the Skill comes from. Possible values: * `\"custom\"`: authored by the platform user; private to their workspace * `\"anthropic\"`: published by Anthropic; shared and read-only * `\"anthropic_example\"`: Anthropic-published sample Skill * `\"plugin\"`: resolved from an installed plugin",6100 "enum": [6101 "custom",6102 "anthropic",6103 "anthropic_example",6104 "plugin"6105 ]6106 },6107 {6108 "name": "updated_at",6109 "type": "string",6110 "required": true,6111 "description": "ISO 8601 timestamp of when the skill was last updated.",6112 "constraints": {6113 "format": "date-time"6114 }6115 }6116 ],6117 "example": {6118 "id": "skill_01JAbcdefghijklmnopqrstuvw",6119 "created_at": "2024-10-30T23:58:27.427722Z",6120 "display_name": "display_name",6121 "latest_version_id": "latest_version_id",6122 "source": {6123 "type": "custom"6124 },6125 "type": "skill",6126 "updated_at": "2024-10-30T23:58:27.427722Z"6127 },6128 "status": [6129 "DOCUMENTED",6130 "LIVE_VERIFIED"6131 ],6132 "sources": [6133 {6134 "url": "https://platform.claude.com/docs/en/api/beta/skills/create",6135 "retrieved_at": "2026-09-18"6136 },6137 {6138 "url": "https://platform.claude.com/docs/en/api/skills/create",6139 "retrieved_at": "2026-09-18"6140 }6141 ]6142 },6143 {6144 "provider": "anthropic",6145 "api_family": "skills",6146 "name": "DeletedSkill",6147 "official_type_name": "BetaDeletedSkill",6148 "description": "Response object of DELETE /v1/skills/{skill_id}",6149 "fields": [6150 {6151 "name": "type",6152 "type": "\"skill_deleted\"",6153 "required": true,6154 "description": "Deleted object type. For Skills, this is always `\"skill_deleted\"`.",6155 "default": "skill_deleted"6156 },6157 {6158 "name": "id",6159 "type": "string",6160 "required": true,6161 "description": "Unique identifier for the skill. The format and length of IDs may change over time."6162 }6163 ],6164 "example": {6165 "id": "skill_01JAbcdefghijklmnopqrstuvw",6166 "type": "skill_deleted"6167 },6168 "status": [6169 "DOCUMENTED",6170 "LIVE_VERIFIED"6171 ],6172 "sources": [6173 {6174 "url": "https://platform.claude.com/docs/en/api/beta/skills/delete",6175 "retrieved_at": "2026-09-18"6176 },6177 {6178 "url": "https://platform.claude.com/docs/en/api/skills/delete",6179 "retrieved_at": "2026-09-18"6180 }6181 ]6182 },6183 {6184 "provider": "anthropic",6185 "api_family": "skills",6186 "name": "SkillVersion",6187 "official_type_name": "BetaSkillVersion",6188 "description": "Response object of POST /v1/skills/{skill_id}/versions",6189 "fields": [6190 {6191 "name": "type",6192 "type": "\"skill_version\"",6193 "required": true,6194 "description": "Object type. For Skill Versions, this is always `\"skill_version\"`.",6195 "default": "skill_version"6196 },6197 {6198 "name": "id",6199 "type": "string",6200 "required": true,6201 "description": "Unique identifier for this Skill Version. The id addresses the version in paths and pins it in references."6202 },6203 {6204 "name": "created_at",6205 "type": "string",6206 "required": true,6207 "description": "ISO 8601 timestamp of when the skill was created.",6208 "constraints": {6209 "format": "date-time"6210 }6211 },6212 {6213 "name": "description",6214 "type": "string",6215 "required": true,6216 "description": "Description of the skill version. This is extracted from the SKILL.md file in the skill upload."6217 },6218 {6219 "name": "name",6220 "type": "string",6221 "required": true,6222 "description": "The Skill's immutable kebab-case slug, set at creation from the first upload's SKILL.md frontmatter `name` (or its enclosing directory). Every later upload must resolve to the same value. Also the top-level directory of the Skill's mounted files and the base name of a downloaded archive."6223 },6224 {6225 "name": "skill_id",6226 "type": "string",6227 "required": true,6228 "description": "Unique identifier for the skill. The format and length of IDs may change over time."6229 }6230 ],6231 "example": {6232 "id": "id",6233 "created_at": "2024-10-30T23:58:27.427722Z",6234 "description": "description",6235 "name": "name",6236 "skill_id": "skill_01JAbcdefghijklmnopqrstuvw",6237 "type": "skill_version"6238 },6239 "status": [6240 "DOCUMENTED",6241 "LIVE_VERIFIED"6242 ],6243 "sources": [6244 {6245 "url": "https://platform.claude.com/docs/en/api/beta/skills/versions/create",6246 "retrieved_at": "2026-09-18"6247 },6248 {6249 "url": "https://platform.claude.com/docs/en/api/beta/skills/versions",6250 "retrieved_at": "2026-09-18"6251 },6252 {6253 "url": "https://platform.claude.com/docs/en/api/skills/versions/create",6254 "retrieved_at": "2026-09-18"6255 },6256 {6257 "url": "https://platform.claude.com/docs/en/api/skills/versions",6258 "retrieved_at": "2026-09-18"6259 }6260 ]6261 },6262 {6263 "provider": "anthropic",6264 "api_family": "skills",6265 "name": "DeletedSkillVersion",6266 "official_type_name": "BetaDeletedSkillVersion",6267 "description": "Response object of DELETE /v1/skills/{skill_id}/versions/{version}",6268 "fields": [6269 {6270 "name": "type",6271 "type": "\"skill_version_deleted\"",6272 "required": true,6273 "description": "Deleted object type. For Skill Versions, this is always `\"skill_version_deleted\"`.",6274 "default": "skill_version_deleted"6275 },6276 {6277 "name": "id",6278 "type": "string",6279 "required": true,6280 "description": "Unique identifier for this Skill Version. The id addresses the version in paths and pins it in references."6281 }6282 ],6283 "example": {6284 "id": "id",6285 "type": "skill_version_deleted"6286 },6287 "status": [6288 "DOCUMENTED",6289 "LIVE_VERIFIED"6290 ],6291 "sources": [6292 {6293 "url": "https://platform.claude.com/docs/en/api/beta/skills/versions/delete",6294 "retrieved_at": "2026-09-18"6295 },6296 {6297 "url": "https://platform.claude.com/docs/en/api/skills/versions/delete",6298 "retrieved_at": "2026-09-18"6299 }6300 ]6301 },6302 {6303 "provider": "anthropic",6304 "api_family": "messages-batches",6305 "name": "Beta Message Batch Canceled Result",6306 "official_type_name": "BetaMessageBatchCanceledResult",6307 "description": "",6308 "fields": [6309 {6310 "name": "type",6311 "type": "\"canceled\"",6312 "required": true,6313 "description": "",6314 "default": "canceled"6315 }6316 ],6317 "status": [6318 "DOCUMENTED"6319 ],6320 "sources": [6321 {6322 "url": "https://platform.claude.com/docs/en/api/beta/messages/batches",6323 "retrieved_at": "2026-09-18"6324 }6325 ]6326 },6327 {6328 "provider": "anthropic",6329 "api_family": "messages-batches",6330 "name": "Beta Message Batch Errored Result",6331 "official_type_name": "BetaMessageBatchErroredResult",6332 "description": "",6333 "fields": [6334 {6335 "name": "type",6336 "type": "\"errored\"",6337 "required": true,6338 "description": "",6339 "default": "errored"6340 },6341 {6342 "name": "error",6343 "type": "BetaErrorResponse",6344 "required": true,6345 "description": ""6346 },6347 {6348 "name": "error.type",6349 "type": "\"error\"",6350 "required": true,6351 "description": "",6352 "default": "error"6353 },6354 {6355 "name": "error.error",6356 "type": "BetaError",6357 "required": true,6358 "description": ""6359 },6360 {6361 "name": "error.request_id",6362 "type": "string or null",6363 "required": true,6364 "description": ""6365 }6366 ],6367 "status": [6368 "DOCUMENTED"6369 ],6370 "sources": [6371 {6372 "url": "https://platform.claude.com/docs/en/api/beta/messages/batches",6373 "retrieved_at": "2026-09-18"6374 }6375 ]6376 },6377 {6378 "provider": "anthropic",6379 "api_family": "messages-batches",6380 "name": "Beta Message Batch Expired Result",6381 "official_type_name": "BetaMessageBatchExpiredResult",6382 "description": "",6383 "fields": [6384 {6385 "name": "type",6386 "type": "\"expired\"",6387 "required": true,6388 "description": "",6389 "default": "expired"6390 }6391 ],6392 "status": [6393 "DOCUMENTED"6394 ],6395 "sources": [6396 {6397 "url": "https://platform.claude.com/docs/en/api/beta/messages/batches",6398 "retrieved_at": "2026-09-18"6399 }6400 ]6401 },6402 {6403 "provider": "anthropic",6404 "api_family": "messages-batches",6405 "name": "Beta Message Batch Request Counts",6406 "official_type_name": "BetaMessageBatchRequestCounts",6407 "description": "",6408 "fields": [6409 {6410 "name": "canceled",6411 "type": "number",6412 "required": true,6413 "description": "Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended.",6414 "default": "0"6415 },6416 {6417 "name": "errored",6418 "type": "number",6419 "required": true,6420 "description": "Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended.",6421 "default": "0"6422 },6423 {6424 "name": "expired",6425 "type": "number",6426 "required": true,6427 "description": "Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended.",6428 "default": "0"6429 },6430 {6431 "name": "processing",6432 "type": "number",6433 "required": true,6434 "description": "Number of requests in the Message Batch that are processing.",6435 "default": "0"6436 },6437 {6438 "name": "succeeded",6439 "type": "number",6440 "required": true,6441 "description": "Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended.",6442 "default": "0"6443 }6444 ],6445 "status": [6446 "DOCUMENTED"6447 ],6448 "sources": [6449 {6450 "url": "https://platform.claude.com/docs/en/api/beta/messages/batches",6451 "retrieved_at": "2026-09-18"6452 }6453 ]6454 },6455 {6456 "provider": "anthropic",6457 "api_family": "messages-batches",6458 "name": "Beta Message Batch Result",6459 "official_type_name": "BetaMessageBatchResult",6460 "description": "Processing result for this request. Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.",6461 "fields": [6462 {6463 "name": "type",6464 "type": "\"succeeded\"",6465 "required": true,6466 "description": "",6467 "default": "succeeded"6468 },6469 {6470 "name": "message",6471 "type": "BetaMessage",6472 "required": true,6473 "description": ""6474 },6475 {6476 "name": "message.type",6477 "type": "\"message\"",6478 "required": true,6479 "description": "Object type. For Messages, this is always `\"message\"`.",6480 "default": "message"6481 },6482 {6483 "name": "message.id",6484 "type": "string",6485 "required": true,6486 "description": "Unique object identifier. The format and length of IDs may change over time."6487 },6488 {6489 "name": "message.container",6490 "type": "BetaContainer or null",6491 "required": true,6492 "description": "Information about the container used in the request (for the code execution tool)"6493 },6494 {6495 "name": "message.container.id",6496 "type": "string",6497 "required": true,6498 "description": "Identifier for the container used in this request"6499 },6500 {6501 "name": "message.container.expires_at",6502 "type": "string",6503 "required": true,6504 "description": "The time at which the container will expire.",6505 "constraints": {6506 "format": "date-time"6507 }6508 },6509 {6510 "name": "message.container.skills",6511 "type": "array of BetaContainerSkill or null",6512 "required": true,6513 "description": "Skills loaded in the container"6514 },6515 {6516 "name": "message.content",6517 "type": "array of BetaContentBlock",6518 "required": true,6519 "description": "Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{\"type\": \"text\", \"text\": \"Hi, I'm Claude.\"}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {\"role\": \"user\", \"content\": \"What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun\"}, {\"role\": \"assistant\", \"content\": \"The best answer is (\"} ] ``` Then the response `content` might be: ```json [{\"type\": \"text\", \"text\": \"B)\"}] ```"6520 },6521 {6522 "name": "message.context_management",6523 "type": "BetaContextManagementResponse or null",6524 "required": true,6525 "description": "Context management response. Information about context management strategies applied during the request."6526 },6527 {6528 "name": "message.context_management.applied_edits",6529 "type": "array of BetaClearToolUses20250919EditResponse or BetaClearThinking20251015EditResponse",6530 "required": true,6531 "description": "List of context management edits that were applied."6532 },6533 {6534 "name": "message.diagnostics",6535 "type": "BetaDiagnostics or null",6536 "required": true,6537 "description": "Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request."6538 },6539 {6540 "name": "message.diagnostics.cache_miss_reason",6541 "type": "BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more or null",6542 "required": true,6543 "description": "Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed."6544 },6545 {6546 "name": "message.model",6547 "type": "Model",6548 "required": true,6549 "description": "The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."6550 },6551 {6552 "name": "message.role",6553 "type": "\"assistant\"",6554 "required": true,6555 "description": "Conversational role of the generated message. This will always be `\"assistant\"`.",6556 "default": "assistant"6557 },6558 {6559 "name": "message.stop_details",6560 "type": "BetaRefusalStopDetails or null",6561 "required": true,6562 "description": "Structured information about a refusal."6563 },6564 {6565 "name": "message.stop_details.type",6566 "type": "\"refusal\"",6567 "required": true,6568 "description": "",6569 "default": "refusal"6570 },6571 {6572 "name": "message.stop_details.category",6573 "type": "\"cyber\" or \"bio\" or \"frontier_llm\" or 2 more or null",6574 "required": true,6575 "description": "The policy category that triggered a refusal.",6576 "enum": [6577 "cyber",6578 "bio",6579 "frontier_llm",6580 "reasoning_extraction",6581 "general_harms"6582 ]6583 },6584 {6585 "name": "message.stop_details.explanation",6586 "type": "string or null",6587 "required": true,6588 "description": "Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category."6589 },6590 {6591 "name": "message.stop_details.fallback_credit_token",6592 "type": "string or null",6593 "required": true,6594 "description": "Opaque code that refunds the cache-miss cost when retrying this refused request on the fallback model. Pass it as `fallback_credit_token` on the retry request. Expires 5 minutes after the refusal. The retry is sent either with the same request body (`system`, `messages`, `tools`, and other render-shaping fields), or with the same body plus one appended `assistant` message whose content is the partial text (with any trailing whitespace stripped from the final text block) and paired server-tool blocks from this refusal — which also authorizes that appended turn as an assistant-prefill continuation on models that otherwise disallow prefill. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed the second way — if a same-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry the second way instead. Either way: same workspace, same platform; a mismatch is a 400. Resending a token for an already-warm prefix is permitted but yields no additional credit. `null` when the refused model isn't eligible for a fallback credit."6595 },6596 {6597 "name": "message.stop_details.fallback_has_prefill_claim",6598 "type": "boolean or null",6599 "required": true,6600 "description": "Whether the accompanying `fallback_credit_token` may be redeemed with the appended-assistant retry form. Only set when `fallback_credit_token` is present. `true`: retry by resending the same request body plus one appended `assistant` message whose content is this response's `content` with any trailing whitespace stripped from the final text block and unpaired `tool_use` blocks omitted (the same appended-turn shape described on `fallback_credit_token`), with the token attached. `false`: retry by resending the original request body unchanged, with the token attached — the appended-assistant form is not available for this refusal (no continuable partial content, or the request uses `output_format` or a `tool_choice` that forces tool use). One exception: when the request used `output_format` or a forced `tool_choice` and the refusal arrived after server tools (including MCP connector tools) had already executed, the token may not be redeemable by either retry form; if the exact-body retry is then rejected with a 400 saying the token must be redeemed by continuing the partial response, discard the token and retry without it. Advisory: if an appended-assistant retry is rejected with a 400 despite `true`, fall back to resending the original request body with the token."6601 },6602 {6603 "name": "message.stop_details.recommended_model",6604 "type": "string or null",6605 "required": true,6606 "description": "The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise."6607 },6608 {6609 "name": "message.stop_reason",6610 "type": "BetaStopReason or null",6611 "required": true,6612 "description": "The reason that we stopped. This may be one the following values: * `\"end_turn\"`: the model reached a natural stopping point * `\"max_tokens\"`: we exceeded the requested `max_tokens` or the model's maximum * `\"stop_sequence\"`: one of your provided custom `stop_sequences` was generated * `\"tool_use\"`: the model invoked one or more tools * `\"pause_turn\"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `\"refusal\"`: when streaming classifiers intervene to handle potential policy violations * `\"model_context_window_exceeded\"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise.",6613 "enum": [6614 "end_turn",6615 "max_tokens",6616 "stop_sequence",6617 "tool_use",6618 "pause_turn",6619 "compaction",6620 "refusal",6621 "model_context_window_exceeded"6622 ]6623 },6624 {6625 "name": "message.stop_sequence",6626 "type": "string or null",6627 "required": true,6628 "description": "Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated."6629 },6630 {6631 "name": "message.usage",6632 "type": "BetaUsage",6633 "required": true,6634 "description": "Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`."6635 },6636 {6637 "name": "message.usage.cache_creation",6638 "type": "BetaCacheCreation or null",6639 "required": true,6640 "description": "Breakdown of cached tokens by TTL"6641 },6642 {6643 "name": "message.usage.cache_creation_input_tokens",6644 "type": "number or null",6645 "required": true,6646 "description": "The number of input tokens used to create the cache entry.",6647 "minimum": 06648 },6649 {6650 "name": "message.usage.cache_read_input_tokens",6651 "type": "number or null",6652 "required": true,6653 "description": "The number of input tokens read from the cache.",6654 "minimum": 06655 },6656 {6657 "name": "message.usage.fallback_credit",6658 "type": "BetaFallbackCreditUsage or null",6659 "required": true,6660 "description": "Outcome of the `fallback_credit_token` presented on this request."6661 },6662 {6663 "name": "message.usage.inference_geo",6664 "type": "string or null",6665 "required": true,6666 "description": "The geographic region where inference was performed for this request."6667 },6668 {6669 "name": "message.usage.input_tokens",6670 "type": "number",6671 "required": true,6672 "description": "The number of input tokens which were used.",6673 "minimum": 06674 },6675 {6676 "name": "message.usage.iterations",6677 "type": "BetaIterationsUsage or null",6678 "required": true,6679 "description": "Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results."6680 },6681 {6682 "name": "message.usage.output_tokens",6683 "type": "number",6684 "required": true,6685 "description": "The number of output tokens which were used.",6686 "minimum": 06687 },6688 {6689 "name": "message.usage.output_tokens_details",6690 "type": "BetaOutputTokensDetails or null",6691 "required": true,6692 "description": "Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you."6693 },6694 {6695 "name": "message.usage.server_tool_use",6696 "type": "BetaServerToolUsage or null",6697 "required": true,6698 "description": "The number of server tool requests."6699 },6700 {6701 "name": "message.usage.service_tier",6702 "type": "\"standard\" or \"priority\" or \"batch\" or null",6703 "required": true,6704 "description": "If the request used the priority, standard, or batch tier.",6705 "enum": [6706 "standard",6707 "priority",6708 "batch"6709 ]6710 },6711 {6712 "name": "message.usage.speed",6713 "type": "\"standard\" or \"fast\" or null",6714 "required": true,6715 "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",6716 "enum": [6717 "standard",6718 "fast"6719 ]6720 },6721 {6722 "name": "message.input_transformations",6723 "type": "array of BetaInputTransformation or null",6724 "required": false,6725 "description": "Changes the API made to the request's input before showing it to the model, and blocks that failed a binding check but were left unchanged: one entry per block, in request order. Two entry types today. `thinking_dropped` — a `thinking`, `redacted_thinking` or `connector_text` block from the request's `messages` that was removed from the prompt instead of being shown to the model because it failed a binding check. `thinking_mismatch_allowed` — a `thinking` or `redacted_thinking` block that failed the conversation check (the conversation before it differs from the one it was created in, or it carries no record of one on a model that requires it) and was shown to the model all the same, because that check is not enforced for this request. More entry types may be added over time; ignore types you do not recognize. Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on every such response from a model that supports extended thinking, as `[]` when there is no entry to report; without the beta, blocks are removed or left in place all the same but nothing is reported. Removed blocks contribute nothing to `usage.input_tokens`; blocks left in place count as sent. When streaming, the array is final in `message_start`; the final `message_delta` event carries it only when a server-side model fallback happened mid-stream, in which case it holds the serving model's entries and replaces the one in `message_start`."6726 },6727 {6728 "name": "type",6729 "type": "\"errored\"",6730 "required": true,6731 "description": "",6732 "default": "errored"6733 },6734 {6735 "name": "error",6736 "type": "BetaErrorResponse",6737 "required": true,6738 "description": ""6739 },6740 {6741 "name": "error.type",6742 "type": "\"error\"",6743 "required": true,6744 "description": "",6745 "default": "error"6746 },6747 {6748 "name": "error.error",6749 "type": "BetaError",6750 "required": true,6751 "description": ""6752 },6753 {6754 "name": "error.request_id",6755 "type": "string or null",6756 "required": true,6757 "description": ""6758 },6759 {6760 "name": "type",6761 "type": "\"canceled\"",6762 "required": true,6763 "description": "",6764 "default": "canceled"6765 },6766 {6767 "name": "type",6768 "type": "\"expired\"",6769 "required": true,6770 "description": "",6771 "default": "expired"6772 }6773 ],6774 "status": [6775 "DOCUMENTED"6776 ],6777 "sources": [6778 {6779 "url": "https://platform.claude.com/docs/en/api/beta/messages/batches",6780 "retrieved_at": "2026-09-18"6781 }6782 ],6783 "union_of": "BetaMessageBatchSucceededResult or BetaMessageBatchErroredResult or BetaMessageBatchCanceledResult or BetaMessageBatchExpiredResult"6784 },6785 {6786 "provider": "anthropic",6787 "api_family": "messages-batches",6788 "name": "Beta Message Batch Succeeded Result",6789 "official_type_name": "BetaMessageBatchSucceededResult",6790 "description": "",6791 "fields": [6792 {6793 "name": "type",6794 "type": "\"succeeded\"",6795 "required": true,6796 "description": "",6797 "default": "succeeded"6798 },6799 {6800 "name": "message",6801 "type": "BetaMessage",6802 "required": true,6803 "description": ""6804 },6805 {6806 "name": "message.type",6807 "type": "\"message\"",6808 "required": true,6809 "description": "Object type. For Messages, this is always `\"message\"`.",6810 "default": "message"6811 },6812 {6813 "name": "message.id",6814 "type": "string",6815 "required": true,6816 "description": "Unique object identifier. The format and length of IDs may change over time."6817 },6818 {6819 "name": "message.container",6820 "type": "BetaContainer or null",6821 "required": true,6822 "description": "Information about the container used in the request (for the code execution tool)"6823 },6824 {6825 "name": "message.container.id",6826 "type": "string",6827 "required": true,6828 "description": "Identifier for the container used in this request"6829 },6830 {6831 "name": "message.container.expires_at",6832 "type": "string",6833 "required": true,6834 "description": "The time at which the container will expire.",6835 "constraints": {6836 "format": "date-time"6837 }6838 },6839 {6840 "name": "message.container.skills",6841 "type": "array of BetaContainerSkill or null",6842 "required": true,6843 "description": "Skills loaded in the container"6844 },6845 {6846 "name": "message.content",6847 "type": "array of BetaContentBlock",6848 "required": true,6849 "description": "Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{\"type\": \"text\", \"text\": \"Hi, I'm Claude.\"}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {\"role\": \"user\", \"content\": \"What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun\"}, {\"role\": \"assistant\", \"content\": \"The best answer is (\"} ] ``` Then the response `content` might be: ```json [{\"type\": \"text\", \"text\": \"B)\"}] ```"6850 },6851 {6852 "name": "message.context_management",6853 "type": "BetaContextManagementResponse or null",6854 "required": true,6855 "description": "Context management response. Information about context management strategies applied during the request."6856 },6857 {6858 "name": "message.context_management.applied_edits",6859 "type": "array of BetaClearToolUses20250919EditResponse or BetaClearThinking20251015EditResponse",6860 "required": true,6861 "description": "List of context management edits that were applied."6862 },6863 {6864 "name": "message.diagnostics",6865 "type": "BetaDiagnostics or null",6866 "required": true,6867 "description": "Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request."6868 },6869 {6870 "name": "message.diagnostics.cache_miss_reason",6871 "type": "BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more or null",6872 "required": true,6873 "description": "Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed."6874 },6875 {6876 "name": "message.model",6877 "type": "Model",6878 "required": true,6879 "description": "The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."6880 },6881 {6882 "name": "message.role",6883 "type": "\"assistant\"",6884 "required": true,6885 "description": "Conversational role of the generated message. This will always be `\"assistant\"`.",6886 "default": "assistant"6887 },6888 {6889 "name": "message.stop_details",6890 "type": "BetaRefusalStopDetails or null",6891 "required": true,6892 "description": "Structured information about a refusal."6893 },6894 {6895 "name": "message.stop_details.type",6896 "type": "\"refusal\"",6897 "required": true,6898 "description": "",6899 "default": "refusal"6900 },6901 {6902 "name": "message.stop_details.category",6903 "type": "\"cyber\" or \"bio\" or \"frontier_llm\" or 2 more or null",6904 "required": true,6905 "description": "The policy category that triggered a refusal.",6906 "enum": [6907 "cyber",6908 "bio",6909 "frontier_llm",6910 "reasoning_extraction",6911 "general_harms"6912 ]6913 },6914 {6915 "name": "message.stop_details.explanation",6916 "type": "string or null",6917 "required": true,6918 "description": "Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category."6919 },6920 {6921 "name": "message.stop_details.fallback_credit_token",6922 "type": "string or null",6923 "required": true,6924 "description": "Opaque code that refunds the cache-miss cost when retrying this refused request on the fallback model. Pass it as `fallback_credit_token` on the retry request. Expires 5 minutes after the refusal. The retry is sent either with the same request body (`system`, `messages`, `tools`, and other render-shaping fields), or with the same body plus one appended `assistant` message whose content is the partial text (with any trailing whitespace stripped from the final text block) and paired server-tool blocks from this refusal — which also authorizes that appended turn as an assistant-prefill continuation on models that otherwise disallow prefill. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed the second way — if a same-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry the second way instead. Either way: same workspace, same platform; a mismatch is a 400. Resending a token for an already-warm prefix is permitted but yields no additional credit. `null` when the refused model isn't eligible for a fallback credit."6925 },6926 {6927 "name": "message.stop_details.fallback_has_prefill_claim",6928 "type": "boolean or null",6929 "required": true,6930 "description": "Whether the accompanying `fallback_credit_token` may be redeemed with the appended-assistant retry form. Only set when `fallback_credit_token` is present. `true`: retry by resending the same request body plus one appended `assistant` message whose content is this response's `content` with any trailing whitespace stripped from the final text block and unpaired `tool_use` blocks omitted (the same appended-turn shape described on `fallback_credit_token`), with the token attached. `false`: retry by resending the original request body unchanged, with the token attached — the appended-assistant form is not available for this refusal (no continuable partial content, or the request uses `output_format` or a `tool_choice` that forces tool use). One exception: when the request used `output_format` or a forced `tool_choice` and the refusal arrived after server tools (including MCP connector tools) had already executed, the token may not be redeemable by either retry form; if the exact-body retry is then rejected with a 400 saying the token must be redeemed by continuing the partial response, discard the token and retry without it. Advisory: if an appended-assistant retry is rejected with a 400 despite `true`, fall back to resending the original request body with the token."6931 },6932 {6933 "name": "message.stop_details.recommended_model",6934 "type": "string or null",6935 "required": true,6936 "description": "The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise."6937 },6938 {6939 "name": "message.stop_reason",6940 "type": "BetaStopReason or null",6941 "required": true,6942 "description": "The reason that we stopped. This may be one the following values: * `\"end_turn\"`: the model reached a natural stopping point * `\"max_tokens\"`: we exceeded the requested `max_tokens` or the model's maximum * `\"stop_sequence\"`: one of your provided custom `stop_sequences` was generated * `\"tool_use\"`: the model invoked one or more tools * `\"pause_turn\"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `\"refusal\"`: when streaming classifiers intervene to handle potential policy violations * `\"model_context_window_exceeded\"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise.",6943 "enum": [6944 "end_turn",6945 "max_tokens",6946 "stop_sequence",6947 "tool_use",6948 "pause_turn",6949 "compaction",6950 "refusal",6951 "model_context_window_exceeded"6952 ]6953 },6954 {6955 "name": "message.stop_sequence",6956 "type": "string or null",6957 "required": true,6958 "description": "Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated."6959 },6960 {6961 "name": "message.usage",6962 "type": "BetaUsage",6963 "required": true,6964 "description": "Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`."6965 },6966 {6967 "name": "message.usage.cache_creation",6968 "type": "BetaCacheCreation or null",6969 "required": true,6970 "description": "Breakdown of cached tokens by TTL"6971 },6972 {6973 "name": "message.usage.cache_creation_input_tokens",6974 "type": "number or null",6975 "required": true,6976 "description": "The number of input tokens used to create the cache entry.",6977 "minimum": 06978 },6979 {6980 "name": "message.usage.cache_read_input_tokens",6981 "type": "number or null",6982 "required": true,6983 "description": "The number of input tokens read from the cache.",6984 "minimum": 06985 },6986 {6987 "name": "message.usage.fallback_credit",6988 "type": "BetaFallbackCreditUsage or null",6989 "required": true,6990 "description": "Outcome of the `fallback_credit_token` presented on this request."6991 },6992 {6993 "name": "message.usage.inference_geo",6994 "type": "string or null",6995 "required": true,6996 "description": "The geographic region where inference was performed for this request."6997 },6998 {6999 "name": "message.usage.input_tokens",7000 "type": "number",7001 "required": true,7002 "description": "The number of input tokens which were used.",7003 "minimum": 07004 },7005 {7006 "name": "message.usage.iterations",7007 "type": "BetaIterationsUsage or null",7008 "required": true,7009 "description": "Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results."7010 },7011 {7012 "name": "message.usage.output_tokens",7013 "type": "number",7014 "required": true,7015 "description": "The number of output tokens which were used.",7016 "minimum": 07017 },7018 {7019 "name": "message.usage.output_tokens_details",7020 "type": "BetaOutputTokensDetails or null",7021 "required": true,7022 "description": "Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you."7023 },7024 {7025 "name": "message.usage.server_tool_use",7026 "type": "BetaServerToolUsage or null",7027 "required": true,7028 "description": "The number of server tool requests."7029 },7030 {7031 "name": "message.usage.service_tier",7032 "type": "\"standard\" or \"priority\" or \"batch\" or null",7033 "required": true,7034 "description": "If the request used the priority, standard, or batch tier.",7035 "enum": [7036 "standard",7037 "priority",7038 "batch"7039 ]7040 },7041 {7042 "name": "message.usage.speed",7043 "type": "\"standard\" or \"fast\" or null",7044 "required": true,7045 "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",7046 "enum": [7047 "standard",7048 "fast"7049 ]7050 },7051 {7052 "name": "message.input_transformations",7053 "type": "array of BetaInputTransformation or null",7054 "required": false,7055 "description": "Changes the API made to the request's input before showing it to the model, and blocks that failed a binding check but were left unchanged: one entry per block, in request order. Two entry types today. `thinking_dropped` — a `thinking`, `redacted_thinking` or `connector_text` block from the request's `messages` that was removed from the prompt instead of being shown to the model because it failed a binding check. `thinking_mismatch_allowed` — a `thinking` or `redacted_thinking` block that failed the conversation check (the conversation before it differs from the one it was created in, or it carries no record of one on a model that requires it) and was shown to the model all the same, because that check is not enforced for this request. More entry types may be added over time; ignore types you do not recognize. Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on every such response from a model that supports extended thinking, as `[]` when there is no entry to report; without the beta, blocks are removed or left in place all the same but nothing is reported. Removed blocks contribute nothing to `usage.input_tokens`; blocks left in place count as sent. When streaming, the array is final in `message_start`; the final `message_delta` event carries it only when a server-side model fallback happened mid-stream, in which case it holds the serving model's entries and replaces the one in `message_start`."7056 }7057 ],7058 "status": [7059 "DOCUMENTED"7060 ],7061 "sources": [7062 {7063 "url": "https://platform.claude.com/docs/en/api/beta/messages/batches",7064 "retrieved_at": "2026-09-18"7065 }7066 ]7067 },7068 {7069 "provider": "anthropic",7070 "api_family": "skills",7071 "name": "Beta Skill Source",7072 "official_type_name": "BetaSkillSource",7073 "description": "",7074 "fields": [7075 {7076 "name": "type",7077 "type": "\"custom\" or \"anthropic\" or \"anthropic_example\" or \"plugin\"",7078 "required": true,7079 "description": "Where the Skill comes from. Possible values: * `\"custom\"`: authored by the platform user; private to their workspace * `\"anthropic\"`: published by Anthropic; shared and read-only * `\"anthropic_example\"`: Anthropic-published sample Skill * `\"plugin\"`: resolved from an installed plugin",7080 "enum": [7081 "custom",7082 "anthropic",7083 "anthropic_example",7084 "plugin"7085 ]7086 }7087 ],7088 "status": [7089 "DOCUMENTED"7090 ],7091 "sources": [7092 {7093 "url": "https://platform.claude.com/docs/en/api/beta/skills",7094 "retrieved_at": "2026-09-18"7095 }7096 ]7097 },7098 {7099 "provider": "anthropic",7100 "api_family": "admin",7101 "name": "Beta Organization Role",7102 "official_type_name": "BetaOrganizationRole",7103 "description": "",7104 "fields": [],7105 "status": [7106 "DOCUMENTED"7107 ],7108 "sources": [7109 {7110 "url": "https://platform.claude.com/docs/en/api/beta/organization",7111 "retrieved_at": "2026-09-18"7112 }7113 ],7114 "enum": [7115 "admin",7116 "billing",7117 "claude_code_user",7118 "developer",7119 "managed",7120 "membership_admin",7121 "owner",7122 "primary_owner",7123 "user"7124 ],7125 "union_of": "\"admin\" or \"billing\" or \"claude_code_user\" or 6 more"7126 },7127 {7128 "provider": "anthropic",7129 "api_family": "admin",7130 "name": "User Remove Response",7131 "official_type_name": "UserRemoveResponse",7132 "description": "",7133 "fields": [7134 {7135 "name": "type",7136 "type": "\"user_deleted\"",7137 "required": true,7138 "description": "Deleted object type. For Users, this is always `\"user_deleted\"`.",7139 "default": "user_deleted"7140 },7141 {7142 "name": "id",7143 "type": "string",7144 "required": true,7145 "description": "ID of the User."7146 }7147 ],7148 "status": [7149 "DOCUMENTED"7150 ],7151 "sources": [7152 {7153 "url": "https://platform.claude.com/docs/en/api/beta/organization/users",7154 "retrieved_at": "2026-09-18"7155 }7156 ]7157 },7158 {7159 "provider": "anthropic",7160 "api_family": "admin",7161 "name": "Invite Delete Response",7162 "official_type_name": "InviteDeleteResponse",7163 "description": "",7164 "fields": [7165 {7166 "name": "type",7167 "type": "\"invite_deleted\"",7168 "required": true,7169 "description": "Deleted object type. For Invites, this is always `\"invite_deleted\"`.",7170 "default": "invite_deleted"7171 },7172 {7173 "name": "id",7174 "type": "string",7175 "required": true,7176 "description": "ID of the Invite."7177 }7178 ],7179 "status": [7180 "DOCUMENTED"7181 ],7182 "sources": [7183 {7184 "url": "https://platform.claude.com/docs/en/api/beta/organization/invites",7185 "retrieved_at": "2026-09-18"7186 }7187 ]7188 },7189 {7190 "provider": "anthropic",7191 "api_family": "admin",7192 "name": "Beta Allowed Inference Geo",7193 "official_type_name": "BetaAllowedInferenceGeo",7194 "description": "",7195 "fields": [],7196 "status": [7197 "DOCUMENTED"7198 ],7199 "sources": [7200 {7201 "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces",7202 "retrieved_at": "2026-09-18"7203 }7204 ],7205 "enum": [7206 "global",7207 "us"7208 ],7209 "union_of": "\"global\" or \"us\""7210 },7211 {7212 "provider": "anthropic",7213 "api_family": "admin",7214 "name": "Beta Data Residency",7215 "official_type_name": "BetaDataResidency",7216 "description": "",7217 "fields": [7218 {7219 "name": "allowed_inference_geos",7220 "type": "array of BetaAllowedInferenceGeo or \"unrestricted\"",7221 "required": true,7222 "description": "Permitted inference geo values. 'unrestricted' means all geos are allowed."7223 },7224 {7225 "name": "default_inference_geo",7226 "type": "\"global\" or \"us\"",7227 "required": true,7228 "description": "Default inference geo applied when requests omit the parameter.",7229 "enum": [7230 "global",7231 "us"7232 ]7233 },7234 {7235 "name": "workspace_geo",7236 "type": "\"us\"",7237 "required": true,7238 "description": "Geographic region for workspace data storage. Immutable after creation."7239 }7240 ],7241 "status": [7242 "DOCUMENTED"7243 ],7244 "sources": [7245 {7246 "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces",7247 "retrieved_at": "2026-09-18"7248 }7249 ]7250 },7251 {7252 "provider": "anthropic",7253 "api_family": "admin",7254 "name": "Beta Data Residency Create Config",7255 "official_type_name": "BetaDataResidencyCreateConfig",7256 "description": "",7257 "fields": [7258 {7259 "name": "allowed_inference_geos",7260 "type": "array of BetaAllowedInferenceGeo or \"unrestricted\" or null",7261 "required": false,7262 "description": "Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos."7263 },7264 {7265 "name": "default_inference_geo",7266 "type": "\"global\" or \"us\" or null",7267 "required": false,7268 "description": "Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `\"unrestricted\"`.",7269 "enum": [7270 "global",7271 "us"7272 ]7273 },7274 {7275 "name": "workspace_geo",7276 "type": "\"us\" or null",7277 "required": false,7278 "description": "Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted."7279 }7280 ],7281 "status": [7282 "DOCUMENTED"7283 ],7284 "sources": [7285 {7286 "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces",7287 "retrieved_at": "2026-09-18"7288 }7289 ]7290 },7291 {7292 "provider": "anthropic",7293 "api_family": "admin",7294 "name": "Beta Data Residency Update Config",7295 "official_type_name": "BetaDataResidencyUpdateConfig",7296 "description": "",7297 "fields": [7298 {7299 "name": "allowed_inference_geos",7300 "type": "array of BetaAllowedInferenceGeo or \"unrestricted\" or null",7301 "required": false,7302 "description": "Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos."7303 },7304 {7305 "name": "default_inference_geo",7306 "type": "\"global\" or \"us\" or null",7307 "required": false,7308 "description": "Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `\"unrestricted\"`.",7309 "enum": [7310 "global",7311 "us"7312 ]7313 }7314 ],7315 "status": [7316 "DOCUMENTED"7317 ],7318 "sources": [7319 {7320 "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces",7321 "retrieved_at": "2026-09-18"7322 }7323 ]7324 },7325 {7326 "provider": "anthropic",7327 "api_family": "admin",7328 "name": "Beta No Billing Workspace Role",7329 "official_type_name": "BetaNoBillingWorkspaceRole",7330 "description": "",7331 "fields": [],7332 "status": [7333 "DOCUMENTED"7334 ],7335 "sources": [7336 {7337 "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces",7338 "retrieved_at": "2026-09-18"7339 }7340 ],7341 "enum": [7342 "workspace_admin",7343 "workspace_developer",7344 "workspace_restricted_developer",7345 "workspace_user"7346 ],7347 "union_of": "\"workspace_admin\" or \"workspace_developer\" or \"workspace_restricted_developer\" or \"workspace_user\""7348 },7349 {7350 "provider": "anthropic",7351 "api_family": "admin",7352 "name": "Beta Workspace Role",7353 "official_type_name": "BetaWorkspaceRole",7354 "description": "",7355 "fields": [],7356 "status": [7357 "DOCUMENTED"7358 ],7359 "sources": [7360 {7361 "url": "https://platform.claude.com/docs/en/api/beta/organization/workspaces",7362 "retrieved_at": "2026-09-18"7363 }7364 ],7365 "enum": [7366 "workspace_admin",7367 "workspace_billing",7368 "workspace_developer",7369 "workspace_restricted_developer",7370 "workspace_user"7371 ],7372 "union_of": "\"workspace_admin\" or \"workspace_billing\" or \"workspace_developer\" or 2 more"7373 },7374 {7375 "provider": "anthropic",7376 "api_family": "admin",7377 "name": "Beta API Key Created By",7378 "official_type_name": "BetaAPIKeyCreatedBy",7379 "description": "",7380 "fields": [7381 {7382 "name": "type",7383 "type": "\"service_account\" or \"user\"",7384 "required": true,7385 "description": "Type of the actor that created the object.",7386 "enum": [7387 "service_account",7388 "user"7389 ]7390 },7391 {7392 "name": "id",7393 "type": "string",7394 "required": true,7395 "description": "ID of the actor that created the object."7396 }7397 ],7398 "status": [7399 "DOCUMENTED"7400 ],7401 "sources": [7402 {7403 "url": "https://platform.claude.com/docs/en/api/beta/organization/api_keys",7404 "retrieved_at": "2026-09-18"7405 }7406 ]7407 },7408 {7409 "provider": "anthropic",7410 "api_family": "admin",7411 "name": "Beta API Key Organization Scope",7412 "official_type_name": "BetaAPIKeyOrganizationScope",7413 "description": "",7414 "fields": [7415 {7416 "name": "type",7417 "type": "\"organization\"",7418 "required": true,7419 "description": "Scope type. Always `\"organization\"`: the API key has no Workspace. Only a principal-bound API key can have this scope.",7420 "default": "organization"7421 }7422 ],7423 "status": [7424 "DOCUMENTED"7425 ],7426 "sources": [7427 {7428 "url": "https://platform.claude.com/docs/en/api/beta/organization/api_keys",7429 "retrieved_at": "2026-09-18"7430 }7431 ]7432 },7433 {7434 "provider": "anthropic",7435 "api_family": "admin",7436 "name": "Beta API Key Service Account Actor",7437 "official_type_name": "BetaAPIKeyServiceAccountActor",7438 "description": "",7439 "fields": [7440 {7441 "name": "type",7442 "type": "\"service_account_actor\"",7443 "required": true,7444 "description": "Principal type. Always `\"service_account_actor\"` for a Service Account.",7445 "default": "service_account_actor"7446 },7447 {7448 "name": "service_account_id",7449 "type": "string",7450 "required": true,7451 "description": "ID of the Service Account the API key acts as."7452 }7453 ],7454 "status": [7455 "DOCUMENTED"7456 ],7457 "sources": [7458 {7459 "url": "https://platform.claude.com/docs/en/api/beta/organization/api_keys",7460 "retrieved_at": "2026-09-18"7461 }7462 ]7463 },7464 {7465 "provider": "anthropic",7466 "api_family": "admin",7467 "name": "Beta API Key User Actor",7468 "official_type_name": "BetaAPIKeyUserActor",7469 "description": "",7470 "fields": [7471 {7472 "name": "type",7473 "type": "\"user_actor\"",7474 "required": true,7475 "description": "Principal type. Always `\"user_actor\"` for a User.",7476 "default": "user_actor"7477 },7478 {7479 "name": "user_id",7480 "type": "string",7481 "required": true,7482 "description": "ID of the User the API key acts as."7483 }7484 ],7485 "status": [7486 "DOCUMENTED"7487 ],7488 "sources": [7489 {7490 "url": "https://platform.claude.com/docs/en/api/beta/organization/api_keys",7491 "retrieved_at": "2026-09-18"7492 }7493 ]7494 },7495 {7496 "provider": "anthropic",7497 "api_family": "admin",7498 "name": "Beta API Key Workspace Scope",7499 "official_type_name": "BetaAPIKeyWorkspaceScope",7500 "description": "",7501 "fields": [7502 {7503 "name": "type",7504 "type": "\"workspace\"",7505 "required": true,7506 "description": "Scope type. Always `\"workspace\"`: the API key belongs to one Workspace.",7507 "default": "workspace"7508 },7509 {7510 "name": "workspace_id",7511 "type": "string",7512 "required": true,7513 "description": "ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace."7514 }7515 ],7516 "status": [7517 "DOCUMENTED"7518 ],7519 "sources": [7520 {7521 "url": "https://platform.claude.com/docs/en/api/beta/organization/api_keys",7522 "retrieved_at": "2026-09-18"7523 }7524 ]7525 },7526 {7527 "provider": "anthropic",7528 "api_family": "admin",7529 "name": "Beta Spend Summary",7530 "official_type_name": "BetaSpendSummary",7531 "description": "Per-member effective-limit report row (`GET /spend_limits/effective`).",7532 "fields": [7533 {7534 "name": "actor",7535 "type": "UserActor or ScopedAPIKeyActor",7536 "required": true,7537 "description": ""7538 },7539 {7540 "name": "actor.type",7541 "type": "\"user_actor\"",7542 "required": true,7543 "description": "Actor type. Always `user_actor`.",7544 "default": "user_actor"7545 },7546 {7547 "name": "actor.deleted",7548 "type": "boolean",7549 "required": true,7550 "description": "True only when the underlying account has been deleted.",7551 "default": "false"7552 },7553 {7554 "name": "actor.email_address",7555 "type": "string or null",7556 "required": true,7557 "description": "The user's email address. Null when the account is unavailable or has been deleted."7558 },7559 {7560 "name": "actor.name",7561 "type": "string or null",7562 "required": true,7563 "description": "The user's current display name. Null when the account is unavailable, has been deleted, or has no name set."7564 },7565 {7566 "name": "actor.user_id",7567 "type": "string",7568 "required": true,7569 "description": "Tagged ID of the user."7570 },7571 {7572 "name": "actor.type",7573 "type": "\"scoped_api_key_actor\"",7574 "required": true,7575 "description": "",7576 "default": "scoped_api_key_actor"7577 },7578 {7579 "name": "actor.scoped_api_key_id",7580 "type": "string",7581 "required": true,7582 "description": ""7583 },7584 {7585 "name": "amount",7586 "type": "string or null",7587 "required": true,7588 "description": "Effective limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD). `null` means no limit applies for this row's `period` — each period resolves independently, so another period may still cap this member."7589 },7590 {7591 "name": "currency",7592 "type": "string",7593 "required": true,7594 "description": "ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`."7595 },7596 {7597 "name": "period",7598 "type": "\"daily\" or \"monthly\" or \"weekly\"",7599 "required": true,7600 "description": "Period this row's effective limit and spend are reported for.",7601 "enum": [7602 "daily",7603 "monthly",7604 "weekly"7605 ]7606 },7607 {7608 "name": "period_to_date_spend",7609 "type": "string",7610 "required": true,7611 "description": "The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `\"12050.5\"`) — metered usage is not rounded to whole cents. Reads as `\"0\"` when the spend reading is temporarily unavailable."7612 },7613 {7614 "name": "scope",7615 "type": "User or SeatTier or RBACGroup or 3 more",7616 "required": true,7617 "description": ""7618 },7619 {7620 "name": "scope.type",7621 "type": "\"user\"",7622 "required": true,7623 "description": "Scope type. Always `user` for this scope.",7624 "default": "user"7625 },7626 {7627 "name": "scope.user_id",7628 "type": "string",7629 "required": true,7630 "description": "Tagged ID of the member the spend limit applies to."7631 },7632 {7633 "name": "scope.type",7634 "type": "\"seat_tier\"",7635 "required": true,7636 "description": "",7637 "default": "seat_tier"7638 },7639 {7640 "name": "scope.seat_tier",7641 "type": "string",7642 "required": true,7643 "description": ""7644 },7645 {7646 "name": "scope.type",7647 "type": "\"rbac_group\"",7648 "required": true,7649 "description": "",7650 "default": "rbac_group"7651 },7652 {7653 "name": "scope.rbac_group_id",7654 "type": "string",7655 "required": true,7656 "description": ""7657 },7658 {7659 "name": "scope.type",7660 "type": "\"organization_service\"",7661 "required": true,7662 "description": "",7663 "default": "organization_service"7664 },7665 {7666 "name": "scope.service",7667 "type": "string",7668 "required": true,7669 "description": ""7670 },7671 {7672 "name": "scope.type",7673 "type": "\"organization\"",7674 "required": true,7675 "description": "",7676 "default": "organization"7677 },7678 {7679 "name": "scope.type",7680 "type": "\"workspace\"",7681 "required": true,7682 "description": "Scope type. Always `workspace` for this scope.",7683 "default": "workspace"7684 },7685 {7686 "name": "scope.workspace_id",7687 "type": "string",7688 "required": true,7689 "description": "Tagged ID of the workspace the spend limit applies to."7690 },7691 {7692 "name": "source",7693 "type": "User or SeatTier or RBACGroup or 3 more",7694 "required": true,7695 "description": ""7696 },7697 {7698 "name": "source.type",7699 "type": "\"user\"",7700 "required": true,7701 "description": "Scope type. Always `user` for this scope.",7702 "default": "user"7703 },7704 {7705 "name": "source.user_id",7706 "type": "string",7707 "required": true,7708 "description": "Tagged ID of the member the spend limit applies to."7709 },7710 {7711 "name": "source.type",7712 "type": "\"seat_tier\"",7713 "required": true,7714 "description": "",7715 "default": "seat_tier"7716 },7717 {7718 "name": "source.seat_tier",7719 "type": "string",7720 "required": true,7721 "description": ""7722 },7723 {7724 "name": "source.type",7725 "type": "\"rbac_group\"",7726 "required": true,7727 "description": "",7728 "default": "rbac_group"7729 },7730 {7731 "name": "source.rbac_group_id",7732 "type": "string",7733 "required": true,7734 "description": ""7735 },7736 {7737 "name": "source.type",7738 "type": "\"organization_service\"",7739 "required": true,7740 "description": "",7741 "default": "organization_service"7742 },7743 {7744 "name": "source.service",7745 "type": "string",7746 "required": true,7747 "description": ""7748 },7749 {7750 "name": "source.type",7751 "type": "\"organization\"",7752 "required": true,7753 "description": "",7754 "default": "organization"7755 },7756 {7757 "name": "source.type",7758 "type": "\"workspace\"",7759 "required": true,7760 "description": "Scope type. Always `workspace` for this scope.",7761 "default": "workspace"7762 },7763 {7764 "name": "source.workspace_id",7765 "type": "string",7766 "required": true,7767 "description": "Tagged ID of the workspace the spend limit applies to."7768 },7769 {7770 "name": "spend_limit_id",7771 "type": "string",7772 "required": true,7773 "description": ""7774 }7775 ],7776 "status": [7777 "DOCUMENTED"7778 ],7779 "sources": [7780 {7781 "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits",7782 "retrieved_at": "2026-09-18"7783 }7784 ]7785 },7786 {7787 "provider": "anthropic",7788 "api_family": "admin",7789 "name": "Spend Limit Delete Response",7790 "official_type_name": "SpendLimitDeleteResponse",7791 "description": "",7792 "fields": [7793 {7794 "name": "type",7795 "type": "\"spend_limit_deleted\"",7796 "required": true,7797 "description": "",7798 "default": "spend_limit_deleted"7799 },7800 {7801 "name": "id",7802 "type": "string",7803 "required": true,7804 "description": ""7805 }7806 ],7807 "status": [7808 "DOCUMENTED"7809 ],7810 "sources": [7811 {7812 "url": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits",7813 "retrieved_at": "2026-09-18"7814 }7815 ]7816 },7817 {7818 "provider": "anthropic",7819 "api_family": "admin",7820 "name": "Beta Organization Rate Limit",7821 "official_type_name": "BetaOrganizationRateLimit",7822 "description": "",7823 "fields": [7824 {7825 "name": "type",7826 "type": "\"rate_limit\"",7827 "required": true,7828 "description": "Object type. Always `rate_limit` for organization rate-limit entries.",7829 "default": "rate_limit"7830 },7831 {7832 "name": "id",7833 "type": "string",7834 "required": true,7835 "description": "Stable identifier for this rate-limit group within the organization."7836 },7837 {7838 "name": "group_type",7839 "type": "\"batch\" or \"files\" or \"model_group\" or 3 more",7840 "required": true,7841 "description": "The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.",7842 "enum": [7843 "batch",7844 "files",7845 "model_group",7846 "skills",7847 "token_count",7848 "web_search"7849 ]7850 },7851 {7852 "name": "limits",7853 "type": "array of BetaOrganizationRateLimitValue",7854 "required": true,7855 "description": "The limiter values that apply to this group."7856 },7857 {7858 "name": "limits[].type",7859 "type": "string",7860 "required": true,7861 "description": "The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`)."7862 },7863 {7864 "name": "limits[].value",7865 "type": "number",7866 "required": true,7867 "description": "The configured limit value for this limiter type."7868 },7869 {7870 "name": "models",7871 "type": "array of string or null",7872 "required": true,7873 "description": "Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `\"model_group\"`."7874 }7875 ],7876 "status": [7877 "DOCUMENTED"7878 ],7879 "sources": [7880 {7881 "url": "https://platform.claude.com/docs/en/api/beta/organization/rate_limits",7882 "retrieved_at": "2026-09-18"7883 }7884 ]7885 },7886 {7887 "provider": "anthropic",7888 "api_family": "admin",7889 "name": "Beta Organization Rate Limit Value",7890 "official_type_name": "BetaOrganizationRateLimitValue",7891 "description": "",7892 "fields": [7893 {7894 "name": "type",7895 "type": "string",7896 "required": true,7897 "description": "The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`)."7898 },7899 {7900 "name": "value",7901 "type": "number",7902 "required": true,7903 "description": "The configured limit value for this limiter type."7904 }7905 ],7906 "status": [7907 "DOCUMENTED"7908 ],7909 "sources": [7910 {7911 "url": "https://platform.claude.com/docs/en/api/beta/organization/rate_limits",7912 "retrieved_at": "2026-09-18"7913 }7914 ]7915 },7916 {7917 "provider": "anthropic",7918 "api_family": "admin",7919 "name": "Beta Analytics User",7920 "official_type_name": "BetaAnalyticsUser",7921 "description": "A user in the organization, identified by tagged id and email address.",7922 "fields": [7923 {7924 "name": "type",7925 "type": "\"user\"",7926 "required": true,7927 "description": "Object type. Always `user`.",7928 "default": "user"7929 },7930 {7931 "name": "id",7932 "type": "string",7933 "required": true,7934 "description": "Tagged user identifier (e.g. `user_...`)"7935 },7936 {7937 "name": "email_address",7938 "type": "string",7939 "required": true,7940 "description": "Email address of the user"7941 }7942 ],7943 "status": [7944 "DOCUMENTED"7945 ],7946 "sources": [7947 {7948 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics",7949 "retrieved_at": "2026-09-18"7950 }7951 ]7952 },7953 {7954 "provider": "anthropic",7955 "api_family": "admin",7956 "name": "Beta Analytics User Actor",7957 "official_type_name": "BetaAnalyticsUserActor",7958 "description": "",7959 "fields": [7960 {7961 "name": "type",7962 "type": "\"user_actor\"",7963 "required": true,7964 "description": "Actor type. Always `\"user_actor\"`."7965 },7966 {7967 "name": "deleted",7968 "type": "boolean",7969 "required": true,7970 "description": "True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation."7971 },7972 {7973 "name": "email",7974 "type": "string or null",7975 "required": true,7976 "description": "The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`)."7977 },7978 {7979 "name": "name",7980 "type": "string or null",7981 "required": true,7982 "description": "The user's full name. Null when the user has not set a name. Returns `\"Deleted User\"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `\"Claude Security\"` for usage by Anthropic's security-patching service) or null."7983 },7984 {7985 "name": "user_id",7986 "type": "string",7987 "required": true,7988 "description": "Tagged user ID."7989 }7990 ],7991 "status": [7992 "DOCUMENTED"7993 ],7994 "sources": [7995 {7996 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics",7997 "retrieved_at": "2026-09-18"7998 }7999 ]8000 },8001 {8002 "provider": "anthropic",8003 "api_family": "admin",8004 "name": "Beta Connector Office Product Metrics",8005 "official_type_name": "BetaConnectorOfficeProductMetrics",8006 "description": "Office Agent activity metrics for a single connector on a given day within one Office product.",8007 "fields": [8008 {8009 "name": "distinct_session_connector_used_count",8010 "type": "number or null",8011 "required": true,8012 "description": "Number of distinct Office Agent sessions in which the connector was used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."8013 }8014 ],8015 "status": [8016 "DOCUMENTED"8017 ],8018 "sources": [8019 {8020 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics",8021 "retrieved_at": "2026-09-18"8022 }8023 ]8024 },8025 {8026 "provider": "anthropic",8027 "api_family": "admin",8028 "name": "Beta Office Product Metrics",8029 "official_type_name": "BetaOfficeProductMetrics",8030 "description": "Office Agent activity metrics for a single user on a given day within one Office product.",8031 "fields": [8032 {8033 "name": "connectors_used_count",8034 "type": "number",8035 "required": true,8036 "description": "Number of MCP connector invocations"8037 },8038 {8039 "name": "distinct_connectors_used_count",8040 "type": "number or null",8041 "required": true,8042 "description": "Number of distinct MCP connectors used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."8043 },8044 {8045 "name": "distinct_session_count",8046 "type": "number or null",8047 "required": true,8048 "description": "Number of distinct Office Agent sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."8049 },8050 {8051 "name": "distinct_skills_used_count",8052 "type": "number or null",8053 "required": true,8054 "description": "Number of distinct skills used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."8055 },8056 {8057 "name": "message_count",8058 "type": "number",8059 "required": true,8060 "description": "Number of messages sent"8061 },8062 {8063 "name": "skills_used_count",8064 "type": "number",8065 "required": true,8066 "description": "Number of skill invocations"8067 }8068 ],8069 "status": [8070 "DOCUMENTED"8071 ],8072 "sources": [8073 {8074 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics",8075 "retrieved_at": "2026-09-18"8076 }8077 ]8078 },8079 {8080 "provider": "anthropic",8081 "api_family": "admin",8082 "name": "Beta Skill Office Product Metrics",8083 "official_type_name": "BetaSkillOfficeProductMetrics",8084 "description": "Office Agent activity metrics for a single skill on a given day within one Office product.",8085 "fields": [8086 {8087 "name": "distinct_session_skill_used_count",8088 "type": "number or null",8089 "required": true,8090 "description": "Number of distinct Office Agent sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed."8091 }8092 ],8093 "status": [8094 "DOCUMENTED"8095 ],8096 "sources": [8097 {8098 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics",8099 "retrieved_at": "2026-09-18"8100 }8101 ]8102 },8103 {8104 "provider": "anthropic",8105 "api_family": "admin",8106 "name": "Beta Tool Action Counts",8107 "official_type_name": "BetaToolActionCounts",8108 "description": "Accepted/rejected counts for a single Claude Code tool type.",8109 "fields": [8110 {8111 "name": "accepted_count",8112 "type": "number",8113 "required": true,8114 "description": "Number of tool proposals accepted"8115 },8116 {8117 "name": "rejected_count",8118 "type": "number",8119 "required": true,8120 "description": "Number of tool proposals rejected"8121 }8122 ],8123 "status": [8124 "DOCUMENTED"8125 ],8126 "sources": [8127 {8128 "url": "https://platform.claude.com/docs/en/api/beta/organization/analytics",8129 "retrieved_at": "2026-09-18"8130 }8131 ]8132 },8133 {8134 "provider": "anthropic",8135 "api_family": "admin",8136 "name": "Beta AWS External Key Config",8137 "official_type_name": "BetaAWSExternalKeyConfig",8138 "description": "",8139 "fields": [8140 {8141 "name": "type",8142 "type": "\"aws\"",8143 "required": true,8144 "description": ""8145 },8146 {8147 "name": "kms_arn",8148 "type": "string",8149 "required": true,8150 "description": "Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.",8151 "constraints": {8152 "maxLength": "2048"8153 }8154 },8155 {8156 "name": "region",8157 "type": "string or null",8158 "required": false,8159 "description": "AWS region. Derived from `kms_arn` if omitted."8160 },8161 {8162 "name": "role_arn",8163 "type": "string or null",8164 "required": false,8165 "description": "**Deprecated** IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored."8166 }8167 ],8168 "status": [8169 "DOCUMENTED"8170 ],8171 "sources": [8172 {8173 "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys",8174 "retrieved_at": "2026-09-18"8175 }8176 ]8177 },8178 {8179 "provider": "anthropic",8180 "api_family": "admin",8181 "name": "Beta Azure External Key Config",8182 "official_type_name": "BetaAzureExternalKeyConfig",8183 "description": "",8184 "fields": [8185 {8186 "name": "type",8187 "type": "\"azure\"",8188 "required": true,8189 "description": ""8190 },8191 {8192 "name": "key_name",8193 "type": "string",8194 "required": true,8195 "description": "Name of the key within the vault."8196 },8197 {8198 "name": "tenant_id",8199 "type": "string",8200 "required": true,8201 "description": "Azure AD tenant ID."8202 },8203 {8204 "name": "vault_uri",8205 "type": "string",8206 "required": true,8207 "description": "Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`."8208 },8209 {8210 "name": "client_id",8211 "type": "string or null",8212 "required": false,8213 "description": "Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory."8214 }8215 ],8216 "status": [8217 "DOCUMENTED"8218 ],8219 "sources": [8220 {8221 "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys",8222 "retrieved_at": "2026-09-18"8223 }8224 ]8225 },8226 {8227 "provider": "anthropic",8228 "api_family": "admin",8229 "name": "Beta Azure External Key Config Param",8230 "official_type_name": "BetaAzureExternalKeyConfigParam",8231 "description": "Azure Key Vault provider configuration.",8232 "fields": [8233 {8234 "name": "type",8235 "type": "\"azure\"",8236 "required": true,8237 "description": ""8238 },8239 {8240 "name": "key_name",8241 "type": "string",8242 "required": true,8243 "description": "Name of the key within the vault."8244 },8245 {8246 "name": "tenant_id",8247 "type": "string",8248 "required": true,8249 "description": "Azure AD tenant ID."8250 },8251 {8252 "name": "vault_uri",8253 "type": "string",8254 "required": true,8255 "description": "Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`."8256 },8257 {8258 "name": "client_id",8259 "type": "string or null",8260 "required": false,8261 "description": "Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory."8262 }8263 ],8264 "status": [8265 "DOCUMENTED"8266 ],8267 "sources": [8268 {8269 "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys",8270 "retrieved_at": "2026-09-18"8271 }8272 ]8273 },8274 {8275 "provider": "anthropic",8276 "api_family": "admin",8277 "name": "Beta External Key Attached Attachment",8278 "official_type_name": "BetaExternalKeyAttachedAttachment",8279 "description": "",8280 "fields": [8281 {8282 "name": "type",8283 "type": "\"attached\"",8284 "required": true,8285 "description": "",8286 "default": "attached"8287 }8288 ],8289 "status": [8290 "DOCUMENTED"8291 ],8292 "sources": [8293 {8294 "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys",8295 "retrieved_at": "2026-09-18"8296 }8297 ]8298 },8299 {8300 "provider": "anthropic",8301 "api_family": "admin",8302 "name": "Beta External Key Unattached Attachment",8303 "official_type_name": "BetaExternalKeyUnattachedAttachment",8304 "description": "",8305 "fields": [8306 {8307 "name": "type",8308 "type": "\"unattached\"",8309 "required": true,8310 "description": "",8311 "default": "unattached"8312 }8313 ],8314 "status": [8315 "DOCUMENTED"8316 ],8317 "sources": [8318 {8319 "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys",8320 "retrieved_at": "2026-09-18"8321 }8322 ]8323 },8324 {8325 "provider": "anthropic",8326 "api_family": "admin",8327 "name": "Beta GCP External Key Config",8328 "official_type_name": "BetaGCPExternalKeyConfig",8329 "description": "",8330 "fields": [8331 {8332 "name": "type",8333 "type": "\"gcp\"",8334 "required": true,8335 "description": ""8336 },8337 {8338 "name": "key_name",8339 "type": "string",8340 "required": true,8341 "description": "Full resource name of the Cloud KMS key."8342 }8343 ],8344 "status": [8345 "DOCUMENTED"8346 ],8347 "sources": [8348 {8349 "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys",8350 "retrieved_at": "2026-09-18"8351 }8352 ]8353 },8354 {8355 "provider": "anthropic",8356 "api_family": "admin",8357 "name": "External Key Delete Response",8358 "official_type_name": "ExternalKeyDeleteResponse",8359 "description": "",8360 "fields": [8361 {8362 "name": "type",8363 "type": "\"external_key_deleted\"",8364 "required": true,8365 "description": "",8366 "default": "external_key_deleted"8367 },8368 {8369 "name": "id",8370 "type": "string",8371 "required": true,8372 "description": "ID of the deleted External Key."8373 }8374 ],8375 "status": [8376 "DOCUMENTED"8377 ],8378 "sources": [8379 {8380 "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys",8381 "retrieved_at": "2026-09-18"8382 }8383 ]8384 },8385 {8386 "provider": "anthropic",8387 "api_family": "admin",8388 "name": "External Key Validate Response",8389 "official_type_name": "ExternalKeyValidateResponse",8390 "description": "Result of a validation roundtrip against the customer's KMS. HTTP 200 for both outcomes — the operation completed; `status` says whether the key works.",8391 "fields": [8392 {8393 "name": "type",8394 "type": "\"external_key_validation\"",8395 "required": true,8396 "description": "",8397 "default": "external_key_validation"8398 },8399 {8400 "name": "error",8401 "type": "string or null",8402 "required": true,8403 "description": "Error message when status is `failure`. Null otherwise."8404 },8405 {8406 "name": "status",8407 "type": "\"failure\" or \"success\"",8408 "required": true,8409 "description": "`success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`.",8410 "enum": [8411 "failure",8412 "success"8413 ]8414 }8415 ],8416 "status": [8417 "DOCUMENTED"8418 ],8419 "sources": [8420 {8421 "url": "https://platform.claude.com/docs/en/api/beta/organization/external_keys",8422 "retrieved_at": "2026-09-18"8423 }8424 ]8425 },8426 {8427 "provider": "anthropic",8428 "api_family": "admin",8429 "name": "Beta Compliance Settings State",8430 "official_type_name": "BetaComplianceSettingsState",8431 "description": "",8432 "fields": [8433 {8434 "name": "type",8435 "type": "\"enabled\"",8436 "required": true,8437 "description": "",8438 "default": "enabled"8439 },8440 {8441 "name": "type",8442 "type": "\"disabled\"",8443 "required": true,8444 "description": "",8445 "default": "disabled"8446 }8447 ],8448 "status": [8449 "DOCUMENTED"8450 ],8451 "sources": [8452 {8453 "url": "https://platform.claude.com/docs/en/api/beta/organization/compliance_settings",8454 "retrieved_at": "2026-09-18"8455 }8456 ],8457 "union_of": "BetaComplianceSettingsStateEnabled or BetaComplianceSettingsStateDisabled"8458 },8459 {8460 "provider": "anthropic",8461 "api_family": "admin",8462 "name": "Beta Compliance Settings State Disabled",8463 "official_type_name": "BetaComplianceSettingsStateDisabled",8464 "description": "",8465 "fields": [8466 {8467 "name": "type",8468 "type": "\"disabled\"",8469 "required": true,8470 "description": "",8471 "default": "disabled"8472 }8473 ],8474 "status": [8475 "DOCUMENTED"8476 ],8477 "sources": [8478 {8479 "url": "https://platform.claude.com/docs/en/api/beta/organization/compliance_settings",8480 "retrieved_at": "2026-09-18"8481 }8482 ]8483 },8484 {8485 "provider": "anthropic",8486 "api_family": "admin",8487 "name": "Beta Compliance Settings State Disabled Param",8488 "official_type_name": "BetaComplianceSettingsStateDisabledParam",8489 "description": "",8490 "fields": [8491 {8492 "name": "type",8493 "type": "\"disabled\"",8494 "required": true,8495 "description": ""8496 }8497 ],8498 "status": [8499 "DOCUMENTED"8500 ],8501 "sources": [8502 {8503 "url": "https://platform.claude.com/docs/en/api/beta/organization/compliance_settings",8504 "retrieved_at": "2026-09-18"8505 }8506 ]8507 },8508 {8509 "provider": "anthropic",8510 "api_family": "admin",8511 "name": "Beta Compliance Settings State Enabled",8512 "official_type_name": "BetaComplianceSettingsStateEnabled",8513 "description": "",8514 "fields": [8515 {8516 "name": "type",8517 "type": "\"enabled\"",8518 "required": true,8519 "description": "",8520 "default": "enabled"8521 }8522 ],8523 "status": [8524 "DOCUMENTED"8525 ],8526 "sources": [8527 {8528 "url": "https://platform.claude.com/docs/en/api/beta/organization/compliance_settings",8529 "retrieved_at": "2026-09-18"8530 }8531 ]8532 },8533 {8534 "provider": "anthropic",8535 "api_family": "admin",8536 "name": "Beta Compliance Settings State Enabled Param",8537 "official_type_name": "BetaComplianceSettingsStateEnabledParam",8538 "description": "",8539 "fields": [8540 {8541 "name": "type",8542 "type": "\"enabled\"",8543 "required": true,8544 "description": ""8545 }8546 ],8547 "status": [8548 "DOCUMENTED"8549 ],8550 "sources": [8551 {8552 "url": "https://platform.claude.com/docs/en/api/beta/organization/compliance_settings",8553 "retrieved_at": "2026-09-18"8554 }8555 ]8556 },8557 {8558 "provider": "anthropic",8559 "api_family": "admin",8560 "name": "Beta Compliance Settings State Param",8561 "official_type_name": "BetaComplianceSettingsStateParam",8562 "description": "",8563 "fields": [8564 {8565 "name": "type",8566 "type": "\"enabled\"",8567 "required": true,8568 "description": ""8569 },8570 {8571 "name": "type",8572 "type": "\"disabled\"",8573 "required": true,8574 "description": ""8575 }8576 ],8577 "status": [8578 "DOCUMENTED"8579 ],8580 "sources": [8581 {8582 "url": "https://platform.claude.com/docs/en/api/beta/organization/compliance_settings",8583 "retrieved_at": "2026-09-18"8584 }8585 ],8586 "union_of": "BetaComplianceSettingsStateEnabledParam or BetaComplianceSettingsStateDisabledParam"8587 },8588 {8589 "provider": "anthropic",8590 "api_family": "managed-agents",8591 "name": "Agent",8592 "official_type_name": "BetaManagedAgentsAgent",8593 "description": "A Managed Agents `agent`.",8594 "fields": [8595 {8596 "name": "type",8597 "type": "\"agent\"",8598 "required": true,8599 "description": ""8600 },8601 {8602 "name": "id",8603 "type": "string",8604 "required": true,8605 "description": ""8606 },8607 {8608 "name": "archived_at",8609 "type": "string or null",8610 "required": true,8611 "description": "A timestamp in RFC 3339 format",8612 "constraints": {8613 "format": "date-time"8614 }8615 },8616 {8617 "name": "created_at",8618 "type": "string",8619 "required": true,8620 "description": "A timestamp in RFC 3339 format",8621 "constraints": {8622 "format": "date-time"8623 }8624 },8625 {8626 "name": "description",8627 "type": "string or null",8628 "required": true,8629 "description": ""8630 },8631 {8632 "name": "mcp_servers",8633 "type": "array of BetaManagedAgentsMCPServerURLDefinition",8634 "required": true,8635 "description": ""8636 },8637 {8638 "name": "mcp_servers.type",8639 "type": "\"url\"",8640 "required": true,8641 "description": ""8642 },8643 {8644 "name": "mcp_servers.name",8645 "type": "string",8646 "required": true,8647 "description": ""8648 },8649 {8650 "name": "mcp_servers.url",8651 "type": "string",8652 "required": true,8653 "description": ""8654 },8655 {8656 "name": "metadata",8657 "type": "map[string]",8658 "required": true,8659 "description": ""8660 },8661 {8662 "name": "model",8663 "type": "BetaManagedAgentsModelConfig",8664 "required": true,8665 "description": "Model identifier and configuration."8666 },8667 {8668 "name": "model.id",8669 "type": "BetaManagedAgentsModel",8670 "required": true,8671 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."8672 },8673 {8674 "name": "model.id<\"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more>",8675 "type": "\"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more",8676 "required": false,8677 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."8678 },8679 {8680 "name": "model.id<string>",8681 "type": "string",8682 "required": false,8683 "description": ""8684 },8685 {8686 "name": "model.effort",8687 "type": "BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more",8688 "required": false,8689 "description": "How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes."8690 },8691 {8692 "name": "model.effort<BetaManagedAgentsEffortLow>",8693 "type": "BetaManagedAgentsEffortLow object",8694 "required": false,8695 "description": "Low effort. Favors latency over reasoning depth."8696 },8697 {8698 "name": "model.effort<BetaManagedAgentsEffortLow>.type",8699 "type": "\"low\"",8700 "required": true,8701 "description": ""8702 },8703 {8704 "name": "model.effort<BetaManagedAgentsEffortMedium>",8705 "type": "BetaManagedAgentsEffortMedium object",8706 "required": false,8707 "description": "Medium effort. Balances latency and reasoning depth."8708 },8709 {8710 "name": "model.effort<BetaManagedAgentsEffortMedium>.type",8711 "type": "\"medium\"",8712 "required": true,8713 "description": ""8714 },8715 {8716 "name": "model.effort<BetaManagedAgentsEffortHigh>",8717 "type": "BetaManagedAgentsEffortHigh object",8718 "required": false,8719 "description": "High effort. Favors reasoning depth."8720 },8721 {8722 "name": "model.effort<BetaManagedAgentsEffortHigh>.type",8723 "type": "\"high\"",8724 "required": true,8725 "description": ""8726 },8727 {8728 "name": "model.effort<BetaManagedAgentsEffortXhigh>",8729 "type": "BetaManagedAgentsEffortXhigh object",8730 "required": false,8731 "description": "Extra-high effort. Not all models accept this level."8732 },8733 {8734 "name": "model.effort<BetaManagedAgentsEffortXhigh>.type",8735 "type": "\"xhigh\"",8736 "required": true,8737 "description": ""8738 },8739 {8740 "name": "model.effort<BetaManagedAgentsEffortMax>",8741 "type": "BetaManagedAgentsEffortMax object",8742 "required": false,8743 "description": "Maximum effort. Favors reasoning depth over latency."8744 },8745 {8746 "name": "model.effort<BetaManagedAgentsEffortMax>.type",8747 "type": "\"max\"",8748 "required": true,8749 "description": ""8750 },8751 {8752 "name": "model.inference_geo",8753 "type": "string",8754 "required": false,8755 "description": "Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo."8756 },8757 {8758 "name": "model.speed",8759 "type": "\"standard\" or \"fast\"",8760 "required": false,8761 "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",8762 "enum": [8763 "standard",8764 "fast"8765 ]8766 },8767 {8768 "name": "multiagent",8769 "type": "BetaManagedAgentsMultiagent or null",8770 "required": true,8771 "description": "Resolved coordinator topology with a concrete agent roster."8772 },8773 {8774 "name": "multiagent.type",8775 "type": "\"coordinator\"",8776 "required": true,8777 "description": ""8778 },8779 {8780 "name": "multiagent.agents",8781 "type": "array of BetaManagedAgentsAgentReference or BetaManagedAgentsAdvisor",8782 "required": true,8783 "description": "Agents the coordinator may spawn as session threads, each resolved to a specific version."8784 },8785 {8786 "name": "multiagent.agents<BetaManagedAgentsAgentReference>",8787 "type": "BetaManagedAgentsAgentReference object",8788 "required": false,8789 "description": "A resolved agent reference with a concrete version."8790 },8791 {8792 "name": "multiagent.agents<BetaManagedAgentsAgentReference>.type",8793 "type": "\"agent\"",8794 "required": true,8795 "description": ""8796 },8797 {8798 "name": "multiagent.agents<BetaManagedAgentsAgentReference>.id",8799 "type": "string",8800 "required": true,8801 "description": ""8802 },8803 {8804 "name": "multiagent.agents<BetaManagedAgentsAgentReference>.version",8805 "type": "number",8806 "required": true,8807 "description": "",8808 "constraints": {8809 "format": "int32"8810 }8811 },8812 {8813 "name": "multiagent.agents<BetaManagedAgentsAdvisor>",8814 "type": "BetaManagedAgentsAdvisor object",8815 "required": false,8816 "description": "Platform advisor roster entry: a model the session's primary thread may consult mid-turn."8817 },8818 {8819 "name": "multiagent.agents<BetaManagedAgentsAdvisor>.type",8820 "type": "\"advisor\"",8821 "required": true,8822 "description": ""8823 },8824 {8825 "name": "multiagent.agents<BetaManagedAgentsAdvisor>.model",8826 "type": "string",8827 "required": true,8828 "description": "The advisor model id."8829 },8830 {8831 "name": "name",8832 "type": "string",8833 "required": true,8834 "description": ""8835 },8836 {8837 "name": "skills",8838 "type": "array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill",8839 "required": true,8840 "description": ""8841 },8842 {8843 "name": "skills<BetaManagedAgentsAnthropicSkill>",8844 "type": "BetaManagedAgentsAnthropicSkill object",8845 "required": false,8846 "description": "A resolved Anthropic-managed skill."8847 },8848 {8849 "name": "skills<BetaManagedAgentsAnthropicSkill>.type",8850 "type": "\"anthropic\"",8851 "required": true,8852 "description": ""8853 },8854 {8855 "name": "skills<BetaManagedAgentsAnthropicSkill>.skill_id",8856 "type": "string",8857 "required": true,8858 "description": ""8859 },8860 {8861 "name": "skills<BetaManagedAgentsAnthropicSkill>.version",8862 "type": "string",8863 "required": true,8864 "description": ""8865 },8866 {8867 "name": "skills<BetaManagedAgentsCustomSkill>",8868 "type": "BetaManagedAgentsCustomSkill object",8869 "required": false,8870 "description": "A resolved user-created custom skill."8871 },8872 {8873 "name": "skills<BetaManagedAgentsCustomSkill>.type",8874 "type": "\"custom\"",8875 "required": true,8876 "description": ""8877 },8878 {8879 "name": "skills<BetaManagedAgentsCustomSkill>.skill_id",8880 "type": "string",8881 "required": true,8882 "description": ""8883 },8884 {8885 "name": "skills<BetaManagedAgentsCustomSkill>.version",8886 "type": "string",8887 "required": true,8888 "description": ""8889 },8890 {8891 "name": "system",8892 "type": "string or null",8893 "required": true,8894 "description": ""8895 },8896 {8897 "name": "tools",8898 "type": "array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool",8899 "required": true,8900 "description": ""8901 },8902 {8903 "name": "tools<BetaManagedAgentsAgentToolset20260401>",8904 "type": "BetaManagedAgentsAgentToolset20260401 object",8905 "required": false,8906 "description": ""8907 },8908 {8909 "name": "tools<BetaManagedAgentsAgentToolset20260401>.type",8910 "type": "\"agent_toolset_20260401\"",8911 "required": true,8912 "description": ""8913 },8914 {8915 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs",8916 "type": "array of BetaManagedAgentsAgentToolConfig",8917 "required": true,8918 "description": ""8919 },8920 {8921 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsBashToolConfig>",8922 "type": "BetaManagedAgentsBashToolConfig object",8923 "required": false,8924 "description": "Configuration for the bash tool."8925 },8926 {8927 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsBashToolConfig>.type",8928 "type": "\"bash\"",8929 "required": true,8930 "description": ""8931 },8932 {8933 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsBashToolConfig>.enabled",8934 "type": "boolean",8935 "required": true,8936 "description": ""8937 },8938 {8939 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsBashToolConfig>.name",8940 "type": "\"bash\"",8941 "required": true,8942 "description": ""8943 },8944 {8945 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsBashToolConfig>.permission_policy",8946 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy",8947 "required": true,8948 "description": "Permission policy for tool execution."8949 },8950 {8951 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsEditToolConfig>",8952 "type": "BetaManagedAgentsEditToolConfig object",8953 "required": false,8954 "description": "Configuration for the edit tool."8955 },8956 {8957 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsEditToolConfig>.type",8958 "type": "\"edit\"",8959 "required": true,8960 "description": ""8961 },8962 {8963 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsEditToolConfig>.enabled",8964 "type": "boolean",8965 "required": true,8966 "description": ""8967 },8968 {8969 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsEditToolConfig>.name",8970 "type": "\"edit\"",8971 "required": true,8972 "description": ""8973 },8974 {8975 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsEditToolConfig>.permission_policy",8976 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy",8977 "required": true,8978 "description": "Permission policy for tool execution."8979 },8980 {8981 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsReadToolConfig>",8982 "type": "BetaManagedAgentsReadToolConfig object",8983 "required": false,8984 "description": "Configuration for the read tool."8985 },8986 {8987 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsReadToolConfig>.type",8988 "type": "\"read\"",8989 "required": true,8990 "description": ""8991 },8992 {8993 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsReadToolConfig>.enabled",8994 "type": "boolean",8995 "required": true,8996 "description": ""8997 },8998 {8999 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsReadToolConfig>.name",9000 "type": "\"read\"",9001 "required": true,9002 "description": ""9003 },9004 {9005 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsReadToolConfig>.permission_policy",9006 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy",9007 "required": true,9008 "description": "Permission policy for tool execution."9009 },9010 {9011 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWriteToolConfig>",9012 "type": "BetaManagedAgentsWriteToolConfig object",9013 "required": false,9014 "description": "Configuration for the write tool."9015 },9016 {9017 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWriteToolConfig>.type",9018 "type": "\"write\"",9019 "required": true,9020 "description": ""9021 },9022 {9023 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWriteToolConfig>.enabled",9024 "type": "boolean",9025 "required": true,9026 "description": ""9027 },9028 {9029 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWriteToolConfig>.name",9030 "type": "\"write\"",9031 "required": true,9032 "description": ""9033 },9034 {9035 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWriteToolConfig>.permission_policy",9036 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy",9037 "required": true,9038 "description": "Permission policy for tool execution."9039 },9040 {9041 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsGlobToolConfig>",9042 "type": "BetaManagedAgentsGlobToolConfig object",9043 "required": false,9044 "description": "Configuration for the glob tool."9045 },9046 {9047 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsGlobToolConfig>.type",9048 "type": "\"glob\"",9049 "required": true,9050 "description": ""9051 },9052 {9053 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsGlobToolConfig>.enabled",9054 "type": "boolean",9055 "required": true,9056 "description": ""9057 },9058 {9059 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsGlobToolConfig>.name",9060 "type": "\"glob\"",9061 "required": true,9062 "description": ""9063 },9064 {9065 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsGlobToolConfig>.permission_policy",9066 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy",9067 "required": true,9068 "description": "Permission policy for tool execution."9069 },9070 {9071 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsGrepToolConfig>",9072 "type": "BetaManagedAgentsGrepToolConfig object",9073 "required": false,9074 "description": "Configuration for the grep tool."9075 },9076 {9077 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsGrepToolConfig>.type",9078 "type": "\"grep\"",9079 "required": true,9080 "description": ""9081 },9082 {9083 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsGrepToolConfig>.enabled",9084 "type": "boolean",9085 "required": true,9086 "description": ""9087 },9088 {9089 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsGrepToolConfig>.name",9090 "type": "\"grep\"",9091 "required": true,9092 "description": ""9093 },9094 {9095 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsGrepToolConfig>.permission_policy",9096 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy",9097 "required": true,9098 "description": "Permission policy for tool execution."9099 },9100 {9101 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebFetchToolConfig>",9102 "type": "BetaManagedAgentsWebFetchToolConfig object",9103 "required": false,9104 "description": "Configuration for the web_fetch tool."9105 },9106 {9107 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebFetchToolConfig>.type",9108 "type": "\"web_fetch\"",9109 "required": true,9110 "description": ""9111 },9112 {9113 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebFetchToolConfig>.enabled",9114 "type": "boolean",9115 "required": true,9116 "description": ""9117 },9118 {9119 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebFetchToolConfig>.name",9120 "type": "\"web_fetch\"",9121 "required": true,9122 "description": ""9123 },9124 {9125 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebFetchToolConfig>.permission_policy",9126 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy",9127 "required": true,9128 "description": "Permission policy for tool execution."9129 },9130 {9131 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebFetchToolConfig>.allowed_domains",9132 "type": "array of string",9133 "required": false,9134 "description": ""9135 },9136 {9137 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebFetchToolConfig>.blocked_domains",9138 "type": "array of string",9139 "required": false,9140 "description": ""9141 },9142 {9143 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebFetchToolConfig>.max_content_tokens",9144 "type": "number or null",9145 "required": false,9146 "description": "",9147 "constraints": {9148 "format": "int32"9149 }9150 },9151 {9152 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebSearchToolConfig>",9153 "type": "BetaManagedAgentsWebSearchToolConfig object",9154 "required": false,9155 "description": "Configuration for the web_search tool."9156 },9157 {9158 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebSearchToolConfig>.type",9159 "type": "\"web_search\"",9160 "required": true,9161 "description": ""9162 },9163 {9164 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebSearchToolConfig>.enabled",9165 "type": "boolean",9166 "required": true,9167 "description": ""9168 },9169 {9170 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebSearchToolConfig>.name",9171 "type": "\"web_search\"",9172 "required": true,9173 "description": ""9174 },9175 {9176 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebSearchToolConfig>.permission_policy",9177 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy",9178 "required": true,9179 "description": "Permission policy for tool execution."9180 },9181 {9182 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebSearchToolConfig>.allowed_domains",9183 "type": "array of string",9184 "required": false,9185 "description": ""9186 },9187 {9188 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebSearchToolConfig>.blocked_domains",9189 "type": "array of string",9190 "required": false,9191 "description": ""9192 },9193 {9194 "name": "tools<BetaManagedAgentsAgentToolset20260401>.configs<BetaManagedAgentsWebSearchToolConfig>.user_location",9195 "type": "BetaManagedAgentsUserLocation or null",9196 "required": false,9197 "description": "Approximate user location for search result localization."9198 },9199 {9200 "name": "tools<BetaManagedAgentsAgentToolset20260401>.default_config",9201 "type": "BetaManagedAgentsAgentToolsetDefaultConfig",9202 "required": true,9203 "description": "Resolved default configuration for agent tools."9204 },9205 {9206 "name": "tools<BetaManagedAgentsAgentToolset20260401>.default_config.enabled",9207 "type": "boolean",9208 "required": true,9209 "description": ""9210 },9211 {9212 "name": "tools<BetaManagedAgentsAgentToolset20260401>.default_config.permission_policy",9213 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy",9214 "required": true,9215 "description": "Permission policy for tool execution."9216 },9217 {9218 "name": "tools<BetaManagedAgentsAgentToolset20260401>.default_config.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",9219 "type": "BetaManagedAgentsAlwaysAllowPolicy object",9220 "required": false,9221 "description": "Tool calls are automatically approved without user confirmation."9222 },9223 {9224 "name": "tools<BetaManagedAgentsAgentToolset20260401>.default_config.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",9225 "type": "BetaManagedAgentsAlwaysAskPolicy object",9226 "required": false,9227 "description": "Tool calls require user confirmation before execution."9228 },9229 {9230 "name": "tools<BetaManagedAgentsAgentToolset20260401>.default_config.permission_policy<BetaManagedAgentsAutoPolicy>",9231 "type": "BetaManagedAgentsAutoPolicy object",9232 "required": false,9233 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."9234 },9235 {9236 "name": "tools<BetaManagedAgentsMCPToolset>",9237 "type": "BetaManagedAgentsMCPToolset object",9238 "required": false,9239 "description": ""9240 },9241 {9242 "name": "tools<BetaManagedAgentsMCPToolset>.type",9243 "type": "\"mcp_toolset\"",9244 "required": true,9245 "description": ""9246 },9247 {9248 "name": "tools<BetaManagedAgentsMCPToolset>.configs",9249 "type": "array of BetaManagedAgentsMCPToolConfig",9250 "required": true,9251 "description": ""9252 },9253 {9254 "name": "tools<BetaManagedAgentsMCPToolset>.configs.enabled",9255 "type": "boolean",9256 "required": true,9257 "description": ""9258 },9259 {9260 "name": "tools<BetaManagedAgentsMCPToolset>.configs.name",9261 "type": "string",9262 "required": true,9263 "description": ""9264 },9265 {9266 "name": "tools<BetaManagedAgentsMCPToolset>.configs.permission_policy",9267 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy",9268 "required": true,9269 "description": "Permission policy for tool execution."9270 },9271 {9272 "name": "tools<BetaManagedAgentsMCPToolset>.configs.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",9273 "type": "BetaManagedAgentsAlwaysAllowPolicy object",9274 "required": false,9275 "description": "Tool calls are automatically approved without user confirmation."9276 },9277 {9278 "name": "tools<BetaManagedAgentsMCPToolset>.configs.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",9279 "type": "BetaManagedAgentsAlwaysAskPolicy object",9280 "required": false,9281 "description": "Tool calls require user confirmation before execution."9282 },9283 {9284 "name": "tools<BetaManagedAgentsMCPToolset>.configs.permission_policy<BetaManagedAgentsAutoPolicy>",9285 "type": "BetaManagedAgentsAutoPolicy object",9286 "required": false,9287 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."9288 },9289 {9290 "name": "tools<BetaManagedAgentsMCPToolset>.default_config",9291 "type": "BetaManagedAgentsMCPToolsetDefaultConfig",9292 "required": true,9293 "description": "Resolved default configuration for all tools from an MCP server."9294 },9295 {9296 "name": "tools<BetaManagedAgentsMCPToolset>.default_config.enabled",9297 "type": "boolean",9298 "required": true,9299 "description": ""9300 },9301 {9302 "name": "tools<BetaManagedAgentsMCPToolset>.default_config.permission_policy",9303 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy",9304 "required": true,9305 "description": "Permission policy for tool execution."9306 },9307 {9308 "name": "tools<BetaManagedAgentsMCPToolset>.default_config.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",9309 "type": "BetaManagedAgentsAlwaysAllowPolicy object",9310 "required": false,9311 "description": "Tool calls are automatically approved without user confirmation."9312 },9313 {9314 "name": "tools<BetaManagedAgentsMCPToolset>.default_config.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",9315 "type": "BetaManagedAgentsAlwaysAskPolicy object",9316 "required": false,9317 "description": "Tool calls require user confirmation before execution."9318 },9319 {9320 "name": "tools<BetaManagedAgentsMCPToolset>.default_config.permission_policy<BetaManagedAgentsAutoPolicy>",9321 "type": "BetaManagedAgentsAutoPolicy object",9322 "required": false,9323 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."9324 },9325 {9326 "name": "tools<BetaManagedAgentsMCPToolset>.mcp_server_name",9327 "type": "string",9328 "required": true,9329 "description": ""9330 },9331 {9332 "name": "tools<BetaManagedAgentsCustomTool>",9333 "type": "BetaManagedAgentsCustomTool object",9334 "required": false,9335 "description": "A custom tool as returned in API responses."9336 },9337 {9338 "name": "tools<BetaManagedAgentsCustomTool>.type",9339 "type": "\"custom\"",9340 "required": true,9341 "description": ""9342 },9343 {9344 "name": "tools<BetaManagedAgentsCustomTool>.description",9345 "type": "string",9346 "required": true,9347 "description": ""9348 },9349 {9350 "name": "tools<BetaManagedAgentsCustomTool>.input_schema",9351 "type": "BetaManagedAgentsCustomToolInputSchema",9352 "required": true,9353 "description": "JSON Schema for custom tool input parameters."9354 },9355 {9356 "name": "tools<BetaManagedAgentsCustomTool>.input_schema.type",9357 "type": "\"object\"",9358 "required": true,9359 "description": ""9360 },9361 {9362 "name": "tools<BetaManagedAgentsCustomTool>.input_schema.properties",9363 "type": "map[unknown] or null",9364 "required": false,9365 "description": ""9366 },9367 {9368 "name": "tools<BetaManagedAgentsCustomTool>.input_schema.required",9369 "type": "array of string or null",9370 "required": false,9371 "description": ""9372 },9373 {9374 "name": "tools<BetaManagedAgentsCustomTool>.name",9375 "type": "string",9376 "required": true,9377 "description": ""9378 },9379 {9380 "name": "updated_at",9381 "type": "string",9382 "required": true,9383 "description": "A timestamp in RFC 3339 format",9384 "constraints": {9385 "format": "date-time"9386 }9387 },9388 {9389 "name": "version",9390 "type": "number",9391 "required": true,9392 "description": "The agent's current version. Starts at 1 and increments when the agent is modified.",9393 "constraints": {9394 "format": "int32"9395 }9396 }9397 ],9398 "status": [9399 "DOCUMENTED",9400 "BETA"9401 ],9402 "sources": [9403 {9404 "url": "https://platform.claude.com/docs/en/api/beta/agents/create",9405 "retrieved_at": "2026-09-18"9406 },9407 {9408 "url": "https://platform.claude.com/docs/en/managed-agents/agent-setup",9409 "retrieved_at": "2026-09-18"9410 }9411 ],9412 "beta_header": "managed-agents-2026-04-01"9413 },9414 {9415 "provider": "anthropic",9416 "api_family": "managed-agents",9417 "name": "AgentCreateParams (request body)",9418 "official_type_name": "BetaManagedAgentsAgentCreateParams",9419 "description": "Create Agent",9420 "fields": [9421 {9422 "name": "model",9423 "type": "BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams",9424 "required": true,9425 "description": "Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control"9426 },9427 {9428 "name": "model<BetaManagedAgentsModel = \"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more or string>",9429 "type": "BetaManagedAgentsModel = \"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more or string",9430 "required": false,9431 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."9432 },9433 {9434 "name": "model<BetaManagedAgentsModel = \"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more or string><\"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more>",9435 "type": "\"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more",9436 "required": false,9437 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."9438 },9439 {9440 "name": "model<BetaManagedAgentsModel = \"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more or string><string>",9441 "type": "string",9442 "required": false,9443 "description": ""9444 },9445 {9446 "name": "model<BetaManagedAgentsModelConfigParams>",9447 "type": "BetaManagedAgentsModelConfigParams object",9448 "required": false,9449 "description": "An object that defines additional configuration control over model use"9450 },9451 {9452 "name": "model<BetaManagedAgentsModelConfigParams>.id",9453 "type": "BetaManagedAgentsModel",9454 "required": true,9455 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."9456 },9457 {9458 "name": "model<BetaManagedAgentsModelConfigParams>.effort",9459 "type": "\"low\" or \"medium\" or \"high\" or 2 more or BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or 3 more or null",9460 "required": false,9461 "description": "How hard Claude works on each inference call. Accepts a bare level string (`\"high\"`) or `{\"type\": \"high\"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged."9462 },9463 {9464 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortLevel = \"low\" or \"medium\" or \"high\" or 2 more>",9465 "type": "BetaManagedAgentsEffortLevel = \"low\" or \"medium\" or \"high\" or 2 more",9466 "required": false,9467 "description": "How hard Claude works on each turn. Higher levels favor reasoning depth over latency. Not all models accept every level; invalid combinations are rejected at create time."9468 },9469 {9470 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortLow>",9471 "type": "BetaManagedAgentsEffortLow object",9472 "required": false,9473 "description": "Low effort. Favors latency over reasoning depth."9474 },9475 {9476 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortLow>.type",9477 "type": "\"low\"",9478 "required": true,9479 "description": ""9480 },9481 {9482 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortMedium>",9483 "type": "BetaManagedAgentsEffortMedium object",9484 "required": false,9485 "description": "Medium effort. Balances latency and reasoning depth."9486 },9487 {9488 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortMedium>.type",9489 "type": "\"medium\"",9490 "required": true,9491 "description": ""9492 },9493 {9494 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortHigh>",9495 "type": "BetaManagedAgentsEffortHigh object",9496 "required": false,9497 "description": "High effort. Favors reasoning depth."9498 },9499 {9500 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortHigh>.type",9501 "type": "\"high\"",9502 "required": true,9503 "description": ""9504 },9505 {9506 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortXhigh>",9507 "type": "BetaManagedAgentsEffortXhigh object",9508 "required": false,9509 "description": "Extra-high effort. Not all models accept this level."9510 },9511 {9512 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortXhigh>.type",9513 "type": "\"xhigh\"",9514 "required": true,9515 "description": ""9516 },9517 {9518 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortMax>",9519 "type": "BetaManagedAgentsEffortMax object",9520 "required": false,9521 "description": "Maximum effort. Favors reasoning depth over latency."9522 },9523 {9524 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortMax>.type",9525 "type": "\"max\"",9526 "required": true,9527 "description": ""9528 },9529 {9530 "name": "model<BetaManagedAgentsModelConfigParams>.inference_geo",9531 "type": "string or null",9532 "required": false,9533 "description": "Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it."9534 },9535 {9536 "name": "model<BetaManagedAgentsModelConfigParams>.speed",9537 "type": "\"standard\" or \"fast\" or null",9538 "required": false,9539 "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",9540 "enum": [9541 "standard",9542 "fast"9543 ]9544 },9545 {9546 "name": "name",9547 "type": "string",9548 "required": true,9549 "description": "Human-readable name for the agent.",9550 "constraints": {9551 "minLength": "1",9552 "maxLength": "256"9553 }9554 },9555 {9556 "name": "description",9557 "type": "string or null",9558 "required": false,9559 "description": "Description of what the agent does.",9560 "constraints": {9561 "maxLength": "2048"9562 }9563 },9564 {9565 "name": "mcp_servers",9566 "type": "array of BetaManagedAgentsURLMCPServerParams",9567 "required": false,9568 "description": "MCP servers this agent connects to. Maximum 20. Names must be unique within the array. Every server must be referenced by an `mcp_toolset` in `tools`; unreferenced servers are rejected. See the [MCP connector guide](https://platform.claude.com/docs/en/managed-agents/mcp-connector)."9569 },9570 {9571 "name": "mcp_servers.type",9572 "type": "\"url\"",9573 "required": true,9574 "description": ""9575 },9576 {9577 "name": "mcp_servers.name",9578 "type": "string",9579 "required": true,9580 "description": "Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.",9581 "constraints": {9582 "minLength": "1",9583 "maxLength": "255"9584 }9585 },9586 {9587 "name": "mcp_servers.url",9588 "type": "string",9589 "required": true,9590 "description": "Endpoint URL for the MCP server.",9591 "constraints": {9592 "maxLength": "2048"9593 }9594 },9595 {9596 "name": "metadata",9597 "type": "map[string]",9598 "required": false,9599 "description": "Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars."9600 },9601 {9602 "name": "multiagent",9603 "type": "BetaManagedAgentsMultiagentParams or null",9604 "required": false,9605 "description": "A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster."9606 },9607 {9608 "name": "multiagent.type",9609 "type": "\"coordinator\"",9610 "required": true,9611 "description": ""9612 },9613 {9614 "name": "multiagent.agents",9615 "type": "array of BetaManagedAgentsMultiagentRosterEntryParams",9616 "required": true,9617 "description": "Agents the coordinator may spawn as session threads. 1–20 entries. Each entry is an agent ID string, a versioned `{\"type\":\"agent\",\"id\",\"version\"}` reference, or `{\"type\":\"self\"}` to allow recursive self-invocation. Entries must reference distinct agents (after resolving `self` and string forms); at most one `self`. Referenced agents must exist, must not be archived, and must not themselves have `multiagent` set (depth limit 1)."9618 },9619 {9620 "name": "multiagent.agents<string>",9621 "type": "string",9622 "required": false,9623 "description": ""9624 },9625 {9626 "name": "multiagent.agents<BetaManagedAgentsAgentParams>",9627 "type": "BetaManagedAgentsAgentParams object",9628 "required": false,9629 "description": "Specification for an Agent. Provide a specific `version` or use the short-form `agent=\"agent_id\"` for the most recent version"9630 },9631 {9632 "name": "multiagent.agents<BetaManagedAgentsAgentParams>.type",9633 "type": "\"agent\"",9634 "required": true,9635 "description": ""9636 },9637 {9638 "name": "multiagent.agents<BetaManagedAgentsAgentParams>.id",9639 "type": "string",9640 "required": true,9641 "description": "The `agent` ID.",9642 "constraints": {9643 "minLength": "1",9644 "maxLength": "128"9645 }9646 },9647 {9648 "name": "multiagent.agents<BetaManagedAgentsAgentParams>.version",9649 "type": "number",9650 "required": false,9651 "description": "The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.",9652 "constraints": {9653 "format": "int32"9654 }9655 },9656 {9657 "name": "multiagent.agents<BetaManagedAgentsMultiagentSelfParams>",9658 "type": "BetaManagedAgentsMultiagentSelfParams object",9659 "required": false,9660 "description": "Sentinel roster entry meaning \"the agent that owns this configuration\". Resolved server-side to a concrete agent reference."9661 },9662 {9663 "name": "multiagent.agents<BetaManagedAgentsMultiagentSelfParams>.type",9664 "type": "\"self\"",9665 "required": true,9666 "description": ""9667 },9668 {9669 "name": "multiagent.agents<BetaManagedAgentsAdvisorParams>",9670 "type": "BetaManagedAgentsAdvisorParams object",9671 "required": false,9672 "description": "Platform advisor roster entry: a model the session's primary thread may consult mid-turn. At most one per roster; the entry occupies the roster name `anthropic.advisor`."9673 },9674 {9675 "name": "multiagent.agents<BetaManagedAgentsAdvisorParams>.type",9676 "type": "\"advisor\"",9677 "required": true,9678 "description": ""9679 },9680 {9681 "name": "multiagent.agents<BetaManagedAgentsAdvisorParams>.model",9682 "type": "string",9683 "required": true,9684 "description": "A Claude model id. The model must be permitted as an advisor for this agent's model — see the sessions/threads/advisor spec.",9685 "constraints": {9686 "minLength": "1",9687 "maxLength": "256"9688 }9689 },9690 {9691 "name": "skills",9692 "type": "array of BetaManagedAgentsSkillParams",9693 "required": false,9694 "description": "Skills available to the agent."9695 },9696 {9697 "name": "skills<BetaManagedAgentsAnthropicSkillParams>",9698 "type": "BetaManagedAgentsAnthropicSkillParams object",9699 "required": false,9700 "description": "An Anthropic-managed skill."9701 },9702 {9703 "name": "skills<BetaManagedAgentsAnthropicSkillParams>.type",9704 "type": "\"anthropic\"",9705 "required": true,9706 "description": ""9707 },9708 {9709 "name": "skills<BetaManagedAgentsAnthropicSkillParams>.skill_id",9710 "type": "string",9711 "required": true,9712 "description": "Identifier of the Anthropic skill (e.g., \"xlsx\").",9713 "constraints": {9714 "minLength": "1",9715 "maxLength": "64"9716 }9717 },9718 {9719 "name": "skills<BetaManagedAgentsAnthropicSkillParams>.version",9720 "type": "string or null",9721 "required": false,9722 "description": "Version to pin. Defaults to latest if omitted.",9723 "constraints": {9724 "minLength": "1",9725 "maxLength": "64"9726 }9727 },9728 {9729 "name": "skills<BetaManagedAgentsCustomSkillParams>",9730 "type": "BetaManagedAgentsCustomSkillParams object",9731 "required": false,9732 "description": "A user-created custom skill."9733 },9734 {9735 "name": "skills<BetaManagedAgentsCustomSkillParams>.type",9736 "type": "\"custom\"",9737 "required": true,9738 "description": ""9739 },9740 {9741 "name": "skills<BetaManagedAgentsCustomSkillParams>.skill_id",9742 "type": "string",9743 "required": true,9744 "description": "Tagged ID of the custom skill (e.g., \"skill_01XJ5...\").",9745 "constraints": {9746 "minLength": "1",9747 "maxLength": "64"9748 }9749 },9750 {9751 "name": "skills<BetaManagedAgentsCustomSkillParams>.version",9752 "type": "string or null",9753 "required": false,9754 "description": "Version to pin. Defaults to latest if omitted.",9755 "constraints": {9756 "minLength": "1",9757 "maxLength": "64"9758 }9759 },9760 {9761 "name": "system",9762 "type": "string or null",9763 "required": false,9764 "description": "System prompt for the agent.",9765 "constraints": {9766 "maxLength": "100000"9767 }9768 },9769 {9770 "name": "tools",9771 "type": "array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams",9772 "required": false,9773 "description": "Tool configurations available to the agent. Maximum of 128 tools across all toolsets allowed."9774 },9775 {9776 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>",9777 "type": "BetaManagedAgentsAgentToolset20260401Params object",9778 "required": false,9779 "description": "Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent."9780 },9781 {9782 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.type",9783 "type": "\"agent_toolset_20260401\"",9784 "required": true,9785 "description": ""9786 },9787 {9788 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs",9789 "type": "array of BetaManagedAgentsAgentToolConfigParams",9790 "required": false,9791 "description": "Per-tool configuration overrides."9792 },9793 {9794 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsBashToolConfigParams>",9795 "type": "BetaManagedAgentsBashToolConfigParams object",9796 "required": false,9797 "description": "Configuration override for the bash tool."9798 },9799 {9800 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsBashToolConfigParams>.type",9801 "type": "\"bash\"",9802 "required": false,9803 "description": ""9804 },9805 {9806 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsBashToolConfigParams>.name",9807 "type": "\"bash\"",9808 "required": true,9809 "description": "Must be \"bash\"."9810 },9811 {9812 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsBashToolConfigParams>.enabled",9813 "type": "boolean or null",9814 "required": false,9815 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."9816 },9817 {9818 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsBashToolConfigParams>.permission_policy",9819 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",9820 "required": false,9821 "description": "Permission policy for tool execution."9822 },9823 {9824 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsBashToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",9825 "type": "BetaManagedAgentsAlwaysAllowPolicy object",9826 "required": false,9827 "description": "Tool calls are automatically approved without user confirmation."9828 },9829 {9830 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsBashToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",9831 "type": "BetaManagedAgentsAlwaysAskPolicy object",9832 "required": false,9833 "description": "Tool calls require user confirmation before execution."9834 },9835 {9836 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsBashToolConfigParams>.permission_policy<BetaManagedAgentsAutoPolicy>",9837 "type": "BetaManagedAgentsAutoPolicy object",9838 "required": false,9839 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."9840 },9841 {9842 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsEditToolConfigParams>",9843 "type": "BetaManagedAgentsEditToolConfigParams object",9844 "required": false,9845 "description": "Configuration override for the edit tool."9846 },9847 {9848 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsEditToolConfigParams>.type",9849 "type": "\"edit\"",9850 "required": false,9851 "description": ""9852 },9853 {9854 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsEditToolConfigParams>.name",9855 "type": "\"edit\"",9856 "required": true,9857 "description": "Must be \"edit\"."9858 },9859 {9860 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsEditToolConfigParams>.enabled",9861 "type": "boolean or null",9862 "required": false,9863 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."9864 },9865 {9866 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsEditToolConfigParams>.permission_policy",9867 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",9868 "required": false,9869 "description": "Permission policy for tool execution."9870 },9871 {9872 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsEditToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",9873 "type": "BetaManagedAgentsAlwaysAllowPolicy object",9874 "required": false,9875 "description": "Tool calls are automatically approved without user confirmation."9876 },9877 {9878 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsEditToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",9879 "type": "BetaManagedAgentsAlwaysAskPolicy object",9880 "required": false,9881 "description": "Tool calls require user confirmation before execution."9882 },9883 {9884 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsEditToolConfigParams>.permission_policy<BetaManagedAgentsAutoPolicy>",9885 "type": "BetaManagedAgentsAutoPolicy object",9886 "required": false,9887 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."9888 },9889 {9890 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsReadToolConfigParams>",9891 "type": "BetaManagedAgentsReadToolConfigParams object",9892 "required": false,9893 "description": "Configuration override for the read tool."9894 },9895 {9896 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsReadToolConfigParams>.type",9897 "type": "\"read\"",9898 "required": false,9899 "description": ""9900 },9901 {9902 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsReadToolConfigParams>.name",9903 "type": "\"read\"",9904 "required": true,9905 "description": "Must be \"read\"."9906 },9907 {9908 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsReadToolConfigParams>.enabled",9909 "type": "boolean or null",9910 "required": false,9911 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."9912 },9913 {9914 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsReadToolConfigParams>.permission_policy",9915 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",9916 "required": false,9917 "description": "Permission policy for tool execution."9918 },9919 {9920 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsReadToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",9921 "type": "BetaManagedAgentsAlwaysAllowPolicy object",9922 "required": false,9923 "description": "Tool calls are automatically approved without user confirmation."9924 },9925 {9926 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsReadToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",9927 "type": "BetaManagedAgentsAlwaysAskPolicy object",9928 "required": false,9929 "description": "Tool calls require user confirmation before execution."9930 },9931 {9932 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsReadToolConfigParams>.permission_policy<BetaManagedAgentsAutoPolicy>",9933 "type": "BetaManagedAgentsAutoPolicy object",9934 "required": false,9935 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."9936 },9937 {9938 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWriteToolConfigParams>",9939 "type": "BetaManagedAgentsWriteToolConfigParams object",9940 "required": false,9941 "description": "Configuration override for the write tool."9942 },9943 {9944 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWriteToolConfigParams>.type",9945 "type": "\"write\"",9946 "required": false,9947 "description": ""9948 },9949 {9950 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWriteToolConfigParams>.name",9951 "type": "\"write\"",9952 "required": true,9953 "description": "Must be \"write\"."9954 },9955 {9956 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWriteToolConfigParams>.enabled",9957 "type": "boolean or null",9958 "required": false,9959 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."9960 },9961 {9962 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWriteToolConfigParams>.permission_policy",9963 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",9964 "required": false,9965 "description": "Permission policy for tool execution."9966 },9967 {9968 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWriteToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",9969 "type": "BetaManagedAgentsAlwaysAllowPolicy object",9970 "required": false,9971 "description": "Tool calls are automatically approved without user confirmation."9972 },9973 {9974 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWriteToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",9975 "type": "BetaManagedAgentsAlwaysAskPolicy object",9976 "required": false,9977 "description": "Tool calls require user confirmation before execution."9978 },9979 {9980 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWriteToolConfigParams>.permission_policy<BetaManagedAgentsAutoPolicy>",9981 "type": "BetaManagedAgentsAutoPolicy object",9982 "required": false,9983 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."9984 },9985 {9986 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGlobToolConfigParams>",9987 "type": "BetaManagedAgentsGlobToolConfigParams object",9988 "required": false,9989 "description": "Configuration override for the glob tool."9990 },9991 {9992 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGlobToolConfigParams>.type",9993 "type": "\"glob\"",9994 "required": false,9995 "description": ""9996 },9997 {9998 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGlobToolConfigParams>.name",9999 "type": "\"glob\"",10000 "required": true,10001 "description": "Must be \"glob\"."10002 },10003 {10004 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGlobToolConfigParams>.enabled",10005 "type": "boolean or null",10006 "required": false,10007 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."10008 },10009 {10010 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGlobToolConfigParams>.permission_policy",10011 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",10012 "required": false,10013 "description": "Permission policy for tool execution."10014 },10015 {10016 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGlobToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",10017 "type": "BetaManagedAgentsAlwaysAllowPolicy object",10018 "required": false,10019 "description": "Tool calls are automatically approved without user confirmation."10020 },10021 {10022 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGlobToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",10023 "type": "BetaManagedAgentsAlwaysAskPolicy object",10024 "required": false,10025 "description": "Tool calls require user confirmation before execution."10026 },10027 {10028 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGlobToolConfigParams>.permission_policy<BetaManagedAgentsAutoPolicy>",10029 "type": "BetaManagedAgentsAutoPolicy object",10030 "required": false,10031 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."10032 },10033 {10034 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGrepToolConfigParams>",10035 "type": "BetaManagedAgentsGrepToolConfigParams object",10036 "required": false,10037 "description": "Configuration override for the grep tool."10038 },10039 {10040 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGrepToolConfigParams>.type",10041 "type": "\"grep\"",10042 "required": false,10043 "description": ""10044 },10045 {10046 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGrepToolConfigParams>.name",10047 "type": "\"grep\"",10048 "required": true,10049 "description": "Must be \"grep\"."10050 },10051 {10052 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGrepToolConfigParams>.enabled",10053 "type": "boolean or null",10054 "required": false,10055 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."10056 },10057 {10058 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGrepToolConfigParams>.permission_policy",10059 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",10060 "required": false,10061 "description": "Permission policy for tool execution."10062 },10063 {10064 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGrepToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",10065 "type": "BetaManagedAgentsAlwaysAllowPolicy object",10066 "required": false,10067 "description": "Tool calls are automatically approved without user confirmation."10068 },10069 {10070 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGrepToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",10071 "type": "BetaManagedAgentsAlwaysAskPolicy object",10072 "required": false,10073 "description": "Tool calls require user confirmation before execution."10074 },10075 {10076 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGrepToolConfigParams>.permission_policy<BetaManagedAgentsAutoPolicy>",10077 "type": "BetaManagedAgentsAutoPolicy object",10078 "required": false,10079 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."10080 },10081 {10082 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>",10083 "type": "BetaManagedAgentsWebFetchToolConfigParams object",10084 "required": false,10085 "description": "Configuration override for the web_fetch tool."10086 },10087 {10088 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.type",10089 "type": "\"web_fetch\"",10090 "required": false,10091 "description": ""10092 },10093 {10094 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.name",10095 "type": "\"web_fetch\"",10096 "required": true,10097 "description": "Must be \"web_fetch\"."10098 },10099 {10100 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.allowed_domains",10101 "type": "array of string",10102 "required": false,10103 "description": "Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"docs.example.com\" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains."10104 },10105 {10106 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.blocked_domains",10107 "type": "array of string",10108 "required": false,10109 "description": "Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"ads.example.com\" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains."10110 },10111 {10112 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.enabled",10113 "type": "boolean or null",10114 "required": false,10115 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."10116 },10117 {10118 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.max_content_tokens",10119 "type": "number or null",10120 "required": false,10121 "description": "Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs.",10122 "constraints": {10123 "format": "int32"10124 }10125 },10126 {10127 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.permission_policy",10128 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",10129 "required": false,10130 "description": "Permission policy for tool execution."10131 },10132 {10133 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",10134 "type": "BetaManagedAgentsAlwaysAllowPolicy object",10135 "required": false,10136 "description": "Tool calls are automatically approved without user confirmation."10137 },10138 {10139 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",10140 "type": "BetaManagedAgentsAlwaysAskPolicy object",10141 "required": false,10142 "description": "Tool calls require user confirmation before execution."10143 },10144 {10145 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.permission_policy<BetaManagedAgentsAutoPolicy>",10146 "type": "BetaManagedAgentsAutoPolicy object",10147 "required": false,10148 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."10149 },10150 {10151 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>",10152 "type": "BetaManagedAgentsWebSearchToolConfigParams object",10153 "required": false,10154 "description": "Configuration override for the web_search tool."10155 },10156 {10157 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.type",10158 "type": "\"web_search\"",10159 "required": false,10160 "description": ""10161 },10162 {10163 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.name",10164 "type": "\"web_search\"",10165 "required": true,10166 "description": "Must be \"web_search\"."10167 },10168 {10169 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.allowed_domains",10170 "type": "array of string",10171 "required": false,10172 "description": "Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"docs.example.com\" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains."10173 },10174 {10175 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.blocked_domains",10176 "type": "array of string",10177 "required": false,10178 "description": "Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"ads.example.com\" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains."10179 },10180 {10181 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.enabled",10182 "type": "boolean or null",10183 "required": false,10184 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."10185 },10186 {10187 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.permission_policy",10188 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",10189 "required": false,10190 "description": "Permission policy for tool execution."10191 },10192 {10193 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",10194 "type": "BetaManagedAgentsAlwaysAllowPolicy object",10195 "required": false,10196 "description": "Tool calls are automatically approved without user confirmation."10197 },10198 {10199 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",10200 "type": "BetaManagedAgentsAlwaysAskPolicy object",10201 "required": false,10202 "description": "Tool calls require user confirmation before execution."10203 },10204 {10205 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.permission_policy<BetaManagedAgentsAutoPolicy>",10206 "type": "BetaManagedAgentsAutoPolicy object",10207 "required": false,10208 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."10209 },10210 {10211 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.user_location",10212 "type": "BetaManagedAgentsUserLocation or null",10213 "required": false,10214 "description": "Approximate user location for search result localization."10215 },10216 {10217 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.user_location.type",10218 "type": "\"approximate\"",10219 "required": true,10220 "description": "Location precision. Only \"approximate\" is supported."10221 },10222 {10223 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.user_location.city",10224 "type": "string or null",10225 "required": false,10226 "description": "City name.",10227 "constraints": {10228 "minLength": "1",10229 "maxLength": "255"10230 }10231 },10232 {10233 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.user_location.country",10234 "type": "string or null",10235 "required": false,10236 "description": "Two-letter ISO 3166-1 country code, uppercase."10237 },10238 {10239 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.user_location.region",10240 "type": "string or null",10241 "required": false,10242 "description": "Region or state name.",10243 "constraints": {10244 "minLength": "1",10245 "maxLength": "255"10246 }10247 },10248 {10249 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.user_location.timezone",10250 "type": "string or null",10251 "required": false,10252 "description": "IANA timezone identifier, e.g. \"America/Los_Angeles\".",10253 "constraints": {10254 "minLength": "1",10255 "maxLength": "255"10256 }10257 },10258 {10259 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.default_config",10260 "type": "BetaManagedAgentsAgentToolsetDefaultConfigParams or null",10261 "required": false,10262 "description": "Default configuration for all tools in a toolset."10263 },10264 {10265 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.default_config.enabled",10266 "type": "boolean or null",10267 "required": false,10268 "description": "Whether tools are enabled and available to Claude by default. Defaults to true if not specified."10269 },10270 {10271 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.default_config.permission_policy",10272 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",10273 "required": false,10274 "description": "Permission policy for tool execution."10275 },10276 {10277 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.default_config.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",10278 "type": "BetaManagedAgentsAlwaysAllowPolicy object",10279 "required": false,10280 "description": "Tool calls are automatically approved without user confirmation."10281 },10282 {10283 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.default_config.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",10284 "type": "BetaManagedAgentsAlwaysAskPolicy object",10285 "required": false,10286 "description": "Tool calls require user confirmation before execution."10287 },10288 {10289 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.default_config.permission_policy<BetaManagedAgentsAutoPolicy>",10290 "type": "BetaManagedAgentsAutoPolicy object",10291 "required": false,10292 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."10293 },10294 {10295 "name": "tools<BetaManagedAgentsMCPToolsetParams>",10296 "type": "BetaManagedAgentsMCPToolsetParams object",10297 "required": false,10298 "description": "Configuration for tools from an MCP server defined in `mcp_servers`."10299 },10300 {10301 "name": "tools<BetaManagedAgentsMCPToolsetParams>.type",10302 "type": "\"mcp_toolset\"",10303 "required": true,10304 "description": ""10305 },10306 {10307 "name": "tools<BetaManagedAgentsMCPToolsetParams>.mcp_server_name",10308 "type": "string",10309 "required": true,10310 "description": "Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters.",10311 "constraints": {10312 "minLength": "1",10313 "maxLength": "255"10314 }10315 },10316 {10317 "name": "tools<BetaManagedAgentsMCPToolsetParams>.configs",10318 "type": "array of BetaManagedAgentsMCPToolConfigParams",10319 "required": false,10320 "description": "Per-tool configuration overrides."10321 },10322 {10323 "name": "tools<BetaManagedAgentsMCPToolsetParams>.configs.name",10324 "type": "string",10325 "required": true,10326 "description": "Name of the MCP tool to configure. 1-128 characters.",10327 "constraints": {10328 "minLength": "1",10329 "maxLength": "128"10330 }10331 },10332 {10333 "name": "tools<BetaManagedAgentsMCPToolsetParams>.configs.enabled",10334 "type": "boolean or null",10335 "required": false,10336 "description": "Whether this tool is enabled. Overrides the `default_config` setting."10337 },10338 {10339 "name": "tools<BetaManagedAgentsMCPToolsetParams>.configs.permission_policy",10340 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",10341 "required": false,10342 "description": "Permission policy for tool execution."10343 },10344 {10345 "name": "tools<BetaManagedAgentsMCPToolsetParams>.configs.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",10346 "type": "BetaManagedAgentsAlwaysAllowPolicy object",10347 "required": false,10348 "description": "Tool calls are automatically approved without user confirmation."10349 },10350 {10351 "name": "tools<BetaManagedAgentsMCPToolsetParams>.configs.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",10352 "type": "BetaManagedAgentsAlwaysAskPolicy object",10353 "required": false,10354 "description": "Tool calls require user confirmation before execution."10355 },10356 {10357 "name": "tools<BetaManagedAgentsMCPToolsetParams>.configs.permission_policy<BetaManagedAgentsAutoPolicy>",10358 "type": "BetaManagedAgentsAutoPolicy object",10359 "required": false,10360 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."10361 },10362 {10363 "name": "tools<BetaManagedAgentsMCPToolsetParams>.default_config",10364 "type": "BetaManagedAgentsMCPToolsetDefaultConfigParams or null",10365 "required": false,10366 "description": "Default configuration for all tools from an MCP server."10367 },10368 {10369 "name": "tools<BetaManagedAgentsMCPToolsetParams>.default_config.enabled",10370 "type": "boolean or null",10371 "required": false,10372 "description": "Whether tools are enabled by default. Defaults to true if not specified."10373 },10374 {10375 "name": "tools<BetaManagedAgentsMCPToolsetParams>.default_config.permission_policy",10376 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",10377 "required": false,10378 "description": "Permission policy for tool execution."10379 },10380 {10381 "name": "tools<BetaManagedAgentsMCPToolsetParams>.default_config.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",10382 "type": "BetaManagedAgentsAlwaysAllowPolicy object",10383 "required": false,10384 "description": "Tool calls are automatically approved without user confirmation."10385 },10386 {10387 "name": "tools<BetaManagedAgentsMCPToolsetParams>.default_config.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",10388 "type": "BetaManagedAgentsAlwaysAskPolicy object",10389 "required": false,10390 "description": "Tool calls require user confirmation before execution."10391 },10392 {10393 "name": "tools<BetaManagedAgentsMCPToolsetParams>.default_config.permission_policy<BetaManagedAgentsAutoPolicy>",10394 "type": "BetaManagedAgentsAutoPolicy object",10395 "required": false,10396 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."10397 },10398 {10399 "name": "tools<BetaManagedAgentsCustomToolParams>",10400 "type": "BetaManagedAgentsCustomToolParams object",10401 "required": false,10402 "description": "A custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an `agent.custom_tool_use` event is emitted and the session goes idle, waiting for the client to provide the result via a `user.custom_tool_result` event."10403 },10404 {10405 "name": "tools<BetaManagedAgentsCustomToolParams>.type",10406 "type": "\"custom\"",10407 "required": true,10408 "description": ""10409 },10410 {10411 "name": "tools<BetaManagedAgentsCustomToolParams>.description",10412 "type": "string",10413 "required": true,10414 "description": "Description of what the tool does, shown to the agent to help it decide when to use the tool.",10415 "constraints": {10416 "minLength": "1"10417 }10418 },10419 {10420 "name": "tools<BetaManagedAgentsCustomToolParams>.input_schema",10421 "type": "BetaManagedAgentsCustomToolInputSchema",10422 "required": true,10423 "description": "JSON Schema for custom tool input parameters."10424 },10425 {10426 "name": "tools<BetaManagedAgentsCustomToolParams>.input_schema.type",10427 "type": "\"object\"",10428 "required": true,10429 "description": ""10430 },10431 {10432 "name": "tools<BetaManagedAgentsCustomToolParams>.input_schema.properties",10433 "type": "map[unknown] or null",10434 "required": false,10435 "description": ""10436 },10437 {10438 "name": "tools<BetaManagedAgentsCustomToolParams>.input_schema.required",10439 "type": "array of string or null",10440 "required": false,10441 "description": ""10442 },10443 {10444 "name": "tools<BetaManagedAgentsCustomToolParams>.name",10445 "type": "string",10446 "required": true,10447 "description": "Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.",10448 "constraints": {10449 "minLength": "1",10450 "maxLength": "128"10451 }10452 }10453 ],10454 "status": [10455 "DOCUMENTED",10456 "BETA"10457 ],10458 "sources": [10459 {10460 "url": "https://platform.claude.com/docs/en/api/beta/agents/create",10461 "retrieved_at": "2026-09-18"10462 },10463 {10464 "url": "https://platform.claude.com/docs/en/managed-agents/agent-setup",10465 "retrieved_at": "2026-09-18"10466 },10467 {10468 "url": "https://platform.claude.com/docs/en/managed-agents/tools",10469 "retrieved_at": "2026-09-18"10470 },10471 {10472 "url": "https://platform.claude.com/docs/en/managed-agents/mcp-connector",10473 "retrieved_at": "2026-09-18"10474 },10475 {10476 "url": "https://platform.claude.com/docs/en/managed-agents/skills",10477 "retrieved_at": "2026-09-18"10478 },10479 {10480 "url": "https://platform.claude.com/docs/en/managed-agents/multiagent-orchestration",10481 "retrieved_at": "2026-09-18"10482 }10483 ],10484 "beta_header": "managed-agents-2026-04-01"10485 },10486 {10487 "provider": "anthropic",10488 "api_family": "managed-agents",10489 "name": "AgentUpdateParams (request body)",10490 "official_type_name": "BetaManagedAgentsAgentUpdateParams",10491 "description": "Update Agent",10492 "fields": [10493 {10494 "name": "description",10495 "type": "string or null",10496 "required": false,10497 "description": "Description. Omit to preserve; send empty string or null to clear.",10498 "constraints": {10499 "maxLength": "2048"10500 }10501 },10502 {10503 "name": "mcp_servers",10504 "type": "array of BetaManagedAgentsURLMCPServerParams or null",10505 "required": false,10506 "description": "MCP servers. Full replacement. Omit to preserve; send empty array or `null` to clear. Names must be unique. Maximum 20. Every server must be referenced by an `mcp_toolset` in the agent's resulting `tools`; unreferenced servers are rejected. See the [MCP connector guide](https://platform.claude.com/docs/en/managed-agents/mcp-connector)."10507 },10508 {10509 "name": "mcp_servers.type",10510 "type": "\"url\"",10511 "required": true,10512 "description": ""10513 },10514 {10515 "name": "mcp_servers.name",10516 "type": "string",10517 "required": true,10518 "description": "Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.",10519 "constraints": {10520 "minLength": "1",10521 "maxLength": "255"10522 }10523 },10524 {10525 "name": "mcp_servers.url",10526 "type": "string",10527 "required": true,10528 "description": "Endpoint URL for the MCP server.",10529 "constraints": {10530 "maxLength": "2048"10531 }10532 },10533 {10534 "name": "metadata",10535 "type": "map[string] or null",10536 "required": false,10537 "description": "Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars."10538 },10539 {10540 "name": "model",10541 "type": "BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams",10542 "required": false,10543 "description": "Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control. Omit to preserve. Cannot be cleared."10544 },10545 {10546 "name": "model<BetaManagedAgentsModel = \"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more or string>",10547 "type": "BetaManagedAgentsModel = \"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more or string",10548 "required": false,10549 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."10550 },10551 {10552 "name": "model<BetaManagedAgentsModel = \"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more or string><\"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more>",10553 "type": "\"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more",10554 "required": false,10555 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."10556 },10557 {10558 "name": "model<BetaManagedAgentsModel = \"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more or string><string>",10559 "type": "string",10560 "required": false,10561 "description": ""10562 },10563 {10564 "name": "model<BetaManagedAgentsModelConfigParams>",10565 "type": "BetaManagedAgentsModelConfigParams object",10566 "required": false,10567 "description": "An object that defines additional configuration control over model use"10568 },10569 {10570 "name": "model<BetaManagedAgentsModelConfigParams>.id",10571 "type": "BetaManagedAgentsModel",10572 "required": true,10573 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."10574 },10575 {10576 "name": "model<BetaManagedAgentsModelConfigParams>.effort",10577 "type": "\"low\" or \"medium\" or \"high\" or 2 more or BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or 3 more or null",10578 "required": false,10579 "description": "How hard Claude works on each inference call. Accepts a bare level string (`\"high\"`) or `{\"type\": \"high\"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged."10580 },10581 {10582 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortLevel = \"low\" or \"medium\" or \"high\" or 2 more>",10583 "type": "BetaManagedAgentsEffortLevel = \"low\" or \"medium\" or \"high\" or 2 more",10584 "required": false,10585 "description": "How hard Claude works on each turn. Higher levels favor reasoning depth over latency. Not all models accept every level; invalid combinations are rejected at create time."10586 },10587 {10588 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortLow>",10589 "type": "BetaManagedAgentsEffortLow object",10590 "required": false,10591 "description": "Low effort. Favors latency over reasoning depth."10592 },10593 {10594 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortMedium>",10595 "type": "BetaManagedAgentsEffortMedium object",10596 "required": false,10597 "description": "Medium effort. Balances latency and reasoning depth."10598 },10599 {10600 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortHigh>",10601 "type": "BetaManagedAgentsEffortHigh object",10602 "required": false,10603 "description": "High effort. Favors reasoning depth."10604 },10605 {10606 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortXhigh>",10607 "type": "BetaManagedAgentsEffortXhigh object",10608 "required": false,10609 "description": "Extra-high effort. Not all models accept this level."10610 },10611 {10612 "name": "model<BetaManagedAgentsModelConfigParams>.effort<BetaManagedAgentsEffortMax>",10613 "type": "BetaManagedAgentsEffortMax object",10614 "required": false,10615 "description": "Maximum effort. Favors reasoning depth over latency."10616 },10617 {10618 "name": "model<BetaManagedAgentsModelConfigParams>.inference_geo",10619 "type": "string or null",10620 "required": false,10621 "description": "Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it."10622 },10623 {10624 "name": "model<BetaManagedAgentsModelConfigParams>.speed",10625 "type": "\"standard\" or \"fast\" or null",10626 "required": false,10627 "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",10628 "enum": [10629 "standard",10630 "fast"10631 ]10632 },10633 {10634 "name": "multiagent",10635 "type": "BetaManagedAgentsMultiagentParams or null",10636 "required": false,10637 "description": "A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster."10638 },10639 {10640 "name": "multiagent.type",10641 "type": "\"coordinator\"",10642 "required": true,10643 "description": ""10644 },10645 {10646 "name": "multiagent.agents",10647 "type": "array of BetaManagedAgentsMultiagentRosterEntryParams",10648 "required": true,10649 "description": "Agents the coordinator may spawn as session threads. 1–20 entries. Each entry is an agent ID string, a versioned `{\"type\":\"agent\",\"id\",\"version\"}` reference, or `{\"type\":\"self\"}` to allow recursive self-invocation. Entries must reference distinct agents (after resolving `self` and string forms); at most one `self`. Referenced agents must exist, must not be archived, and must not themselves have `multiagent` set (depth limit 1)."10650 },10651 {10652 "name": "multiagent.agents<string>",10653 "type": "string",10654 "required": false,10655 "description": ""10656 },10657 {10658 "name": "multiagent.agents<BetaManagedAgentsAgentParams>",10659 "type": "BetaManagedAgentsAgentParams object",10660 "required": false,10661 "description": "Specification for an Agent. Provide a specific `version` or use the short-form `agent=\"agent_id\"` for the most recent version"10662 },10663 {10664 "name": "multiagent.agents<BetaManagedAgentsAgentParams>.type",10665 "type": "\"agent\"",10666 "required": true,10667 "description": ""10668 },10669 {10670 "name": "multiagent.agents<BetaManagedAgentsAgentParams>.id",10671 "type": "string",10672 "required": true,10673 "description": "The `agent` ID.",10674 "constraints": {10675 "minLength": "1",10676 "maxLength": "128"10677 }10678 },10679 {10680 "name": "multiagent.agents<BetaManagedAgentsAgentParams>.version",10681 "type": "number",10682 "required": false,10683 "description": "The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.",10684 "constraints": {10685 "format": "int32"10686 }10687 },10688 {10689 "name": "multiagent.agents<BetaManagedAgentsMultiagentSelfParams>",10690 "type": "BetaManagedAgentsMultiagentSelfParams object",10691 "required": false,10692 "description": "Sentinel roster entry meaning \"the agent that owns this configuration\". Resolved server-side to a concrete agent reference."10693 },10694 {10695 "name": "multiagent.agents<BetaManagedAgentsMultiagentSelfParams>.type",10696 "type": "\"self\"",10697 "required": true,10698 "description": ""10699 },10700 {10701 "name": "multiagent.agents<BetaManagedAgentsAdvisorParams>",10702 "type": "BetaManagedAgentsAdvisorParams object",10703 "required": false,10704 "description": "Platform advisor roster entry: a model the session's primary thread may consult mid-turn. At most one per roster; the entry occupies the roster name `anthropic.advisor`."10705 },10706 {10707 "name": "multiagent.agents<BetaManagedAgentsAdvisorParams>.type",10708 "type": "\"advisor\"",10709 "required": true,10710 "description": ""10711 },10712 {10713 "name": "multiagent.agents<BetaManagedAgentsAdvisorParams>.model",10714 "type": "string",10715 "required": true,10716 "description": "A Claude model id. The model must be permitted as an advisor for this agent's model — see the sessions/threads/advisor spec.",10717 "constraints": {10718 "minLength": "1",10719 "maxLength": "256"10720 }10721 },10722 {10723 "name": "name",10724 "type": "string",10725 "required": false,10726 "description": "Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.",10727 "constraints": {10728 "maxLength": "256"10729 }10730 },10731 {10732 "name": "skills",10733 "type": "array of BetaManagedAgentsSkillParams or null",10734 "required": false,10735 "description": "Skills. Full replacement. Omit to preserve; send empty array or null to clear."10736 },10737 {10738 "name": "skills<BetaManagedAgentsAnthropicSkillParams>",10739 "type": "BetaManagedAgentsAnthropicSkillParams object",10740 "required": false,10741 "description": "An Anthropic-managed skill."10742 },10743 {10744 "name": "skills<BetaManagedAgentsAnthropicSkillParams>.type",10745 "type": "\"anthropic\"",10746 "required": true,10747 "description": ""10748 },10749 {10750 "name": "skills<BetaManagedAgentsAnthropicSkillParams>.skill_id",10751 "type": "string",10752 "required": true,10753 "description": "Identifier of the Anthropic skill (e.g., \"xlsx\").",10754 "constraints": {10755 "minLength": "1",10756 "maxLength": "64"10757 }10758 },10759 {10760 "name": "skills<BetaManagedAgentsAnthropicSkillParams>.version",10761 "type": "string or null",10762 "required": false,10763 "description": "Version to pin. Defaults to latest if omitted.",10764 "constraints": {10765 "minLength": "1",10766 "maxLength": "64"10767 }10768 },10769 {10770 "name": "skills<BetaManagedAgentsCustomSkillParams>",10771 "type": "BetaManagedAgentsCustomSkillParams object",10772 "required": false,10773 "description": "A user-created custom skill."10774 },10775 {10776 "name": "skills<BetaManagedAgentsCustomSkillParams>.type",10777 "type": "\"custom\"",10778 "required": true,10779 "description": ""10780 },10781 {10782 "name": "skills<BetaManagedAgentsCustomSkillParams>.skill_id",10783 "type": "string",10784 "required": true,10785 "description": "Tagged ID of the custom skill (e.g., \"skill_01XJ5...\").",10786 "constraints": {10787 "minLength": "1",10788 "maxLength": "64"10789 }10790 },10791 {10792 "name": "skills<BetaManagedAgentsCustomSkillParams>.version",10793 "type": "string or null",10794 "required": false,10795 "description": "Version to pin. Defaults to latest if omitted.",10796 "constraints": {10797 "minLength": "1",10798 "maxLength": "64"10799 }10800 },10801 {10802 "name": "system",10803 "type": "string or null",10804 "required": false,10805 "description": "System prompt. Omit to preserve; send empty string or null to clear.",10806 "constraints": {10807 "maxLength": "100000"10808 }10809 },10810 {10811 "name": "tools",10812 "type": "array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams or null",10813 "required": false,10814 "description": "Tool configurations available to the agent. Full replacement. Omit to preserve; send empty array or null to clear. Maximum of 128 tools across all toolsets allowed."10815 },10816 {10817 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>",10818 "type": "BetaManagedAgentsAgentToolset20260401Params object",10819 "required": false,10820 "description": "Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent."10821 },10822 {10823 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.type",10824 "type": "\"agent_toolset_20260401\"",10825 "required": true,10826 "description": ""10827 },10828 {10829 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs",10830 "type": "array of BetaManagedAgentsAgentToolConfigParams",10831 "required": false,10832 "description": "Per-tool configuration overrides."10833 },10834 {10835 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsBashToolConfigParams>",10836 "type": "BetaManagedAgentsBashToolConfigParams object",10837 "required": false,10838 "description": "Configuration override for the bash tool."10839 },10840 {10841 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsEditToolConfigParams>",10842 "type": "BetaManagedAgentsEditToolConfigParams object",10843 "required": false,10844 "description": "Configuration override for the edit tool."10845 },10846 {10847 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsReadToolConfigParams>",10848 "type": "BetaManagedAgentsReadToolConfigParams object",10849 "required": false,10850 "description": "Configuration override for the read tool."10851 },10852 {10853 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWriteToolConfigParams>",10854 "type": "BetaManagedAgentsWriteToolConfigParams object",10855 "required": false,10856 "description": "Configuration override for the write tool."10857 },10858 {10859 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGlobToolConfigParams>",10860 "type": "BetaManagedAgentsGlobToolConfigParams object",10861 "required": false,10862 "description": "Configuration override for the glob tool."10863 },10864 {10865 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGrepToolConfigParams>",10866 "type": "BetaManagedAgentsGrepToolConfigParams object",10867 "required": false,10868 "description": "Configuration override for the grep tool."10869 },10870 {10871 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>",10872 "type": "BetaManagedAgentsWebFetchToolConfigParams object",10873 "required": false,10874 "description": "Configuration override for the web_fetch tool."10875 },10876 {10877 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>",10878 "type": "BetaManagedAgentsWebSearchToolConfigParams object",10879 "required": false,10880 "description": "Configuration override for the web_search tool."10881 },10882 {10883 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.default_config",10884 "type": "BetaManagedAgentsAgentToolsetDefaultConfigParams or null",10885 "required": false,10886 "description": "Default configuration for all tools in a toolset."10887 },10888 {10889 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.default_config.enabled",10890 "type": "boolean or null",10891 "required": false,10892 "description": "Whether tools are enabled and available to Claude by default. Defaults to true if not specified."10893 },10894 {10895 "name": "tools<BetaManagedAgentsAgentToolset20260401Params>.default_config.permission_policy",10896 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",10897 "required": false,10898 "description": "Permission policy for tool execution."10899 },10900 {10901 "name": "tools<BetaManagedAgentsMCPToolsetParams>",10902 "type": "BetaManagedAgentsMCPToolsetParams object",10903 "required": false,10904 "description": "Configuration for tools from an MCP server defined in `mcp_servers`."10905 },10906 {10907 "name": "tools<BetaManagedAgentsMCPToolsetParams>.type",10908 "type": "\"mcp_toolset\"",10909 "required": true,10910 "description": ""10911 },10912 {10913 "name": "tools<BetaManagedAgentsMCPToolsetParams>.mcp_server_name",10914 "type": "string",10915 "required": true,10916 "description": "Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters.",10917 "constraints": {10918 "minLength": "1",10919 "maxLength": "255"10920 }10921 },10922 {10923 "name": "tools<BetaManagedAgentsMCPToolsetParams>.configs",10924 "type": "array of BetaManagedAgentsMCPToolConfigParams",10925 "required": false,10926 "description": "Per-tool configuration overrides."10927 },10928 {10929 "name": "tools<BetaManagedAgentsMCPToolsetParams>.configs.name",10930 "type": "string",10931 "required": true,10932 "description": "Name of the MCP tool to configure. 1-128 characters.",10933 "constraints": {10934 "minLength": "1",10935 "maxLength": "128"10936 }10937 },10938 {10939 "name": "tools<BetaManagedAgentsMCPToolsetParams>.configs.enabled",10940 "type": "boolean or null",10941 "required": false,10942 "description": "Whether this tool is enabled. Overrides the `default_config` setting."10943 },10944 {10945 "name": "tools<BetaManagedAgentsMCPToolsetParams>.configs.permission_policy",10946 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",10947 "required": false,10948 "description": "Permission policy for tool execution."10949 },10950 {10951 "name": "tools<BetaManagedAgentsMCPToolsetParams>.default_config",10952 "type": "BetaManagedAgentsMCPToolsetDefaultConfigParams or null",10953 "required": false,10954 "description": "Default configuration for all tools from an MCP server."10955 },10956 {10957 "name": "tools<BetaManagedAgentsMCPToolsetParams>.default_config.enabled",10958 "type": "boolean or null",10959 "required": false,10960 "description": "Whether tools are enabled by default. Defaults to true if not specified."10961 },10962 {10963 "name": "tools<BetaManagedAgentsMCPToolsetParams>.default_config.permission_policy",10964 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",10965 "required": false,10966 "description": "Permission policy for tool execution."10967 },10968 {10969 "name": "tools<BetaManagedAgentsCustomToolParams>",10970 "type": "BetaManagedAgentsCustomToolParams object",10971 "required": false,10972 "description": "A custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an `agent.custom_tool_use` event is emitted and the session goes idle, waiting for the client to provide the result via a `user.custom_tool_result` event."10973 },10974 {10975 "name": "tools<BetaManagedAgentsCustomToolParams>.type",10976 "type": "\"custom\"",10977 "required": true,10978 "description": ""10979 },10980 {10981 "name": "tools<BetaManagedAgentsCustomToolParams>.description",10982 "type": "string",10983 "required": true,10984 "description": "Description of what the tool does, shown to the agent to help it decide when to use the tool.",10985 "constraints": {10986 "minLength": "1"10987 }10988 },10989 {10990 "name": "tools<BetaManagedAgentsCustomToolParams>.input_schema",10991 "type": "BetaManagedAgentsCustomToolInputSchema",10992 "required": true,10993 "description": "JSON Schema for custom tool input parameters."10994 },10995 {10996 "name": "tools<BetaManagedAgentsCustomToolParams>.input_schema.type",10997 "type": "\"object\"",10998 "required": true,10999 "description": ""11000 },11001 {11002 "name": "tools<BetaManagedAgentsCustomToolParams>.input_schema.properties",11003 "type": "map[unknown] or null",11004 "required": false,11005 "description": ""11006 },11007 {11008 "name": "tools<BetaManagedAgentsCustomToolParams>.input_schema.required",11009 "type": "array of string or null",11010 "required": false,11011 "description": ""11012 },11013 {11014 "name": "tools<BetaManagedAgentsCustomToolParams>.name",11015 "type": "string",11016 "required": true,11017 "description": "Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.",11018 "constraints": {11019 "minLength": "1",11020 "maxLength": "128"11021 }11022 },11023 {11024 "name": "version",11025 "type": "number",11026 "required": false,11027 "description": "The agent's current version, used to prevent concurrent overwrites. Obtain this value from a create or retrieve response. Must be at least 1 if specified. When supplied, the request fails if it does not match the server's current version; omit to apply the update unconditionally.",11028 "constraints": {11029 "format": "int32"11030 }11031 }11032 ],11033 "status": [11034 "DOCUMENTED",11035 "BETA"11036 ],11037 "sources": [11038 {11039 "url": "https://platform.claude.com/docs/en/api/beta/agents/update",11040 "retrieved_at": "2026-09-18"11041 },11042 {11043 "url": "https://platform.claude.com/docs/en/managed-agents/agent-setup",11044 "retrieved_at": "2026-09-18"11045 }11046 ],11047 "beta_header": "managed-agents-2026-04-01"11048 },11049 {11050 "provider": "anthropic",11051 "api_family": "managed-agents",11052 "name": "Session",11053 "official_type_name": "BetaManagedAgentsSession",11054 "description": "A Managed Agents `session`.",11055 "fields": [11056 {11057 "name": "type",11058 "type": "\"session\"",11059 "required": true,11060 "description": ""11061 },11062 {11063 "name": "id",11064 "type": "string",11065 "required": true,11066 "description": ""11067 },11068 {11069 "name": "agent",11070 "type": "BetaManagedAgentsSessionAgent",11071 "required": true,11072 "description": "Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time."11073 },11074 {11075 "name": "agent.type",11076 "type": "\"agent\"",11077 "required": true,11078 "description": ""11079 },11080 {11081 "name": "agent.id",11082 "type": "string",11083 "required": true,11084 "description": ""11085 },11086 {11087 "name": "agent.description",11088 "type": "string or null",11089 "required": true,11090 "description": ""11091 },11092 {11093 "name": "agent.mcp_servers",11094 "type": "array of BetaManagedAgentsMCPServerURLDefinition",11095 "required": true,11096 "description": ""11097 },11098 {11099 "name": "agent.mcp_servers.type",11100 "type": "\"url\"",11101 "required": true,11102 "description": ""11103 },11104 {11105 "name": "agent.mcp_servers.name",11106 "type": "string",11107 "required": true,11108 "description": ""11109 },11110 {11111 "name": "agent.mcp_servers.url",11112 "type": "string",11113 "required": true,11114 "description": ""11115 },11116 {11117 "name": "agent.model",11118 "type": "BetaManagedAgentsModelConfig",11119 "required": true,11120 "description": "Model identifier and configuration."11121 },11122 {11123 "name": "agent.model.id",11124 "type": "BetaManagedAgentsModel",11125 "required": true,11126 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."11127 },11128 {11129 "name": "agent.model.id<\"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more>",11130 "type": "\"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more",11131 "required": false,11132 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."11133 },11134 {11135 "name": "agent.model.id<string>",11136 "type": "string",11137 "required": false,11138 "description": ""11139 },11140 {11141 "name": "agent.model.effort",11142 "type": "BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more",11143 "required": false,11144 "description": "How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes."11145 },11146 {11147 "name": "agent.model.effort<BetaManagedAgentsEffortLow>",11148 "type": "BetaManagedAgentsEffortLow object",11149 "required": false,11150 "description": "Low effort. Favors latency over reasoning depth."11151 },11152 {11153 "name": "agent.model.effort<BetaManagedAgentsEffortLow>.type",11154 "type": "\"low\"",11155 "required": true,11156 "description": ""11157 },11158 {11159 "name": "agent.model.effort<BetaManagedAgentsEffortMedium>",11160 "type": "BetaManagedAgentsEffortMedium object",11161 "required": false,11162 "description": "Medium effort. Balances latency and reasoning depth."11163 },11164 {11165 "name": "agent.model.effort<BetaManagedAgentsEffortMedium>.type",11166 "type": "\"medium\"",11167 "required": true,11168 "description": ""11169 },11170 {11171 "name": "agent.model.effort<BetaManagedAgentsEffortHigh>",11172 "type": "BetaManagedAgentsEffortHigh object",11173 "required": false,11174 "description": "High effort. Favors reasoning depth."11175 },11176 {11177 "name": "agent.model.effort<BetaManagedAgentsEffortHigh>.type",11178 "type": "\"high\"",11179 "required": true,11180 "description": ""11181 },11182 {11183 "name": "agent.model.effort<BetaManagedAgentsEffortXhigh>",11184 "type": "BetaManagedAgentsEffortXhigh object",11185 "required": false,11186 "description": "Extra-high effort. Not all models accept this level."11187 },11188 {11189 "name": "agent.model.effort<BetaManagedAgentsEffortXhigh>.type",11190 "type": "\"xhigh\"",11191 "required": true,11192 "description": ""11193 },11194 {11195 "name": "agent.model.effort<BetaManagedAgentsEffortMax>",11196 "type": "BetaManagedAgentsEffortMax object",11197 "required": false,11198 "description": "Maximum effort. Favors reasoning depth over latency."11199 },11200 {11201 "name": "agent.model.effort<BetaManagedAgentsEffortMax>.type",11202 "type": "\"max\"",11203 "required": true,11204 "description": ""11205 },11206 {11207 "name": "agent.model.inference_geo",11208 "type": "string",11209 "required": false,11210 "description": "Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo."11211 },11212 {11213 "name": "agent.model.speed",11214 "type": "\"standard\" or \"fast\"",11215 "required": false,11216 "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",11217 "enum": [11218 "standard",11219 "fast"11220 ]11221 },11222 {11223 "name": "agent.multiagent",11224 "type": "BetaManagedAgentsSessionMultiagentCoordinator or null",11225 "required": true,11226 "description": "Resolved coordinator topology with full agent definitions for each roster member."11227 },11228 {11229 "name": "agent.multiagent.type",11230 "type": "\"coordinator\"",11231 "required": true,11232 "description": ""11233 },11234 {11235 "name": "agent.multiagent.agents",11236 "type": "array of BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor",11237 "required": true,11238 "description": "Full `agent` definitions the coordinator may spawn as session threads."11239 },11240 {11241 "name": "agent.multiagent.agents<BetaManagedAgentsSessionThreadAgent>",11242 "type": "BetaManagedAgentsSessionThreadAgent object",11243 "required": false,11244 "description": "Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`."11245 },11246 {11247 "name": "agent.multiagent.agents<BetaManagedAgentsSessionThreadAgent>.type",11248 "type": "\"agent\"",11249 "required": true,11250 "description": ""11251 },11252 {11253 "name": "agent.multiagent.agents<BetaManagedAgentsSessionThreadAgent>.id",11254 "type": "string",11255 "required": true,11256 "description": ""11257 },11258 {11259 "name": "agent.multiagent.agents<BetaManagedAgentsSessionThreadAgent>.description",11260 "type": "string or null",11261 "required": true,11262 "description": ""11263 },11264 {11265 "name": "agent.multiagent.agents<BetaManagedAgentsSessionThreadAgent>.mcp_servers",11266 "type": "array of BetaManagedAgentsMCPServerURLDefinition",11267 "required": true,11268 "description": ""11269 },11270 {11271 "name": "agent.multiagent.agents<BetaManagedAgentsSessionThreadAgent>.model",11272 "type": "BetaManagedAgentsModelConfig",11273 "required": true,11274 "description": "Model identifier and configuration."11275 },11276 {11277 "name": "agent.multiagent.agents<BetaManagedAgentsSessionThreadAgent>.name",11278 "type": "string",11279 "required": true,11280 "description": ""11281 },11282 {11283 "name": "agent.multiagent.agents<BetaManagedAgentsSessionThreadAgent>.skills",11284 "type": "array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill",11285 "required": true,11286 "description": ""11287 },11288 {11289 "name": "agent.multiagent.agents<BetaManagedAgentsSessionThreadAgent>.system",11290 "type": "string or null",11291 "required": true,11292 "description": ""11293 },11294 {11295 "name": "agent.multiagent.agents<BetaManagedAgentsSessionThreadAgent>.tools",11296 "type": "array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool",11297 "required": true,11298 "description": ""11299 },11300 {11301 "name": "agent.multiagent.agents<BetaManagedAgentsSessionThreadAgent>.version",11302 "type": "number",11303 "required": true,11304 "description": "",11305 "constraints": {11306 "format": "int32"11307 }11308 },11309 {11310 "name": "agent.multiagent.agents<BetaManagedAgentsAdvisor>",11311 "type": "BetaManagedAgentsAdvisor object",11312 "required": false,11313 "description": "Platform advisor roster entry: a model the session's primary thread may consult mid-turn."11314 },11315 {11316 "name": "agent.multiagent.agents<BetaManagedAgentsAdvisor>.type",11317 "type": "\"advisor\"",11318 "required": true,11319 "description": ""11320 },11321 {11322 "name": "agent.multiagent.agents<BetaManagedAgentsAdvisor>.model",11323 "type": "string",11324 "required": true,11325 "description": "The advisor model id."11326 },11327 {11328 "name": "agent.name",11329 "type": "string",11330 "required": true,11331 "description": ""11332 },11333 {11334 "name": "agent.skills",11335 "type": "array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill",11336 "required": true,11337 "description": ""11338 },11339 {11340 "name": "agent.skills<BetaManagedAgentsAnthropicSkill>",11341 "type": "BetaManagedAgentsAnthropicSkill object",11342 "required": false,11343 "description": "A resolved Anthropic-managed skill."11344 },11345 {11346 "name": "agent.skills<BetaManagedAgentsCustomSkill>",11347 "type": "BetaManagedAgentsCustomSkill object",11348 "required": false,11349 "description": "A resolved user-created custom skill."11350 },11351 {11352 "name": "agent.system",11353 "type": "string or null",11354 "required": true,11355 "description": ""11356 },11357 {11358 "name": "agent.tools",11359 "type": "array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool",11360 "required": true,11361 "description": ""11362 },11363 {11364 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401>",11365 "type": "BetaManagedAgentsAgentToolset20260401 object",11366 "required": false,11367 "description": ""11368 },11369 {11370 "name": "agent.tools<BetaManagedAgentsMCPToolset>",11371 "type": "BetaManagedAgentsMCPToolset object",11372 "required": false,11373 "description": ""11374 },11375 {11376 "name": "agent.tools<BetaManagedAgentsCustomTool>",11377 "type": "BetaManagedAgentsCustomTool object",11378 "required": false,11379 "description": "A custom tool as returned in API responses."11380 },11381 {11382 "name": "agent.version",11383 "type": "number",11384 "required": true,11385 "description": "",11386 "constraints": {11387 "format": "int32"11388 }11389 },11390 {11391 "name": "archived_at",11392 "type": "string or null",11393 "required": true,11394 "description": "A timestamp in RFC 3339 format",11395 "constraints": {11396 "format": "date-time"11397 }11398 },11399 {11400 "name": "budget",11401 "type": "BetaManagedAgentsBudgetLimit or null",11402 "required": true,11403 "description": "A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`."11404 },11405 {11406 "name": "budget.type",11407 "type": "\"limit\"",11408 "required": true,11409 "description": ""11410 },11411 {11412 "name": "budget.max_list_cost",11413 "type": "BetaMonetaryAmount",11414 "required": true,11415 "description": "A monetary amount in a specific currency."11416 },11417 {11418 "name": "budget.max_list_cost.amount",11419 "type": "string",11420 "required": true,11421 "description": "Amount in minor units of the currency, as an integer decimal string with no leading zeros: \"2500\" is $25.00 and \"50\" is fifty cents. A string rather than a number so no float rounding is ever applied."11422 },11423 {11424 "name": "budget.max_list_cost.currency",11425 "type": "BetaCurrency",11426 "required": true,11427 "description": "Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced."11428 },11429 {11430 "name": "created_at",11431 "type": "string",11432 "required": true,11433 "description": "A timestamp in RFC 3339 format",11434 "constraints": {11435 "format": "date-time"11436 }11437 },11438 {11439 "name": "environment_id",11440 "type": "string",11441 "required": true,11442 "description": ""11443 },11444 {11445 "name": "metadata",11446 "type": "map[string]",11447 "required": true,11448 "description": ""11449 },11450 {11451 "name": "outcome_evaluations",11452 "type": "array of BetaManagedAgentsOutcomeEvaluationResource",11453 "required": true,11454 "description": "Per-outcome evaluation state. One entry per `define_outcome` event sent to the session."11455 },11456 {11457 "name": "outcome_evaluations.type",11458 "type": "\"outcome_evaluation\"",11459 "required": true,11460 "description": ""11461 },11462 {11463 "name": "outcome_evaluations.completed_at",11464 "type": "string or null",11465 "required": true,11466 "description": "A timestamp in RFC 3339 format",11467 "constraints": {11468 "format": "date-time"11469 }11470 },11471 {11472 "name": "outcome_evaluations.description",11473 "type": "string",11474 "required": true,11475 "description": "What the agent should produce."11476 },11477 {11478 "name": "outcome_evaluations.explanation",11479 "type": "string or null",11480 "required": true,11481 "description": "Grader's verdict text from the most recent evaluation. For `satisfied`, explains why criteria are met; for `needs_revision` (intermediate), what's missing; for `failed`, why unrecoverable."11482 },11483 {11484 "name": "outcome_evaluations.iteration",11485 "type": "number",11486 "required": true,11487 "description": "0-indexed revision cycle the outcome is currently on.",11488 "constraints": {11489 "format": "int32"11490 }11491 },11492 {11493 "name": "outcome_evaluations.outcome_id",11494 "type": "string",11495 "required": true,11496 "description": "Server-generated outc_ ID for this outcome."11497 },11498 {11499 "name": "outcome_evaluations.result",11500 "type": "string",11501 "required": true,11502 "description": "Current evaluation state. `pending` before the agent begins work; `running` while producing or revising; `evaluating` while the grader scores; `satisfied`/`max_iterations_reached`/`failed`/`interrupted` are terminal."11503 },11504 {11505 "name": "resources",11506 "type": "array of BetaManagedAgentsSessionResource",11507 "required": true,11508 "description": ""11509 },11510 {11511 "name": "resources<BetaManagedAgentsGitHubRepositoryResource>",11512 "type": "BetaManagedAgentsGitHubRepositoryResource object",11513 "required": false,11514 "description": ""11515 },11516 {11517 "name": "resources<BetaManagedAgentsGitHubRepositoryResource>.type",11518 "type": "\"github_repository\"",11519 "required": true,11520 "description": ""11521 },11522 {11523 "name": "resources<BetaManagedAgentsGitHubRepositoryResource>.id",11524 "type": "string",11525 "required": true,11526 "description": ""11527 },11528 {11529 "name": "resources<BetaManagedAgentsGitHubRepositoryResource>.created_at",11530 "type": "string",11531 "required": true,11532 "description": "A timestamp in RFC 3339 format",11533 "constraints": {11534 "format": "date-time"11535 }11536 },11537 {11538 "name": "resources<BetaManagedAgentsGitHubRepositoryResource>.mount_path",11539 "type": "string",11540 "required": true,11541 "description": ""11542 },11543 {11544 "name": "resources<BetaManagedAgentsGitHubRepositoryResource>.updated_at",11545 "type": "string",11546 "required": true,11547 "description": "A timestamp in RFC 3339 format",11548 "constraints": {11549 "format": "date-time"11550 }11551 },11552 {11553 "name": "resources<BetaManagedAgentsGitHubRepositoryResource>.url",11554 "type": "string",11555 "required": true,11556 "description": ""11557 },11558 {11559 "name": "resources<BetaManagedAgentsGitHubRepositoryResource>.checkout",11560 "type": "BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null",11561 "required": false,11562 "description": ""11563 },11564 {11565 "name": "resources<BetaManagedAgentsGitHubRepositoryResource>.checkout<BetaManagedAgentsBranchCheckout>",11566 "type": "BetaManagedAgentsBranchCheckout object",11567 "required": false,11568 "description": ""11569 },11570 {11571 "name": "resources<BetaManagedAgentsGitHubRepositoryResource>.checkout<BetaManagedAgentsBranchCheckout>.type",11572 "type": "\"branch\"",11573 "required": true,11574 "description": ""11575 },11576 {11577 "name": "resources<BetaManagedAgentsGitHubRepositoryResource>.checkout<BetaManagedAgentsBranchCheckout>.name",11578 "type": "string",11579 "required": true,11580 "description": "Branch name to check out.",11581 "constraints": {11582 "minLength": "1",11583 "maxLength": "255"11584 }11585 },11586 {11587 "name": "resources<BetaManagedAgentsGitHubRepositoryResource>.checkout<BetaManagedAgentsCommitCheckout>",11588 "type": "BetaManagedAgentsCommitCheckout object",11589 "required": false,11590 "description": ""11591 },11592 {11593 "name": "resources<BetaManagedAgentsGitHubRepositoryResource>.checkout<BetaManagedAgentsCommitCheckout>.type",11594 "type": "\"commit\"",11595 "required": true,11596 "description": ""11597 },11598 {11599 "name": "resources<BetaManagedAgentsGitHubRepositoryResource>.checkout<BetaManagedAgentsCommitCheckout>.sha",11600 "type": "string",11601 "required": true,11602 "description": "Full commit SHA to check out.",11603 "constraints": {11604 "minLength": "7",11605 "maxLength": "64"11606 }11607 },11608 {11609 "name": "resources<BetaManagedAgentsFileResource>",11610 "type": "BetaManagedAgentsFileResource object",11611 "required": false,11612 "description": ""11613 },11614 {11615 "name": "resources<BetaManagedAgentsFileResource>.type",11616 "type": "\"file\"",11617 "required": true,11618 "description": ""11619 },11620 {11621 "name": "resources<BetaManagedAgentsFileResource>.id",11622 "type": "string",11623 "required": true,11624 "description": ""11625 },11626 {11627 "name": "resources<BetaManagedAgentsFileResource>.created_at",11628 "type": "string",11629 "required": true,11630 "description": "A timestamp in RFC 3339 format",11631 "constraints": {11632 "format": "date-time"11633 }11634 },11635 {11636 "name": "resources<BetaManagedAgentsFileResource>.file_id",11637 "type": "string",11638 "required": true,11639 "description": ""11640 },11641 {11642 "name": "resources<BetaManagedAgentsFileResource>.mount_path",11643 "type": "string",11644 "required": true,11645 "description": ""11646 },11647 {11648 "name": "resources<BetaManagedAgentsFileResource>.updated_at",11649 "type": "string",11650 "required": true,11651 "description": "A timestamp in RFC 3339 format",11652 "constraints": {11653 "format": "date-time"11654 }11655 },11656 {11657 "name": "resources<BetaManagedAgentsMemoryStoreResource>",11658 "type": "BetaManagedAgentsMemoryStoreResource object",11659 "required": false,11660 "description": "A memory store attached to an agent session."11661 },11662 {11663 "name": "resources<BetaManagedAgentsMemoryStoreResource>.type",11664 "type": "\"memory_store\"",11665 "required": true,11666 "description": ""11667 },11668 {11669 "name": "resources<BetaManagedAgentsMemoryStoreResource>.memory_store_id",11670 "type": "string",11671 "required": true,11672 "description": "The memory store ID (memstore_...). Must belong to the caller's organization and workspace."11673 },11674 {11675 "name": "resources<BetaManagedAgentsMemoryStoreResource>.access",11676 "type": "\"read_write\" or \"read_only\" or null",11677 "required": false,11678 "description": "Access mode for an attached memory store.",11679 "enum": [11680 "read_write",11681 "read_only"11682 ]11683 },11684 {11685 "name": "resources<BetaManagedAgentsMemoryStoreResource>.description",11686 "type": "string",11687 "required": false,11688 "description": "Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description."11689 },11690 {11691 "name": "resources<BetaManagedAgentsMemoryStoreResource>.instructions",11692 "type": "string or null",11693 "required": false,11694 "description": "Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.",11695 "constraints": {11696 "maxLength": "4096"11697 }11698 },11699 {11700 "name": "resources<BetaManagedAgentsMemoryStoreResource>.mount_path",11701 "type": "string or null",11702 "required": false,11703 "description": "Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only."11704 },11705 {11706 "name": "resources<BetaManagedAgentsMemoryStoreResource>.name",11707 "type": "string or null",11708 "required": false,11709 "description": "Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource."11710 },11711 {11712 "name": "stats",11713 "type": "BetaManagedAgentsSessionStats",11714 "required": true,11715 "description": "Timing statistics for a session."11716 },11717 {11718 "name": "stats.active_seconds",11719 "type": "number",11720 "required": false,11721 "description": "Cumulative time in seconds the session spent in `running` status. Excludes idle time.",11722 "constraints": {11723 "format": "double"11724 }11725 },11726 {11727 "name": "stats.duration_seconds",11728 "type": "number",11729 "required": false,11730 "description": "Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update.",11731 "constraints": {11732 "format": "double"11733 }11734 },11735 {11736 "name": "status",11737 "type": "\"rescheduling\" or \"running\" or \"idle\" or \"terminated\"",11738 "required": true,11739 "description": "SessionStatus enum",11740 "enum": [11741 "rescheduling",11742 "running",11743 "idle",11744 "terminated"11745 ]11746 },11747 {11748 "name": "title",11749 "type": "string or null",11750 "required": true,11751 "description": ""11752 },11753 {11754 "name": "updated_at",11755 "type": "string",11756 "required": true,11757 "description": "A timestamp in RFC 3339 format",11758 "constraints": {11759 "format": "date-time"11760 }11761 },11762 {11763 "name": "usage",11764 "type": "BetaManagedAgentsSessionUsage",11765 "required": true,11766 "description": "Cumulative token usage for a session across all turns."11767 },11768 {11769 "name": "usage.active_seconds",11770 "type": "number",11771 "required": false,11772 "description": "Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once, unlike `stats.active_seconds`, which sums each thread's own active time. This is the duration the session's runtime cost is priced on.",11773 "constraints": {11774 "format": "double"11775 }11776 },11777 {11778 "name": "usage.cache_creation",11779 "type": "BetaManagedAgentsCacheCreationUsage",11780 "required": false,11781 "description": "Prompt-cache creation token usage broken down by cache lifetime."11782 },11783 {11784 "name": "usage.cache_creation.ephemeral_1h_input_tokens",11785 "type": "number",11786 "required": false,11787 "description": "Tokens used to create 1-hour ephemeral cache entries.",11788 "constraints": {11789 "format": "int32"11790 }11791 },11792 {11793 "name": "usage.cache_creation.ephemeral_5m_input_tokens",11794 "type": "number",11795 "required": false,11796 "description": "Tokens used to create 5-minute ephemeral cache entries.",11797 "constraints": {11798 "format": "int32"11799 }11800 },11801 {11802 "name": "usage.cache_read_input_tokens",11803 "type": "number",11804 "required": false,11805 "description": "Total tokens read from prompt cache.",11806 "constraints": {11807 "format": "int32"11808 }11809 },11810 {11811 "name": "usage.input_tokens",11812 "type": "number",11813 "required": false,11814 "description": "Total input tokens consumed across all turns.",11815 "constraints": {11816 "format": "int32"11817 }11818 },11819 {11820 "name": "usage.list_cost",11821 "type": "BetaMonetaryAmount or null",11822 "required": false,11823 "description": "A monetary amount in a specific currency."11824 },11825 {11826 "name": "usage.output_tokens",11827 "type": "number",11828 "required": false,11829 "description": "Total output tokens generated across all turns.",11830 "constraints": {11831 "format": "int32"11832 }11833 },11834 {11835 "name": "usage.server_tool_use",11836 "type": "BetaManagedAgentsServerToolUsage or null",11837 "required": false,11838 "description": "Cumulative count of server-executed tool invocations, broken down by tool."11839 },11840 {11841 "name": "usage.server_tool_use.web_fetch_requests",11842 "type": "number",11843 "required": false,11844 "description": "Number of server-executed web fetch requests.",11845 "constraints": {11846 "format": "int32"11847 }11848 },11849 {11850 "name": "usage.server_tool_use.web_search_requests",11851 "type": "number",11852 "required": false,11853 "description": "Number of server-executed web search requests.",11854 "constraints": {11855 "format": "int32"11856 }11857 },11858 {11859 "name": "vault_ids",11860 "type": "array of string",11861 "required": true,11862 "description": "Vault IDs attached to the session at creation. Empty when no vaults were supplied."11863 },11864 {11865 "name": "deployment_id",11866 "type": "string or null",11867 "required": false,11868 "description": "Deployment ID when the session was created from a deployment reference. Null otherwise."11869 }11870 ],11871 "status": [11872 "DOCUMENTED",11873 "BETA"11874 ],11875 "sources": [11876 {11877 "url": "https://platform.claude.com/docs/en/api/beta/sessions/create",11878 "retrieved_at": "2026-09-18"11879 },11880 {11881 "url": "https://platform.claude.com/docs/en/managed-agents/sessions",11882 "retrieved_at": "2026-09-18"11883 },11884 {11885 "url": "https://platform.claude.com/docs/en/managed-agents/session-operations",11886 "retrieved_at": "2026-09-18"11887 }11888 ],11889 "beta_header": "managed-agents-2026-04-01"11890 },11891 {11892 "provider": "anthropic",11893 "api_family": "managed-agents",11894 "name": "SessionCreateParams (request body)",11895 "official_type_name": "BetaManagedAgentsSessionCreateParams",11896 "description": "Create Session",11897 "fields": [11898 {11899 "name": "agent",11900 "type": "string or BetaManagedAgentsAgentParams or BetaManagedAgentsAgentWithOverridesParams",11901 "required": true,11902 "description": "Agent identifier. Accepts the `agent` ID string, which pins the latest version for the session, or an `agent` object with both id and version specified."11903 },11904 {11905 "name": "agent<string>",11906 "type": "string",11907 "required": false,11908 "description": ""11909 },11910 {11911 "name": "agent<BetaManagedAgentsAgentParams>",11912 "type": "BetaManagedAgentsAgentParams object",11913 "required": false,11914 "description": "Specification for an Agent. Provide a specific `version` or use the short-form `agent=\"agent_id\"` for the most recent version"11915 },11916 {11917 "name": "agent<BetaManagedAgentsAgentParams>.type",11918 "type": "\"agent\"",11919 "required": true,11920 "description": ""11921 },11922 {11923 "name": "agent<BetaManagedAgentsAgentParams>.id",11924 "type": "string",11925 "required": true,11926 "description": "The `agent` ID.",11927 "constraints": {11928 "minLength": "1",11929 "maxLength": "128"11930 }11931 },11932 {11933 "name": "agent<BetaManagedAgentsAgentParams>.version",11934 "type": "number",11935 "required": false,11936 "description": "The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.",11937 "constraints": {11938 "format": "int32"11939 }11940 },11941 {11942 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>",11943 "type": "BetaManagedAgentsAgentWithOverridesParams object",11944 "required": false,11945 "description": "Reference to an `agent` plus optional configuration overrides. Each provided field replaces the agent's value for the caller's use; the agent resource is unchanged."11946 },11947 {11948 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.type",11949 "type": "\"agent_with_overrides\"",11950 "required": true,11951 "description": ""11952 },11953 {11954 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.id",11955 "type": "string",11956 "required": true,11957 "description": "The `agent` ID.",11958 "constraints": {11959 "minLength": "1",11960 "maxLength": "128"11961 }11962 },11963 {11964 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.mcp_servers",11965 "type": "array of BetaManagedAgentsURLMCPServerParams",11966 "required": false,11967 "description": "Replacement MCP server list. Full replacement: the provided array becomes the MCP servers. Send an empty array to clear; omit to preserve the agent's servers."11968 },11969 {11970 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.mcp_servers.type",11971 "type": "\"url\"",11972 "required": true,11973 "description": ""11974 },11975 {11976 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.mcp_servers.name",11977 "type": "string",11978 "required": true,11979 "description": "Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.",11980 "constraints": {11981 "minLength": "1",11982 "maxLength": "255"11983 }11984 },11985 {11986 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.mcp_servers.url",11987 "type": "string",11988 "required": true,11989 "description": "Endpoint URL for the MCP server.",11990 "constraints": {11991 "maxLength": "2048"11992 }11993 },11994 {11995 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.model",11996 "type": "BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams",11997 "required": false,11998 "description": "Replacement model. Accepts the model string, e.g. `claude-opus-5`, or a `model_config` object. Omit to use the agent's model."11999 },12000 {12001 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.model<BetaManagedAgentsModel = \"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more or string>",12002 "type": "BetaManagedAgentsModel = \"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more or string",12003 "required": false,12004 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."12005 },12006 {12007 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.model<BetaManagedAgentsModel = \"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more or string><\"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more>",12008 "type": "\"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more",12009 "required": false,12010 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."12011 },12012 {12013 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.model<BetaManagedAgentsModel = \"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more or string><string>",12014 "type": "string",12015 "required": false,12016 "description": ""12017 },12018 {12019 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.model<BetaManagedAgentsModelConfigParams>",12020 "type": "BetaManagedAgentsModelConfigParams object",12021 "required": false,12022 "description": "An object that defines additional configuration control over model use"12023 },12024 {12025 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.model<BetaManagedAgentsModelConfigParams>.id",12026 "type": "BetaManagedAgentsModel",12027 "required": true,12028 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."12029 },12030 {12031 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.model<BetaManagedAgentsModelConfigParams>.effort",12032 "type": "\"low\" or \"medium\" or \"high\" or 2 more or BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or 3 more or null",12033 "required": false,12034 "description": "How hard Claude works on each inference call. Accepts a bare level string (`\"high\"`) or `{\"type\": \"high\"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged."12035 },12036 {12037 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.model<BetaManagedAgentsModelConfigParams>.inference_geo",12038 "type": "string or null",12039 "required": false,12040 "description": "Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it."12041 },12042 {12043 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.model<BetaManagedAgentsModelConfigParams>.speed",12044 "type": "\"standard\" or \"fast\" or null",12045 "required": false,12046 "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",12047 "enum": [12048 "standard",12049 "fast"12050 ]12051 },12052 {12053 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.skills",12054 "type": "array of BetaManagedAgentsSkillParams",12055 "required": false,12056 "description": "Replacement skill list. Full replacement: the provided array becomes the skills. Send an empty array to clear; omit to preserve the agent's skills."12057 },12058 {12059 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.skills<BetaManagedAgentsAnthropicSkillParams>",12060 "type": "BetaManagedAgentsAnthropicSkillParams object",12061 "required": false,12062 "description": "An Anthropic-managed skill."12063 },12064 {12065 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.skills<BetaManagedAgentsAnthropicSkillParams>.type",12066 "type": "\"anthropic\"",12067 "required": true,12068 "description": ""12069 },12070 {12071 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.skills<BetaManagedAgentsAnthropicSkillParams>.skill_id",12072 "type": "string",12073 "required": true,12074 "description": "Identifier of the Anthropic skill (e.g., \"xlsx\").",12075 "constraints": {12076 "minLength": "1",12077 "maxLength": "64"12078 }12079 },12080 {12081 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.skills<BetaManagedAgentsAnthropicSkillParams>.version",12082 "type": "string or null",12083 "required": false,12084 "description": "Version to pin. Defaults to latest if omitted.",12085 "constraints": {12086 "minLength": "1",12087 "maxLength": "64"12088 }12089 },12090 {12091 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.skills<BetaManagedAgentsCustomSkillParams>",12092 "type": "BetaManagedAgentsCustomSkillParams object",12093 "required": false,12094 "description": "A user-created custom skill."12095 },12096 {12097 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.skills<BetaManagedAgentsCustomSkillParams>.type",12098 "type": "\"custom\"",12099 "required": true,12100 "description": ""12101 },12102 {12103 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.skills<BetaManagedAgentsCustomSkillParams>.skill_id",12104 "type": "string",12105 "required": true,12106 "description": "Tagged ID of the custom skill (e.g., \"skill_01XJ5...\").",12107 "constraints": {12108 "minLength": "1",12109 "maxLength": "64"12110 }12111 },12112 {12113 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.skills<BetaManagedAgentsCustomSkillParams>.version",12114 "type": "string or null",12115 "required": false,12116 "description": "Version to pin. Defaults to latest if omitted.",12117 "constraints": {12118 "minLength": "1",12119 "maxLength": "64"12120 }12121 },12122 {12123 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.system",12124 "type": "string or null",12125 "required": false,12126 "description": "Replacement system prompt. Up to 100,000 characters. Set to null to clear the agent's system prompt; omit to preserve it.",12127 "constraints": {12128 "maxLength": "100000"12129 }12130 },12131 {12132 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools",12133 "type": "array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams",12134 "required": false,12135 "description": "Replacement tool list. Full replacement: the provided array becomes the tool configuration. Send an empty array to clear; omit to preserve the agent's tools."12136 },12137 {12138 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools<BetaManagedAgentsAgentToolset20260401Params>",12139 "type": "BetaManagedAgentsAgentToolset20260401Params object",12140 "required": false,12141 "description": "Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent."12142 },12143 {12144 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools<BetaManagedAgentsAgentToolset20260401Params>.type",12145 "type": "\"agent_toolset_20260401\"",12146 "required": true,12147 "description": ""12148 },12149 {12150 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools<BetaManagedAgentsAgentToolset20260401Params>.configs",12151 "type": "array of BetaManagedAgentsAgentToolConfigParams",12152 "required": false,12153 "description": "Per-tool configuration overrides."12154 },12155 {12156 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools<BetaManagedAgentsAgentToolset20260401Params>.default_config",12157 "type": "BetaManagedAgentsAgentToolsetDefaultConfigParams or null",12158 "required": false,12159 "description": "Default configuration for all tools in a toolset."12160 },12161 {12162 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools<BetaManagedAgentsMCPToolsetParams>",12163 "type": "BetaManagedAgentsMCPToolsetParams object",12164 "required": false,12165 "description": "Configuration for tools from an MCP server defined in `mcp_servers`."12166 },12167 {12168 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools<BetaManagedAgentsMCPToolsetParams>.type",12169 "type": "\"mcp_toolset\"",12170 "required": true,12171 "description": ""12172 },12173 {12174 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools<BetaManagedAgentsMCPToolsetParams>.mcp_server_name",12175 "type": "string",12176 "required": true,12177 "description": "Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters.",12178 "constraints": {12179 "minLength": "1",12180 "maxLength": "255"12181 }12182 },12183 {12184 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools<BetaManagedAgentsMCPToolsetParams>.configs",12185 "type": "array of BetaManagedAgentsMCPToolConfigParams",12186 "required": false,12187 "description": "Per-tool configuration overrides."12188 },12189 {12190 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools<BetaManagedAgentsMCPToolsetParams>.default_config",12191 "type": "BetaManagedAgentsMCPToolsetDefaultConfigParams or null",12192 "required": false,12193 "description": "Default configuration for all tools from an MCP server."12194 },12195 {12196 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools<BetaManagedAgentsCustomToolParams>",12197 "type": "BetaManagedAgentsCustomToolParams object",12198 "required": false,12199 "description": "A custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an `agent.custom_tool_use` event is emitted and the session goes idle, waiting for the client to provide the result via a `user.custom_tool_result` event."12200 },12201 {12202 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools<BetaManagedAgentsCustomToolParams>.type",12203 "type": "\"custom\"",12204 "required": true,12205 "description": ""12206 },12207 {12208 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools<BetaManagedAgentsCustomToolParams>.description",12209 "type": "string",12210 "required": true,12211 "description": "Description of what the tool does, shown to the agent to help it decide when to use the tool.",12212 "constraints": {12213 "minLength": "1"12214 }12215 },12216 {12217 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools<BetaManagedAgentsCustomToolParams>.input_schema",12218 "type": "BetaManagedAgentsCustomToolInputSchema",12219 "required": true,12220 "description": "JSON Schema for custom tool input parameters."12221 },12222 {12223 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.tools<BetaManagedAgentsCustomToolParams>.name",12224 "type": "string",12225 "required": true,12226 "description": "Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.",12227 "constraints": {12228 "minLength": "1",12229 "maxLength": "128"12230 }12231 },12232 {12233 "name": "agent<BetaManagedAgentsAgentWithOverridesParams>.version",12234 "type": "number",12235 "required": false,12236 "description": "The specific `agent` version to use. Omit to use the latest version.",12237 "constraints": {12238 "format": "int32"12239 }12240 },12241 {12242 "name": "environment_id",12243 "type": "string",12244 "required": true,12245 "description": "ID of the `environment` defining the container configuration for this session.",12246 "constraints": {12247 "minLength": "1",12248 "maxLength": "128"12249 }12250 },12251 {12252 "name": "budget",12253 "type": "BetaManagedAgentsBudgetLimit",12254 "required": false,12255 "description": "A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`."12256 },12257 {12258 "name": "budget.type",12259 "type": "\"limit\"",12260 "required": true,12261 "description": ""12262 },12263 {12264 "name": "budget.max_list_cost",12265 "type": "BetaMonetaryAmount",12266 "required": true,12267 "description": "A monetary amount in a specific currency."12268 },12269 {12270 "name": "budget.max_list_cost.amount",12271 "type": "string",12272 "required": true,12273 "description": "Amount in minor units of the currency, as an integer decimal string with no leading zeros: \"2500\" is $25.00 and \"50\" is fifty cents. A string rather than a number so no float rounding is ever applied."12274 },12275 {12276 "name": "budget.max_list_cost.currency",12277 "type": "BetaCurrency",12278 "required": true,12279 "description": "Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced."12280 },12281 {12282 "name": "initial_events",12283 "type": "array of BetaManagedAgentsUserMessageEventParams or BetaManagedAgentsUserDefineOutcomeEventParams",12284 "required": false,12285 "description": "Initial events to send to the `session` at creation, processed in order. Supports `user.message` and `user.define_outcome` events. Maximum 50 events."12286 },12287 {12288 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>",12289 "type": "BetaManagedAgentsUserMessageEventParams object",12290 "required": false,12291 "description": "Parameters for sending a user message to the session."12292 },12293 {12294 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.type",12295 "type": "\"user.message\"",12296 "required": true,12297 "description": ""12298 },12299 {12300 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content",12301 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock",12302 "required": true,12303 "description": "Array of content blocks for the user message."12304 },12305 {12306 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsTextBlock>",12307 "type": "BetaManagedAgentsTextBlock object",12308 "required": false,12309 "description": "Regular text content."12310 },12311 {12312 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsTextBlock>.type",12313 "type": "\"text\"",12314 "required": true,12315 "description": ""12316 },12317 {12318 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsTextBlock>.text",12319 "type": "string",12320 "required": true,12321 "description": "The text content.",12322 "constraints": {12323 "minLength": "1"12324 }12325 },12326 {12327 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>",12328 "type": "BetaManagedAgentsImageBlock object",12329 "required": false,12330 "description": "Image content specified directly as base64 data or as a reference via a URL."12331 },12332 {12333 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.type",12334 "type": "\"image\"",12335 "required": true,12336 "description": ""12337 },12338 {12339 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source",12340 "type": "BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource",12341 "required": true,12342 "description": "Union type for image source variants."12343 },12344 {12345 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>",12346 "type": "BetaManagedAgentsDocumentBlock object",12347 "required": false,12348 "description": "Document content, either specified directly as base64 data, as text, or as a reference via a URL."12349 },12350 {12351 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.type",12352 "type": "\"document\"",12353 "required": true,12354 "description": ""12355 },12356 {12357 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source",12358 "type": "BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource",12359 "required": true,12360 "description": "Union type for document source variants."12361 },12362 {12363 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.context",12364 "type": "string or null",12365 "required": false,12366 "description": "Additional context about the document for the model."12367 },12368 {12369 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.title",12370 "type": "string or null",12371 "required": false,12372 "description": "The title of the document."12373 },12374 {12375 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsRedactedBlock>",12376 "type": "BetaManagedAgentsRedactedBlock object",12377 "required": false,12378 "description": "Placeholder for content withheld by Anthropic model policy."12379 },12380 {12381 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsRedactedBlock>.type",12382 "type": "\"redacted\"",12383 "required": true,12384 "description": ""12385 },12386 {12387 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>",12388 "type": "BetaManagedAgentsUserDefineOutcomeEventParams object",12389 "required": false,12390 "description": "Parameters for defining an outcome the agent should work toward. The agent begins work on receipt."12391 },12392 {12393 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.type",12394 "type": "\"user.define_outcome\"",12395 "required": true,12396 "description": ""12397 },12398 {12399 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.description",12400 "type": "string",12401 "required": true,12402 "description": "What the agent should produce. This is the task specification."12403 },12404 {12405 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric",12406 "type": "BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams",12407 "required": true,12408 "description": "Rubric for grading the quality of an outcome."12409 },12410 {12411 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsFileRubricParams>",12412 "type": "BetaManagedAgentsFileRubricParams object",12413 "required": false,12414 "description": "Rubric referenced by a file uploaded via the Files API."12415 },12416 {12417 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsFileRubricParams>.type",12418 "type": "\"file\"",12419 "required": true,12420 "description": ""12421 },12422 {12423 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsFileRubricParams>.file_id",12424 "type": "string",12425 "required": true,12426 "description": "ID of the rubric file."12427 },12428 {12429 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsTextRubricParams>",12430 "type": "BetaManagedAgentsTextRubricParams object",12431 "required": false,12432 "description": "Rubric content provided inline as text."12433 },12434 {12435 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsTextRubricParams>.type",12436 "type": "\"text\"",12437 "required": true,12438 "description": ""12439 },12440 {12441 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsTextRubricParams>.content",12442 "type": "string",12443 "required": true,12444 "description": "Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.",12445 "constraints": {12446 "maxLength": "262144"12447 }12448 },12449 {12450 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.max_iterations",12451 "type": "number or null",12452 "required": false,12453 "description": "Eval→revision cycles before giving up. Default 3, max 20.",12454 "constraints": {12455 "format": "int32"12456 }12457 },12458 {12459 "name": "metadata",12460 "type": "map[string]",12461 "required": false,12462 "description": "Arbitrary key-value metadata attached to the session. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars."12463 },12464 {12465 "name": "resources",12466 "type": "array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam",12467 "required": false,12468 "description": "Resources (e.g. repositories, files) to mount into the session's container."12469 },12470 {12471 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>",12472 "type": "BetaManagedAgentsGitHubRepositoryResourceParams object",12473 "required": false,12474 "description": "Mount a GitHub repository into the session's container."12475 },12476 {12477 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.type",12478 "type": "\"github_repository\"",12479 "required": true,12480 "description": ""12481 },12482 {12483 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.url",12484 "type": "string",12485 "required": true,12486 "description": "Github URL of the repository",12487 "constraints": {12488 "minLength": "1",12489 "maxLength": "2048"12490 }12491 },12492 {12493 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.authorization_token",12494 "type": "string",12495 "required": false,12496 "description": "GitHub authorization token used to clone the repository. Required for private repositories; optional for public ones.",12497 "constraints": {12498 "minLength": "1",12499 "maxLength": "4096"12500 }12501 },12502 {12503 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.checkout",12504 "type": "BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null",12505 "required": false,12506 "description": "Branch or commit to check out. Defaults to the repository's default branch."12507 },12508 {12509 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.checkout<BetaManagedAgentsBranchCheckout>",12510 "type": "BetaManagedAgentsBranchCheckout object",12511 "required": false,12512 "description": ""12513 },12514 {12515 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.checkout<BetaManagedAgentsBranchCheckout>.type",12516 "type": "\"branch\"",12517 "required": true,12518 "description": ""12519 },12520 {12521 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.checkout<BetaManagedAgentsBranchCheckout>.name",12522 "type": "string",12523 "required": true,12524 "description": "Branch name to check out.",12525 "constraints": {12526 "minLength": "1",12527 "maxLength": "255"12528 }12529 },12530 {12531 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.checkout<BetaManagedAgentsCommitCheckout>",12532 "type": "BetaManagedAgentsCommitCheckout object",12533 "required": false,12534 "description": ""12535 },12536 {12537 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.checkout<BetaManagedAgentsCommitCheckout>.type",12538 "type": "\"commit\"",12539 "required": true,12540 "description": ""12541 },12542 {12543 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.checkout<BetaManagedAgentsCommitCheckout>.sha",12544 "type": "string",12545 "required": true,12546 "description": "Full commit SHA to check out.",12547 "constraints": {12548 "minLength": "7",12549 "maxLength": "64"12550 }12551 },12552 {12553 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.mount_path",12554 "type": "string or null",12555 "required": false,12556 "description": "Mount path in the container. Defaults to `/workspace/<repo-name>`.",12557 "constraints": {12558 "minLength": "1",12559 "maxLength": "4096"12560 }12561 },12562 {12563 "name": "resources<BetaManagedAgentsFileResourceParams>",12564 "type": "BetaManagedAgentsFileResourceParams object",12565 "required": false,12566 "description": "Mount a file uploaded via the Files API into the session."12567 },12568 {12569 "name": "resources<BetaManagedAgentsFileResourceParams>.type",12570 "type": "\"file\"",12571 "required": true,12572 "description": ""12573 },12574 {12575 "name": "resources<BetaManagedAgentsFileResourceParams>.file_id",12576 "type": "string",12577 "required": true,12578 "description": "ID of a previously uploaded file.",12579 "constraints": {12580 "minLength": "1",12581 "maxLength": "128"12582 }12583 },12584 {12585 "name": "resources<BetaManagedAgentsFileResourceParams>.mount_path",12586 "type": "string or null",12587 "required": false,12588 "description": "Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.",12589 "constraints": {12590 "minLength": "1",12591 "maxLength": "4096"12592 }12593 },12594 {12595 "name": "resources<BetaManagedAgentsMemoryStoreResourceParam>",12596 "type": "BetaManagedAgentsMemoryStoreResourceParam object",12597 "required": false,12598 "description": "Parameters for attaching a memory store to an agent session."12599 },12600 {12601 "name": "resources<BetaManagedAgentsMemoryStoreResourceParam>.type",12602 "type": "\"memory_store\"",12603 "required": true,12604 "description": ""12605 },12606 {12607 "name": "resources<BetaManagedAgentsMemoryStoreResourceParam>.memory_store_id",12608 "type": "string",12609 "required": true,12610 "description": "The memory store ID (memstore_...). Must belong to the caller's organization and workspace."12611 },12612 {12613 "name": "resources<BetaManagedAgentsMemoryStoreResourceParam>.access",12614 "type": "\"read_write\" or \"read_only\" or null",12615 "required": false,12616 "description": "Access mode for an attached memory store.",12617 "enum": [12618 "read_write",12619 "read_only"12620 ]12621 },12622 {12623 "name": "resources<BetaManagedAgentsMemoryStoreResourceParam>.instructions",12624 "type": "string or null",12625 "required": false,12626 "description": "Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.",12627 "constraints": {12628 "maxLength": "4096"12629 }12630 },12631 {12632 "name": "title",12633 "type": "string or null",12634 "required": false,12635 "description": "Human-readable session title.",12636 "constraints": {12637 "maxLength": "500"12638 }12639 },12640 {12641 "name": "vault_ids",12642 "type": "array of string",12643 "required": false,12644 "description": "Vault IDs for stored credentials the agent can use during the session."12645 }12646 ],12647 "status": [12648 "DOCUMENTED",12649 "BETA"12650 ],12651 "sources": [12652 {12653 "url": "https://platform.claude.com/docs/en/api/beta/sessions/create",12654 "retrieved_at": "2026-09-18"12655 },12656 {12657 "url": "https://platform.claude.com/docs/en/managed-agents/sessions",12658 "retrieved_at": "2026-09-18"12659 },12660 {12661 "url": "https://platform.claude.com/docs/en/managed-agents/files",12662 "retrieved_at": "2026-09-18"12663 },12664 {12665 "url": "https://platform.claude.com/docs/en/managed-agents/github",12666 "retrieved_at": "2026-09-18"12667 },12668 {12669 "url": "https://platform.claude.com/docs/en/managed-agents/memory",12670 "retrieved_at": "2026-09-18"12671 },12672 {12673 "url": "https://platform.claude.com/docs/en/managed-agents/budgets",12674 "retrieved_at": "2026-09-18"12675 }12676 ],12677 "beta_header": "managed-agents-2026-04-01"12678 },12679 {12680 "provider": "anthropic",12681 "api_family": "managed-agents",12682 "name": "SessionUpdateParams (request body)",12683 "official_type_name": "BetaManagedAgentsSessionUpdateParams",12684 "description": "Update Session",12685 "fields": [12686 {12687 "name": "agent",12688 "type": "BetaManagedAgentsSessionAgentUpdate",12689 "required": false,12690 "description": "Mid-session agent configuration update. Only `tools` and `mcp_servers` are updatable. Full replacement: the provided array becomes the new value. To preserve existing entries, GET the session, modify the array, and POST it back."12691 },12692 {12693 "name": "agent.mcp_servers",12694 "type": "array of BetaManagedAgentsURLMCPServerParams",12695 "required": false,12696 "description": "Replacement MCP server list. Full replacement: the provided array becomes the new value. Send an empty array to clear; omit to preserve."12697 },12698 {12699 "name": "agent.mcp_servers.type",12700 "type": "\"url\"",12701 "required": true,12702 "description": ""12703 },12704 {12705 "name": "agent.mcp_servers.name",12706 "type": "string",12707 "required": true,12708 "description": "Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.",12709 "constraints": {12710 "minLength": "1",12711 "maxLength": "255"12712 }12713 },12714 {12715 "name": "agent.mcp_servers.url",12716 "type": "string",12717 "required": true,12718 "description": "Endpoint URL for the MCP server.",12719 "constraints": {12720 "maxLength": "2048"12721 }12722 },12723 {12724 "name": "agent.tools",12725 "type": "array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams",12726 "required": false,12727 "description": "Replacement tool list. Full replacement: the provided array becomes the new value. Send an empty array to clear; omit to preserve."12728 },12729 {12730 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>",12731 "type": "BetaManagedAgentsAgentToolset20260401Params object",12732 "required": false,12733 "description": "Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent."12734 },12735 {12736 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.type",12737 "type": "\"agent_toolset_20260401\"",12738 "required": true,12739 "description": ""12740 },12741 {12742 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs",12743 "type": "array of BetaManagedAgentsAgentToolConfigParams",12744 "required": false,12745 "description": "Per-tool configuration overrides."12746 },12747 {12748 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsBashToolConfigParams>",12749 "type": "BetaManagedAgentsBashToolConfigParams object",12750 "required": false,12751 "description": "Configuration override for the bash tool."12752 },12753 {12754 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsBashToolConfigParams>.type",12755 "type": "\"bash\"",12756 "required": false,12757 "description": ""12758 },12759 {12760 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsBashToolConfigParams>.name",12761 "type": "\"bash\"",12762 "required": true,12763 "description": "Must be \"bash\"."12764 },12765 {12766 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsBashToolConfigParams>.enabled",12767 "type": "boolean or null",12768 "required": false,12769 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."12770 },12771 {12772 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsBashToolConfigParams>.permission_policy",12773 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",12774 "required": false,12775 "description": "Permission policy for tool execution."12776 },12777 {12778 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsEditToolConfigParams>",12779 "type": "BetaManagedAgentsEditToolConfigParams object",12780 "required": false,12781 "description": "Configuration override for the edit tool."12782 },12783 {12784 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsEditToolConfigParams>.type",12785 "type": "\"edit\"",12786 "required": false,12787 "description": ""12788 },12789 {12790 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsEditToolConfigParams>.name",12791 "type": "\"edit\"",12792 "required": true,12793 "description": "Must be \"edit\"."12794 },12795 {12796 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsEditToolConfigParams>.enabled",12797 "type": "boolean or null",12798 "required": false,12799 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."12800 },12801 {12802 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsEditToolConfigParams>.permission_policy",12803 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",12804 "required": false,12805 "description": "Permission policy for tool execution."12806 },12807 {12808 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsReadToolConfigParams>",12809 "type": "BetaManagedAgentsReadToolConfigParams object",12810 "required": false,12811 "description": "Configuration override for the read tool."12812 },12813 {12814 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsReadToolConfigParams>.type",12815 "type": "\"read\"",12816 "required": false,12817 "description": ""12818 },12819 {12820 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsReadToolConfigParams>.name",12821 "type": "\"read\"",12822 "required": true,12823 "description": "Must be \"read\"."12824 },12825 {12826 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsReadToolConfigParams>.enabled",12827 "type": "boolean or null",12828 "required": false,12829 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."12830 },12831 {12832 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsReadToolConfigParams>.permission_policy",12833 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",12834 "required": false,12835 "description": "Permission policy for tool execution."12836 },12837 {12838 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWriteToolConfigParams>",12839 "type": "BetaManagedAgentsWriteToolConfigParams object",12840 "required": false,12841 "description": "Configuration override for the write tool."12842 },12843 {12844 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWriteToolConfigParams>.type",12845 "type": "\"write\"",12846 "required": false,12847 "description": ""12848 },12849 {12850 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWriteToolConfigParams>.name",12851 "type": "\"write\"",12852 "required": true,12853 "description": "Must be \"write\"."12854 },12855 {12856 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWriteToolConfigParams>.enabled",12857 "type": "boolean or null",12858 "required": false,12859 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."12860 },12861 {12862 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWriteToolConfigParams>.permission_policy",12863 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",12864 "required": false,12865 "description": "Permission policy for tool execution."12866 },12867 {12868 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGlobToolConfigParams>",12869 "type": "BetaManagedAgentsGlobToolConfigParams object",12870 "required": false,12871 "description": "Configuration override for the glob tool."12872 },12873 {12874 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGlobToolConfigParams>.type",12875 "type": "\"glob\"",12876 "required": false,12877 "description": ""12878 },12879 {12880 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGlobToolConfigParams>.name",12881 "type": "\"glob\"",12882 "required": true,12883 "description": "Must be \"glob\"."12884 },12885 {12886 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGlobToolConfigParams>.enabled",12887 "type": "boolean or null",12888 "required": false,12889 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."12890 },12891 {12892 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGlobToolConfigParams>.permission_policy",12893 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",12894 "required": false,12895 "description": "Permission policy for tool execution."12896 },12897 {12898 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGrepToolConfigParams>",12899 "type": "BetaManagedAgentsGrepToolConfigParams object",12900 "required": false,12901 "description": "Configuration override for the grep tool."12902 },12903 {12904 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGrepToolConfigParams>.type",12905 "type": "\"grep\"",12906 "required": false,12907 "description": ""12908 },12909 {12910 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGrepToolConfigParams>.name",12911 "type": "\"grep\"",12912 "required": true,12913 "description": "Must be \"grep\"."12914 },12915 {12916 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGrepToolConfigParams>.enabled",12917 "type": "boolean or null",12918 "required": false,12919 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."12920 },12921 {12922 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsGrepToolConfigParams>.permission_policy",12923 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",12924 "required": false,12925 "description": "Permission policy for tool execution."12926 },12927 {12928 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>",12929 "type": "BetaManagedAgentsWebFetchToolConfigParams object",12930 "required": false,12931 "description": "Configuration override for the web_fetch tool."12932 },12933 {12934 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.type",12935 "type": "\"web_fetch\"",12936 "required": false,12937 "description": ""12938 },12939 {12940 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.name",12941 "type": "\"web_fetch\"",12942 "required": true,12943 "description": "Must be \"web_fetch\"."12944 },12945 {12946 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.allowed_domains",12947 "type": "array of string",12948 "required": false,12949 "description": "Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"docs.example.com\" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains."12950 },12951 {12952 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.blocked_domains",12953 "type": "array of string",12954 "required": false,12955 "description": "Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"ads.example.com\" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains."12956 },12957 {12958 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.enabled",12959 "type": "boolean or null",12960 "required": false,12961 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."12962 },12963 {12964 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.max_content_tokens",12965 "type": "number or null",12966 "required": false,12967 "description": "Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs.",12968 "constraints": {12969 "format": "int32"12970 }12971 },12972 {12973 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebFetchToolConfigParams>.permission_policy",12974 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",12975 "required": false,12976 "description": "Permission policy for tool execution."12977 },12978 {12979 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>",12980 "type": "BetaManagedAgentsWebSearchToolConfigParams object",12981 "required": false,12982 "description": "Configuration override for the web_search tool."12983 },12984 {12985 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.type",12986 "type": "\"web_search\"",12987 "required": false,12988 "description": ""12989 },12990 {12991 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.name",12992 "type": "\"web_search\"",12993 "required": true,12994 "description": "Must be \"web_search\"."12995 },12996 {12997 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.allowed_domains",12998 "type": "array of string",12999 "required": false,13000 "description": "Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"docs.example.com\" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains."13001 },13002 {13003 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.blocked_domains",13004 "type": "array of string",13005 "required": false,13006 "description": "Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"ads.example.com\" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains."13007 },13008 {13009 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.enabled",13010 "type": "boolean or null",13011 "required": false,13012 "description": "Whether this tool is enabled and available to Claude. Overrides the default_config setting."13013 },13014 {13015 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.permission_policy",13016 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",13017 "required": false,13018 "description": "Permission policy for tool execution."13019 },13020 {13021 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.configs<BetaManagedAgentsWebSearchToolConfigParams>.user_location",13022 "type": "BetaManagedAgentsUserLocation or null",13023 "required": false,13024 "description": "Approximate user location for search result localization."13025 },13026 {13027 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.default_config",13028 "type": "BetaManagedAgentsAgentToolsetDefaultConfigParams or null",13029 "required": false,13030 "description": "Default configuration for all tools in a toolset."13031 },13032 {13033 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.default_config.enabled",13034 "type": "boolean or null",13035 "required": false,13036 "description": "Whether tools are enabled and available to Claude by default. Defaults to true if not specified."13037 },13038 {13039 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.default_config.permission_policy",13040 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",13041 "required": false,13042 "description": "Permission policy for tool execution."13043 },13044 {13045 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.default_config.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",13046 "type": "BetaManagedAgentsAlwaysAllowPolicy object",13047 "required": false,13048 "description": "Tool calls are automatically approved without user confirmation."13049 },13050 {13051 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.default_config.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",13052 "type": "BetaManagedAgentsAlwaysAskPolicy object",13053 "required": false,13054 "description": "Tool calls require user confirmation before execution."13055 },13056 {13057 "name": "agent.tools<BetaManagedAgentsAgentToolset20260401Params>.default_config.permission_policy<BetaManagedAgentsAutoPolicy>",13058 "type": "BetaManagedAgentsAutoPolicy object",13059 "required": false,13060 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."13061 },13062 {13063 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>",13064 "type": "BetaManagedAgentsMCPToolsetParams object",13065 "required": false,13066 "description": "Configuration for tools from an MCP server defined in `mcp_servers`."13067 },13068 {13069 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.type",13070 "type": "\"mcp_toolset\"",13071 "required": true,13072 "description": ""13073 },13074 {13075 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.mcp_server_name",13076 "type": "string",13077 "required": true,13078 "description": "Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters.",13079 "constraints": {13080 "minLength": "1",13081 "maxLength": "255"13082 }13083 },13084 {13085 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.configs",13086 "type": "array of BetaManagedAgentsMCPToolConfigParams",13087 "required": false,13088 "description": "Per-tool configuration overrides."13089 },13090 {13091 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.configs.name",13092 "type": "string",13093 "required": true,13094 "description": "Name of the MCP tool to configure. 1-128 characters.",13095 "constraints": {13096 "minLength": "1",13097 "maxLength": "128"13098 }13099 },13100 {13101 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.configs.enabled",13102 "type": "boolean or null",13103 "required": false,13104 "description": "Whether this tool is enabled. Overrides the `default_config` setting."13105 },13106 {13107 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.configs.permission_policy",13108 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",13109 "required": false,13110 "description": "Permission policy for tool execution."13111 },13112 {13113 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.configs.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",13114 "type": "BetaManagedAgentsAlwaysAllowPolicy object",13115 "required": false,13116 "description": "Tool calls are automatically approved without user confirmation."13117 },13118 {13119 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.configs.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",13120 "type": "BetaManagedAgentsAlwaysAskPolicy object",13121 "required": false,13122 "description": "Tool calls require user confirmation before execution."13123 },13124 {13125 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.configs.permission_policy<BetaManagedAgentsAutoPolicy>",13126 "type": "BetaManagedAgentsAutoPolicy object",13127 "required": false,13128 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."13129 },13130 {13131 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.default_config",13132 "type": "BetaManagedAgentsMCPToolsetDefaultConfigParams or null",13133 "required": false,13134 "description": "Default configuration for all tools from an MCP server."13135 },13136 {13137 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.default_config.enabled",13138 "type": "boolean or null",13139 "required": false,13140 "description": "Whether tools are enabled by default. Defaults to true if not specified."13141 },13142 {13143 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.default_config.permission_policy",13144 "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",13145 "required": false,13146 "description": "Permission policy for tool execution."13147 },13148 {13149 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.default_config.permission_policy<BetaManagedAgentsAlwaysAllowPolicy>",13150 "type": "BetaManagedAgentsAlwaysAllowPolicy object",13151 "required": false,13152 "description": "Tool calls are automatically approved without user confirmation."13153 },13154 {13155 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.default_config.permission_policy<BetaManagedAgentsAlwaysAskPolicy>",13156 "type": "BetaManagedAgentsAlwaysAskPolicy object",13157 "required": false,13158 "description": "Tool calls require user confirmation before execution."13159 },13160 {13161 "name": "agent.tools<BetaManagedAgentsMCPToolsetParams>.default_config.permission_policy<BetaManagedAgentsAutoPolicy>",13162 "type": "BetaManagedAgentsAutoPolicy object",13163 "required": false,13164 "description": "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask."13165 },13166 {13167 "name": "agent.tools<BetaManagedAgentsCustomToolParams>",13168 "type": "BetaManagedAgentsCustomToolParams object",13169 "required": false,13170 "description": "A custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an `agent.custom_tool_use` event is emitted and the session goes idle, waiting for the client to provide the result via a `user.custom_tool_result` event."13171 },13172 {13173 "name": "agent.tools<BetaManagedAgentsCustomToolParams>.type",13174 "type": "\"custom\"",13175 "required": true,13176 "description": ""13177 },13178 {13179 "name": "agent.tools<BetaManagedAgentsCustomToolParams>.description",13180 "type": "string",13181 "required": true,13182 "description": "Description of what the tool does, shown to the agent to help it decide when to use the tool.",13183 "constraints": {13184 "minLength": "1"13185 }13186 },13187 {13188 "name": "agent.tools<BetaManagedAgentsCustomToolParams>.input_schema",13189 "type": "BetaManagedAgentsCustomToolInputSchema",13190 "required": true,13191 "description": "JSON Schema for custom tool input parameters."13192 },13193 {13194 "name": "agent.tools<BetaManagedAgentsCustomToolParams>.input_schema.type",13195 "type": "\"object\"",13196 "required": true,13197 "description": ""13198 },13199 {13200 "name": "agent.tools<BetaManagedAgentsCustomToolParams>.input_schema.properties",13201 "type": "map[unknown] or null",13202 "required": false,13203 "description": ""13204 },13205 {13206 "name": "agent.tools<BetaManagedAgentsCustomToolParams>.input_schema.required",13207 "type": "array of string or null",13208 "required": false,13209 "description": ""13210 },13211 {13212 "name": "agent.tools<BetaManagedAgentsCustomToolParams>.name",13213 "type": "string",13214 "required": true,13215 "description": "Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.",13216 "constraints": {13217 "minLength": "1",13218 "maxLength": "128"13219 }13220 },13221 {13222 "name": "budget",13223 "type": "BetaManagedAgentsBudgetLimit or null",13224 "required": false,13225 "description": "A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`."13226 },13227 {13228 "name": "budget.type",13229 "type": "\"limit\"",13230 "required": true,13231 "description": ""13232 },13233 {13234 "name": "budget.max_list_cost",13235 "type": "BetaMonetaryAmount",13236 "required": true,13237 "description": "A monetary amount in a specific currency."13238 },13239 {13240 "name": "budget.max_list_cost.amount",13241 "type": "string",13242 "required": true,13243 "description": "Amount in minor units of the currency, as an integer decimal string with no leading zeros: \"2500\" is $25.00 and \"50\" is fifty cents. A string rather than a number so no float rounding is ever applied."13244 },13245 {13246 "name": "budget.max_list_cost.currency",13247 "type": "BetaCurrency",13248 "required": true,13249 "description": "Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced."13250 },13251 {13252 "name": "metadata",13253 "type": "map[string] or null",13254 "required": false,13255 "description": "Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve."13256 },13257 {13258 "name": "title",13259 "type": "string or null",13260 "required": false,13261 "description": "Human-readable session title.",13262 "constraints": {13263 "minLength": "1",13264 "maxLength": "500"13265 }13266 },13267 {13268 "name": "vault_ids",13269 "type": "array of string",13270 "required": false,13271 "description": "Vault IDs (`vlt_*`) to attach to the session. Not yet supported; requests setting this field are rejected. Reserved for future use."13272 }13273 ],13274 "status": [13275 "DOCUMENTED",13276 "BETA"13277 ],13278 "sources": [13279 {13280 "url": "https://platform.claude.com/docs/en/api/beta/sessions/update",13281 "retrieved_at": "2026-09-18"13282 },13283 {13284 "url": "https://platform.claude.com/docs/en/managed-agents/session-operations",13285 "retrieved_at": "2026-09-18"13286 }13287 ],13288 "beta_header": "managed-agents-2026-04-01"13289 },13290 {13291 "provider": "anthropic",13292 "api_family": "managed-agents",13293 "name": "SessionResource (union: file | github_repository | memory_store)",13294 "official_type_name": "BetaManagedAgentsSessionResource",13295 "description": "Resources for the session, ordered by `created_at`.",13296 "fields": [13297 {13298 "name": "<BetaManagedAgentsGitHubRepositoryResource>",13299 "type": "BetaManagedAgentsGitHubRepositoryResource object",13300 "required": false,13301 "description": ""13302 },13303 {13304 "name": "<BetaManagedAgentsGitHubRepositoryResource>.type",13305 "type": "\"github_repository\"",13306 "required": true,13307 "description": ""13308 },13309 {13310 "name": "<BetaManagedAgentsGitHubRepositoryResource>.id",13311 "type": "string",13312 "required": true,13313 "description": ""13314 },13315 {13316 "name": "<BetaManagedAgentsGitHubRepositoryResource>.created_at",13317 "type": "string",13318 "required": true,13319 "description": "A timestamp in RFC 3339 format",13320 "constraints": {13321 "format": "date-time"13322 }13323 },13324 {13325 "name": "<BetaManagedAgentsGitHubRepositoryResource>.mount_path",13326 "type": "string",13327 "required": true,13328 "description": ""13329 },13330 {13331 "name": "<BetaManagedAgentsGitHubRepositoryResource>.updated_at",13332 "type": "string",13333 "required": true,13334 "description": "A timestamp in RFC 3339 format",13335 "constraints": {13336 "format": "date-time"13337 }13338 },13339 {13340 "name": "<BetaManagedAgentsGitHubRepositoryResource>.url",13341 "type": "string",13342 "required": true,13343 "description": ""13344 },13345 {13346 "name": "<BetaManagedAgentsGitHubRepositoryResource>.checkout",13347 "type": "BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null",13348 "required": false,13349 "description": ""13350 },13351 {13352 "name": "<BetaManagedAgentsGitHubRepositoryResource>.checkout<BetaManagedAgentsBranchCheckout>",13353 "type": "BetaManagedAgentsBranchCheckout object",13354 "required": false,13355 "description": ""13356 },13357 {13358 "name": "<BetaManagedAgentsGitHubRepositoryResource>.checkout<BetaManagedAgentsBranchCheckout>.type",13359 "type": "\"branch\"",13360 "required": true,13361 "description": ""13362 },13363 {13364 "name": "<BetaManagedAgentsGitHubRepositoryResource>.checkout<BetaManagedAgentsBranchCheckout>.name",13365 "type": "string",13366 "required": true,13367 "description": "Branch name to check out.",13368 "constraints": {13369 "minLength": "1",13370 "maxLength": "255"13371 }13372 },13373 {13374 "name": "<BetaManagedAgentsGitHubRepositoryResource>.checkout<BetaManagedAgentsCommitCheckout>",13375 "type": "BetaManagedAgentsCommitCheckout object",13376 "required": false,13377 "description": ""13378 },13379 {13380 "name": "<BetaManagedAgentsGitHubRepositoryResource>.checkout<BetaManagedAgentsCommitCheckout>.type",13381 "type": "\"commit\"",13382 "required": true,13383 "description": ""13384 },13385 {13386 "name": "<BetaManagedAgentsGitHubRepositoryResource>.checkout<BetaManagedAgentsCommitCheckout>.sha",13387 "type": "string",13388 "required": true,13389 "description": "Full commit SHA to check out.",13390 "constraints": {13391 "minLength": "7",13392 "maxLength": "64"13393 }13394 },13395 {13396 "name": "<BetaManagedAgentsFileResource>",13397 "type": "BetaManagedAgentsFileResource object",13398 "required": false,13399 "description": ""13400 },13401 {13402 "name": "<BetaManagedAgentsFileResource>.type",13403 "type": "\"file\"",13404 "required": true,13405 "description": ""13406 },13407 {13408 "name": "<BetaManagedAgentsFileResource>.id",13409 "type": "string",13410 "required": true,13411 "description": ""13412 },13413 {13414 "name": "<BetaManagedAgentsFileResource>.created_at",13415 "type": "string",13416 "required": true,13417 "description": "A timestamp in RFC 3339 format",13418 "constraints": {13419 "format": "date-time"13420 }13421 },13422 {13423 "name": "<BetaManagedAgentsFileResource>.file_id",13424 "type": "string",13425 "required": true,13426 "description": ""13427 },13428 {13429 "name": "<BetaManagedAgentsFileResource>.mount_path",13430 "type": "string",13431 "required": true,13432 "description": ""13433 },13434 {13435 "name": "<BetaManagedAgentsFileResource>.updated_at",13436 "type": "string",13437 "required": true,13438 "description": "A timestamp in RFC 3339 format",13439 "constraints": {13440 "format": "date-time"13441 }13442 },13443 {13444 "name": "<BetaManagedAgentsMemoryStoreResource>",13445 "type": "BetaManagedAgentsMemoryStoreResource object",13446 "required": false,13447 "description": "A memory store attached to an agent session."13448 },13449 {13450 "name": "<BetaManagedAgentsMemoryStoreResource>.type",13451 "type": "\"memory_store\"",13452 "required": true,13453 "description": ""13454 },13455 {13456 "name": "<BetaManagedAgentsMemoryStoreResource>.memory_store_id",13457 "type": "string",13458 "required": true,13459 "description": "The memory store ID (memstore_...). Must belong to the caller's organization and workspace."13460 },13461 {13462 "name": "<BetaManagedAgentsMemoryStoreResource>.access",13463 "type": "\"read_write\" or \"read_only\" or null",13464 "required": false,13465 "description": "Access mode for an attached memory store.",13466 "enum": [13467 "read_write",13468 "read_only"13469 ]13470 },13471 {13472 "name": "<BetaManagedAgentsMemoryStoreResource>.description",13473 "type": "string",13474 "required": false,13475 "description": "Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description."13476 },13477 {13478 "name": "<BetaManagedAgentsMemoryStoreResource>.instructions",13479 "type": "string or null",13480 "required": false,13481 "description": "Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.",13482 "constraints": {13483 "maxLength": "4096"13484 }13485 },13486 {13487 "name": "<BetaManagedAgentsMemoryStoreResource>.mount_path",13488 "type": "string or null",13489 "required": false,13490 "description": "Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only."13491 },13492 {13493 "name": "<BetaManagedAgentsMemoryStoreResource>.name",13494 "type": "string or null",13495 "required": false,13496 "description": "Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource."13497 }13498 ],13499 "status": [13500 "DOCUMENTED",13501 "BETA"13502 ],13503 "sources": [13504 {13505 "url": "https://platform.claude.com/docs/en/api/beta/sessions/resources/list",13506 "retrieved_at": "2026-09-18"13507 },13508 {13509 "url": "https://platform.claude.com/docs/en/managed-agents/files",13510 "retrieved_at": "2026-09-18"13511 },13512 {13513 "url": "https://platform.claude.com/docs/en/managed-agents/github",13514 "retrieved_at": "2026-09-18"13515 },13516 {13517 "url": "https://platform.claude.com/docs/en/managed-agents/memory",13518 "retrieved_at": "2026-09-18"13519 }13520 ],13521 "beta_header": "managed-agents-2026-04-01"13522 },13523 {13524 "provider": "anthropic",13525 "api_family": "managed-agents",13526 "name": "SessionThread",13527 "official_type_name": "BetaManagedAgentsSessionThread",13528 "description": "An execution thread within a `session`. Each session has one primary thread plus zero or more child threads spawned by the coordinator.",13529 "fields": [13530 {13531 "name": "type",13532 "type": "\"session_thread\"",13533 "required": true,13534 "description": ""13535 },13536 {13537 "name": "id",13538 "type": "string",13539 "required": true,13540 "description": "Unique identifier for this thread."13541 },13542 {13543 "name": "agent",13544 "type": "BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor",13545 "required": true,13546 "description": "The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot."13547 },13548 {13549 "name": "agent<BetaManagedAgentsSessionThreadAgent>",13550 "type": "BetaManagedAgentsSessionThreadAgent object",13551 "required": false,13552 "description": "Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`."13553 },13554 {13555 "name": "agent<BetaManagedAgentsSessionThreadAgent>.type",13556 "type": "\"agent\"",13557 "required": true,13558 "description": ""13559 },13560 {13561 "name": "agent<BetaManagedAgentsSessionThreadAgent>.id",13562 "type": "string",13563 "required": true,13564 "description": ""13565 },13566 {13567 "name": "agent<BetaManagedAgentsSessionThreadAgent>.description",13568 "type": "string or null",13569 "required": true,13570 "description": ""13571 },13572 {13573 "name": "agent<BetaManagedAgentsSessionThreadAgent>.mcp_servers",13574 "type": "array of BetaManagedAgentsMCPServerURLDefinition",13575 "required": true,13576 "description": ""13577 },13578 {13579 "name": "agent<BetaManagedAgentsSessionThreadAgent>.mcp_servers.type",13580 "type": "\"url\"",13581 "required": true,13582 "description": ""13583 },13584 {13585 "name": "agent<BetaManagedAgentsSessionThreadAgent>.mcp_servers.name",13586 "type": "string",13587 "required": true,13588 "description": ""13589 },13590 {13591 "name": "agent<BetaManagedAgentsSessionThreadAgent>.mcp_servers.url",13592 "type": "string",13593 "required": true,13594 "description": ""13595 },13596 {13597 "name": "agent<BetaManagedAgentsSessionThreadAgent>.model",13598 "type": "BetaManagedAgentsModelConfig",13599 "required": true,13600 "description": "Model identifier and configuration."13601 },13602 {13603 "name": "agent<BetaManagedAgentsSessionThreadAgent>.model.id",13604 "type": "BetaManagedAgentsModel",13605 "required": true,13606 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."13607 },13608 {13609 "name": "agent<BetaManagedAgentsSessionThreadAgent>.model.id<\"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more>",13610 "type": "\"claude-fable-5-1\" or \"claude-sonnet-5\" or \"claude-fable-5\" or 11 more",13611 "required": false,13612 "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options."13613 },13614 {13615 "name": "agent<BetaManagedAgentsSessionThreadAgent>.model.id<string>",13616 "type": "string",13617 "required": false,13618 "description": ""13619 },13620 {13621 "name": "agent<BetaManagedAgentsSessionThreadAgent>.model.effort",13622 "type": "BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more",13623 "required": false,13624 "description": "How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes."13625 },13626 {13627 "name": "agent<BetaManagedAgentsSessionThreadAgent>.model.effort<BetaManagedAgentsEffortLow>",13628 "type": "BetaManagedAgentsEffortLow object",13629 "required": false,13630 "description": "Low effort. Favors latency over reasoning depth."13631 },13632 {13633 "name": "agent<BetaManagedAgentsSessionThreadAgent>.model.effort<BetaManagedAgentsEffortMedium>",13634 "type": "BetaManagedAgentsEffortMedium object",13635 "required": false,13636 "description": "Medium effort. Balances latency and reasoning depth."13637 },13638 {13639 "name": "agent<BetaManagedAgentsSessionThreadAgent>.model.effort<BetaManagedAgentsEffortHigh>",13640 "type": "BetaManagedAgentsEffortHigh object",13641 "required": false,13642 "description": "High effort. Favors reasoning depth."13643 },13644 {13645 "name": "agent<BetaManagedAgentsSessionThreadAgent>.model.effort<BetaManagedAgentsEffortXhigh>",13646 "type": "BetaManagedAgentsEffortXhigh object",13647 "required": false,13648 "description": "Extra-high effort. Not all models accept this level."13649 },13650 {13651 "name": "agent<BetaManagedAgentsSessionThreadAgent>.model.effort<BetaManagedAgentsEffortMax>",13652 "type": "BetaManagedAgentsEffortMax object",13653 "required": false,13654 "description": "Maximum effort. Favors reasoning depth over latency."13655 },13656 {13657 "name": "agent<BetaManagedAgentsSessionThreadAgent>.model.inference_geo",13658 "type": "string",13659 "required": false,13660 "description": "Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo."13661 },13662 {13663 "name": "agent<BetaManagedAgentsSessionThreadAgent>.model.speed",13664 "type": "\"standard\" or \"fast\"",13665 "required": false,13666 "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",13667 "enum": [13668 "standard",13669 "fast"13670 ]13671 },13672 {13673 "name": "agent<BetaManagedAgentsSessionThreadAgent>.name",13674 "type": "string",13675 "required": true,13676 "description": ""13677 },13678 {13679 "name": "agent<BetaManagedAgentsSessionThreadAgent>.skills",13680 "type": "array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill",13681 "required": true,13682 "description": ""13683 },13684 {13685 "name": "agent<BetaManagedAgentsSessionThreadAgent>.skills<BetaManagedAgentsAnthropicSkill>",13686 "type": "BetaManagedAgentsAnthropicSkill object",13687 "required": false,13688 "description": "A resolved Anthropic-managed skill."13689 },13690 {13691 "name": "agent<BetaManagedAgentsSessionThreadAgent>.skills<BetaManagedAgentsAnthropicSkill>.type",13692 "type": "\"anthropic\"",13693 "required": true,13694 "description": ""13695 },13696 {13697 "name": "agent<BetaManagedAgentsSessionThreadAgent>.skills<BetaManagedAgentsAnthropicSkill>.skill_id",13698 "type": "string",13699 "required": true,13700 "description": ""13701 },13702 {13703 "name": "agent<BetaManagedAgentsSessionThreadAgent>.skills<BetaManagedAgentsAnthropicSkill>.version",13704 "type": "string",13705 "required": true,13706 "description": ""13707 },13708 {13709 "name": "agent<BetaManagedAgentsSessionThreadAgent>.skills<BetaManagedAgentsCustomSkill>",13710 "type": "BetaManagedAgentsCustomSkill object",13711 "required": false,13712 "description": "A resolved user-created custom skill."13713 },13714 {13715 "name": "agent<BetaManagedAgentsSessionThreadAgent>.skills<BetaManagedAgentsCustomSkill>.type",13716 "type": "\"custom\"",13717 "required": true,13718 "description": ""13719 },13720 {13721 "name": "agent<BetaManagedAgentsSessionThreadAgent>.skills<BetaManagedAgentsCustomSkill>.skill_id",13722 "type": "string",13723 "required": true,13724 "description": ""13725 },13726 {13727 "name": "agent<BetaManagedAgentsSessionThreadAgent>.skills<BetaManagedAgentsCustomSkill>.version",13728 "type": "string",13729 "required": true,13730 "description": ""13731 },13732 {13733 "name": "agent<BetaManagedAgentsSessionThreadAgent>.system",13734 "type": "string or null",13735 "required": true,13736 "description": ""13737 },13738 {13739 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools",13740 "type": "array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool",13741 "required": true,13742 "description": ""13743 },13744 {13745 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools<BetaManagedAgentsAgentToolset20260401>",13746 "type": "BetaManagedAgentsAgentToolset20260401 object",13747 "required": false,13748 "description": ""13749 },13750 {13751 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools<BetaManagedAgentsAgentToolset20260401>.type",13752 "type": "\"agent_toolset_20260401\"",13753 "required": true,13754 "description": ""13755 },13756 {13757 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools<BetaManagedAgentsAgentToolset20260401>.configs",13758 "type": "array of BetaManagedAgentsAgentToolConfig",13759 "required": true,13760 "description": ""13761 },13762 {13763 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools<BetaManagedAgentsAgentToolset20260401>.default_config",13764 "type": "BetaManagedAgentsAgentToolsetDefaultConfig",13765 "required": true,13766 "description": "Resolved default configuration for agent tools."13767 },13768 {13769 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools<BetaManagedAgentsMCPToolset>",13770 "type": "BetaManagedAgentsMCPToolset object",13771 "required": false,13772 "description": ""13773 },13774 {13775 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools<BetaManagedAgentsMCPToolset>.type",13776 "type": "\"mcp_toolset\"",13777 "required": true,13778 "description": ""13779 },13780 {13781 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools<BetaManagedAgentsMCPToolset>.configs",13782 "type": "array of BetaManagedAgentsMCPToolConfig",13783 "required": true,13784 "description": ""13785 },13786 {13787 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools<BetaManagedAgentsMCPToolset>.default_config",13788 "type": "BetaManagedAgentsMCPToolsetDefaultConfig",13789 "required": true,13790 "description": "Resolved default configuration for all tools from an MCP server."13791 },13792 {13793 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools<BetaManagedAgentsMCPToolset>.mcp_server_name",13794 "type": "string",13795 "required": true,13796 "description": ""13797 },13798 {13799 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools<BetaManagedAgentsCustomTool>",13800 "type": "BetaManagedAgentsCustomTool object",13801 "required": false,13802 "description": "A custom tool as returned in API responses."13803 },13804 {13805 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools<BetaManagedAgentsCustomTool>.type",13806 "type": "\"custom\"",13807 "required": true,13808 "description": ""13809 },13810 {13811 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools<BetaManagedAgentsCustomTool>.description",13812 "type": "string",13813 "required": true,13814 "description": ""13815 },13816 {13817 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools<BetaManagedAgentsCustomTool>.input_schema",13818 "type": "BetaManagedAgentsCustomToolInputSchema",13819 "required": true,13820 "description": "JSON Schema for custom tool input parameters."13821 },13822 {13823 "name": "agent<BetaManagedAgentsSessionThreadAgent>.tools<BetaManagedAgentsCustomTool>.name",13824 "type": "string",13825 "required": true,13826 "description": ""13827 },13828 {13829 "name": "agent<BetaManagedAgentsSessionThreadAgent>.version",13830 "type": "number",13831 "required": true,13832 "description": "",13833 "constraints": {13834 "format": "int32"13835 }13836 },13837 {13838 "name": "agent<BetaManagedAgentsAdvisor>",13839 "type": "BetaManagedAgentsAdvisor object",13840 "required": false,13841 "description": "Platform advisor roster entry: a model the session's primary thread may consult mid-turn."13842 },13843 {13844 "name": "agent<BetaManagedAgentsAdvisor>.type",13845 "type": "\"advisor\"",13846 "required": true,13847 "description": ""13848 },13849 {13850 "name": "agent<BetaManagedAgentsAdvisor>.model",13851 "type": "string",13852 "required": true,13853 "description": "The advisor model id."13854 },13855 {13856 "name": "archived_at",13857 "type": "string or null",13858 "required": true,13859 "description": "A timestamp in RFC 3339 format",13860 "constraints": {13861 "format": "date-time"13862 }13863 },13864 {13865 "name": "created_at",13866 "type": "string",13867 "required": true,13868 "description": "A timestamp in RFC 3339 format",13869 "constraints": {13870 "format": "date-time"13871 }13872 },13873 {13874 "name": "parent_thread_id",13875 "type": "string or null",13876 "required": true,13877 "description": "Parent thread that spawned this thread. Null for the primary thread."13878 },13879 {13880 "name": "session_id",13881 "type": "string",13882 "required": true,13883 "description": "The session this thread belongs to."13884 },13885 {13886 "name": "stats",13887 "type": "BetaManagedAgentsSessionThreadStats or null",13888 "required": true,13889 "description": "Timing statistics for a session thread."13890 },13891 {13892 "name": "stats.active_seconds",13893 "type": "number",13894 "required": false,13895 "description": "Cumulative time in seconds the thread spent actively running. Excludes idle time.",13896 "constraints": {13897 "format": "double"13898 }13899 },13900 {13901 "name": "stats.duration_seconds",13902 "type": "number",13903 "required": false,13904 "description": "Elapsed time since thread creation in seconds. For archived threads, frozen at the final update.",13905 "constraints": {13906 "format": "double"13907 }13908 },13909 {13910 "name": "stats.startup_seconds",13911 "type": "number",13912 "required": false,13913 "description": "Time in seconds for the thread to begin running. Zero for child threads, which start immediately.",13914 "constraints": {13915 "format": "double"13916 }13917 },13918 {13919 "name": "status",13920 "type": "BetaManagedAgentsSessionThreadStatus",13921 "required": true,13922 "description": "SessionThreadStatus enum",13923 "enum": [13924 "running",13925 "idle",13926 "rescheduling",13927 "terminated"13928 ]13929 },13930 {13931 "name": "updated_at",13932 "type": "string",13933 "required": true,13934 "description": "A timestamp in RFC 3339 format",13935 "constraints": {13936 "format": "date-time"13937 }13938 },13939 {13940 "name": "usage",13941 "type": "BetaManagedAgentsSessionThreadUsage or null",13942 "required": true,13943 "description": "Cumulative token usage for a session thread across all turns."13944 },13945 {13946 "name": "usage.active_seconds",13947 "type": "number",13948 "required": false,13949 "description": "Cumulative time in seconds this thread spent in running status. Equal to `stats.active_seconds`; surfaced here so a thread's usage carries every quantity its cost is priced on.",13950 "constraints": {13951 "format": "double"13952 }13953 },13954 {13955 "name": "usage.cache_creation",13956 "type": "BetaManagedAgentsCacheCreationUsage",13957 "required": false,13958 "description": "Prompt-cache creation token usage broken down by cache lifetime."13959 },13960 {13961 "name": "usage.cache_creation.ephemeral_1h_input_tokens",13962 "type": "number",13963 "required": false,13964 "description": "Tokens used to create 1-hour ephemeral cache entries.",13965 "constraints": {13966 "format": "int32"13967 }13968 },13969 {13970 "name": "usage.cache_creation.ephemeral_5m_input_tokens",13971 "type": "number",13972 "required": false,13973 "description": "Tokens used to create 5-minute ephemeral cache entries.",13974 "constraints": {13975 "format": "int32"13976 }13977 },13978 {13979 "name": "usage.cache_read_input_tokens",13980 "type": "number",13981 "required": false,13982 "description": "Total tokens read from prompt cache.",13983 "constraints": {13984 "format": "int32"13985 }13986 },13987 {13988 "name": "usage.input_tokens",13989 "type": "number",13990 "required": false,13991 "description": "Total input tokens consumed across all turns.",13992 "constraints": {13993 "format": "int32"13994 }13995 },13996 {13997 "name": "usage.list_cost",13998 "type": "BetaMonetaryAmount or null",13999 "required": false,14000 "description": "A monetary amount in a specific currency."14001 },14002 {14003 "name": "usage.list_cost.amount",14004 "type": "string",14005 "required": true,14006 "description": "Amount in minor units of the currency, as an integer decimal string with no leading zeros: \"2500\" is $25.00 and \"50\" is fifty cents. A string rather than a number so no float rounding is ever applied."14007 },14008 {14009 "name": "usage.list_cost.currency",14010 "type": "BetaCurrency",14011 "required": true,14012 "description": "Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced."14013 },14014 {14015 "name": "usage.output_tokens",14016 "type": "number",14017 "required": false,14018 "description": "Total output tokens generated across all turns.",14019 "constraints": {14020 "format": "int32"14021 }14022 },14023 {14024 "name": "usage.server_tool_use",14025 "type": "BetaManagedAgentsServerToolUsage or null",14026 "required": false,14027 "description": "Cumulative count of server-executed tool invocations, broken down by tool."14028 },14029 {14030 "name": "usage.server_tool_use.web_fetch_requests",14031 "type": "number",14032 "required": false,14033 "description": "Number of server-executed web fetch requests.",14034 "constraints": {14035 "format": "int32"14036 }14037 },14038 {14039 "name": "usage.server_tool_use.web_search_requests",14040 "type": "number",14041 "required": false,14042 "description": "Number of server-executed web search requests.",14043 "constraints": {14044 "format": "int32"14045 }14046 }14047 ],14048 "status": [14049 "DOCUMENTED",14050 "BETA"14051 ],14052 "sources": [14053 {14054 "url": "https://platform.claude.com/docs/en/api/beta/sessions/threads/retrieve",14055 "retrieved_at": "2026-09-18"14056 },14057 {14058 "url": "https://platform.claude.com/docs/en/managed-agents/multiagent-orchestration",14059 "retrieved_at": "2026-09-18"14060 }14061 ],14062 "beta_header": "managed-agents-2026-04-01"14063 },14064 {14065 "provider": "anthropic",14066 "api_family": "managed-agents",14067 "name": "SessionEvent (union of persisted event variants)",14068 "official_type_name": "BetaManagedAgentsSessionEvent",14069 "description": "Events for the session, ordered by `processed_at`.",14070 "fields": [14071 {14072 "name": "<BetaManagedAgentsUserMessageEvent>",14073 "type": "BetaManagedAgentsUserMessageEvent object",14074 "required": false,14075 "description": "A user message event in the session conversation."14076 },14077 {14078 "name": "<BetaManagedAgentsUserMessageEvent>.type",14079 "type": "\"user.message\"",14080 "required": true,14081 "description": ""14082 },14083 {14084 "name": "<BetaManagedAgentsUserMessageEvent>.id",14085 "type": "string",14086 "required": true,14087 "description": "Unique identifier for this event."14088 },14089 {14090 "name": "<BetaManagedAgentsUserMessageEvent>.content",14091 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock",14092 "required": true,14093 "description": "Array of content blocks comprising the user message."14094 },14095 {14096 "name": "<BetaManagedAgentsUserMessageEvent>.processed_at",14097 "type": "string or null",14098 "required": false,14099 "description": "A timestamp in RFC 3339 format",14100 "constraints": {14101 "format": "date-time"14102 }14103 },14104 {14105 "name": "<BetaManagedAgentsUserInterruptEvent>",14106 "type": "BetaManagedAgentsUserInterruptEvent object",14107 "required": false,14108 "description": "An interrupt event that pauses agent execution and returns control to the user."14109 },14110 {14111 "name": "<BetaManagedAgentsUserInterruptEvent>.type",14112 "type": "\"user.interrupt\"",14113 "required": true,14114 "description": ""14115 },14116 {14117 "name": "<BetaManagedAgentsUserInterruptEvent>.id",14118 "type": "string",14119 "required": true,14120 "description": "Unique identifier for this event."14121 },14122 {14123 "name": "<BetaManagedAgentsUserInterruptEvent>.processed_at",14124 "type": "string or null",14125 "required": false,14126 "description": "A timestamp in RFC 3339 format",14127 "constraints": {14128 "format": "date-time"14129 }14130 },14131 {14132 "name": "<BetaManagedAgentsUserInterruptEvent>.session_thread_id",14133 "type": "string or null",14134 "required": false,14135 "description": "If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread."14136 },14137 {14138 "name": "<BetaManagedAgentsUserToolConfirmationEvent>",14139 "type": "BetaManagedAgentsUserToolConfirmationEvent object",14140 "required": false,14141 "description": "A tool confirmation event that approves or denies a pending tool execution."14142 },14143 {14144 "name": "<BetaManagedAgentsUserToolConfirmationEvent>.type",14145 "type": "\"user.tool_confirmation\"",14146 "required": true,14147 "description": ""14148 },14149 {14150 "name": "<BetaManagedAgentsUserToolConfirmationEvent>.id",14151 "type": "string",14152 "required": true,14153 "description": "Unique identifier for this event."14154 },14155 {14156 "name": "<BetaManagedAgentsUserToolConfirmationEvent>.result",14157 "type": "\"allow\" or \"deny\"",14158 "required": true,14159 "description": "UserToolConfirmationResult enum",14160 "enum": [14161 "allow",14162 "deny"14163 ]14164 },14165 {14166 "name": "<BetaManagedAgentsUserToolConfirmationEvent>.tool_use_id",14167 "type": "string",14168 "required": true,14169 "description": "The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field."14170 },14171 {14172 "name": "<BetaManagedAgentsUserToolConfirmationEvent>.deny_message",14173 "type": "string or null",14174 "required": false,14175 "description": "Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'.",14176 "constraints": {14177 "maxLength": "10000"14178 }14179 },14180 {14181 "name": "<BetaManagedAgentsUserToolConfirmationEvent>.processed_at",14182 "type": "string or null",14183 "required": false,14184 "description": "A timestamp in RFC 3339 format",14185 "constraints": {14186 "format": "date-time"14187 }14188 },14189 {14190 "name": "<BetaManagedAgentsUserToolConfirmationEvent>.session_thread_id",14191 "type": "string or null",14192 "required": false,14193 "description": "Set by the server to the subagent thread this confirmation was routed to. Omitted when it was routed to the primary thread."14194 },14195 {14196 "name": "<BetaManagedAgentsUserCustomToolResultEvent>",14197 "type": "BetaManagedAgentsUserCustomToolResultEvent object",14198 "required": false,14199 "description": "Event sent by the client providing the result of a custom tool execution."14200 },14201 {14202 "name": "<BetaManagedAgentsUserCustomToolResultEvent>.type",14203 "type": "\"user.custom_tool_result\"",14204 "required": true,14205 "description": ""14206 },14207 {14208 "name": "<BetaManagedAgentsUserCustomToolResultEvent>.id",14209 "type": "string",14210 "required": true,14211 "description": "Unique identifier for this event."14212 },14213 {14214 "name": "<BetaManagedAgentsUserCustomToolResultEvent>.custom_tool_use_id",14215 "type": "string",14216 "required": true,14217 "description": "The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field."14218 },14219 {14220 "name": "<BetaManagedAgentsUserCustomToolResultEvent>.content",14221 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock",14222 "required": false,14223 "description": "The result content returned by the tool."14224 },14225 {14226 "name": "<BetaManagedAgentsUserCustomToolResultEvent>.is_error",14227 "type": "boolean or null",14228 "required": false,14229 "description": "Whether the tool execution resulted in an error."14230 },14231 {14232 "name": "<BetaManagedAgentsUserCustomToolResultEvent>.processed_at",14233 "type": "string or null",14234 "required": false,14235 "description": "A timestamp in RFC 3339 format",14236 "constraints": {14237 "format": "date-time"14238 }14239 },14240 {14241 "name": "<BetaManagedAgentsUserCustomToolResultEvent>.session_thread_id",14242 "type": "string or null",14243 "required": false,14244 "description": "Set by the server to the subagent thread this result was routed to. Omitted when it was routed to the primary thread."14245 },14246 {14247 "name": "<BetaManagedAgentsAgentCustomToolUseEvent>",14248 "type": "BetaManagedAgentsAgentCustomToolUseEvent object",14249 "required": false,14250 "description": "Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result."14251 },14252 {14253 "name": "<BetaManagedAgentsAgentCustomToolUseEvent>.type",14254 "type": "\"agent.custom_tool_use\"",14255 "required": true,14256 "description": ""14257 },14258 {14259 "name": "<BetaManagedAgentsAgentCustomToolUseEvent>.id",14260 "type": "string",14261 "required": true,14262 "description": "Unique identifier for this event."14263 },14264 {14265 "name": "<BetaManagedAgentsAgentCustomToolUseEvent>.input",14266 "type": "map[unknown]",14267 "required": true,14268 "description": "Input parameters for the tool call."14269 },14270 {14271 "name": "<BetaManagedAgentsAgentCustomToolUseEvent>.name",14272 "type": "string",14273 "required": true,14274 "description": "Name of the custom tool being called."14275 },14276 {14277 "name": "<BetaManagedAgentsAgentCustomToolUseEvent>.processed_at",14278 "type": "string",14279 "required": true,14280 "description": "A timestamp in RFC 3339 format",14281 "constraints": {14282 "format": "date-time"14283 }14284 },14285 {14286 "name": "<BetaManagedAgentsAgentCustomToolUseEvent>.session_thread_id",14287 "type": "string or null",14288 "required": false,14289 "description": "When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Informational only: the server routes the matching `user.custom_tool_result` by `custom_tool_use_id`, so clients do not send it back."14290 },14291 {14292 "name": "<BetaManagedAgentsAgentMessageEvent>",14293 "type": "BetaManagedAgentsAgentMessageEvent object",14294 "required": false,14295 "description": "An agent response event in the session conversation."14296 },14297 {14298 "name": "<BetaManagedAgentsAgentMessageEvent>.type",14299 "type": "\"agent.message\"",14300 "required": true,14301 "description": ""14302 },14303 {14304 "name": "<BetaManagedAgentsAgentMessageEvent>.id",14305 "type": "string",14306 "required": true,14307 "description": "Unique identifier for this event."14308 },14309 {14310 "name": "<BetaManagedAgentsAgentMessageEvent>.content",14311 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsRedactedBlock",14312 "required": true,14313 "description": "Array of text blocks comprising the agent response."14314 },14315 {14316 "name": "<BetaManagedAgentsAgentMessageEvent>.processed_at",14317 "type": "string",14318 "required": true,14319 "description": "A timestamp in RFC 3339 format",14320 "constraints": {14321 "format": "date-time"14322 }14323 },14324 {14325 "name": "<BetaManagedAgentsAgentThinkingEvent>",14326 "type": "BetaManagedAgentsAgentThinkingEvent object",14327 "required": false,14328 "description": "Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier."14329 },14330 {14331 "name": "<BetaManagedAgentsAgentThinkingEvent>.type",14332 "type": "\"agent.thinking\"",14333 "required": true,14334 "description": ""14335 },14336 {14337 "name": "<BetaManagedAgentsAgentThinkingEvent>.id",14338 "type": "string",14339 "required": true,14340 "description": "Unique identifier for this event."14341 },14342 {14343 "name": "<BetaManagedAgentsAgentThinkingEvent>.processed_at",14344 "type": "string",14345 "required": true,14346 "description": "A timestamp in RFC 3339 format",14347 "constraints": {14348 "format": "date-time"14349 }14350 },14351 {14352 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>",14353 "type": "BetaManagedAgentsAgentMCPToolUseEvent object",14354 "required": false,14355 "description": "Event emitted when the agent invokes a tool provided by an MCP server."14356 },14357 {14358 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.type",14359 "type": "\"agent.mcp_tool_use\"",14360 "required": true,14361 "description": ""14362 },14363 {14364 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.id",14365 "type": "string",14366 "required": true,14367 "description": "Unique identifier for this event."14368 },14369 {14370 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.input",14371 "type": "map[unknown]",14372 "required": true,14373 "description": "Input parameters for the tool call."14374 },14375 {14376 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.mcp_server_name",14377 "type": "string",14378 "required": true,14379 "description": "Name of the MCP server providing the tool."14380 },14381 {14382 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.name",14383 "type": "string",14384 "required": true,14385 "description": "Name of the MCP tool being used."14386 },14387 {14388 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.processed_at",14389 "type": "string",14390 "required": true,14391 "description": "A timestamp in RFC 3339 format",14392 "constraints": {14393 "format": "date-time"14394 }14395 },14396 {14397 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.evaluated_permission",14398 "type": "\"allow\" or \"ask\" or \"deny\"",14399 "required": false,14400 "description": "AgentEvaluatedPermission enum",14401 "enum": [14402 "allow",14403 "ask",14404 "deny"14405 ]14406 },14407 {14408 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.evaluation",14409 "type": "BetaManagedAgentsAgentToolEvaluation",14410 "required": false,14411 "description": "Names the resolved permission_policy that produced evaluated_permission, and under auto carries the judgement. Open union: clients must tolerate unknown variants."14412 },14413 {14414 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.session_thread_id",14415 "type": "string or null",14416 "required": false,14417 "description": "When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Informational only: the server routes the matching `user.tool_confirmation` by `tool_use_id`, so clients do not send it back."14418 },14419 {14420 "name": "<BetaManagedAgentsAgentMCPToolResultEvent>",14421 "type": "BetaManagedAgentsAgentMCPToolResultEvent object",14422 "required": false,14423 "description": "Event representing the result of an MCP tool execution."14424 },14425 {14426 "name": "<BetaManagedAgentsAgentMCPToolResultEvent>.type",14427 "type": "\"agent.mcp_tool_result\"",14428 "required": true,14429 "description": ""14430 },14431 {14432 "name": "<BetaManagedAgentsAgentMCPToolResultEvent>.id",14433 "type": "string",14434 "required": true,14435 "description": "Unique identifier for this event."14436 },14437 {14438 "name": "<BetaManagedAgentsAgentMCPToolResultEvent>.mcp_tool_use_id",14439 "type": "string",14440 "required": true,14441 "description": "The id of the `agent.mcp_tool_use` event this result corresponds to."14442 },14443 {14444 "name": "<BetaManagedAgentsAgentMCPToolResultEvent>.processed_at",14445 "type": "string",14446 "required": true,14447 "description": "A timestamp in RFC 3339 format",14448 "constraints": {14449 "format": "date-time"14450 }14451 },14452 {14453 "name": "<BetaManagedAgentsAgentMCPToolResultEvent>.content",14454 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock",14455 "required": false,14456 "description": "The result content returned by the tool."14457 },14458 {14459 "name": "<BetaManagedAgentsAgentMCPToolResultEvent>.is_error",14460 "type": "boolean or null",14461 "required": false,14462 "description": "Whether the tool execution resulted in an error."14463 },14464 {14465 "name": "<BetaManagedAgentsAgentToolUseEvent>",14466 "type": "BetaManagedAgentsAgentToolUseEvent object",14467 "required": false,14468 "description": "Event emitted when the agent invokes a built-in agent tool."14469 },14470 {14471 "name": "<BetaManagedAgentsAgentToolUseEvent>.type",14472 "type": "\"agent.tool_use\"",14473 "required": true,14474 "description": ""14475 },14476 {14477 "name": "<BetaManagedAgentsAgentToolUseEvent>.id",14478 "type": "string",14479 "required": true,14480 "description": "Unique identifier for this event."14481 },14482 {14483 "name": "<BetaManagedAgentsAgentToolUseEvent>.input",14484 "type": "map[unknown]",14485 "required": true,14486 "description": "Input parameters for the tool call."14487 },14488 {14489 "name": "<BetaManagedAgentsAgentToolUseEvent>.name",14490 "type": "string",14491 "required": true,14492 "description": "Name of the agent tool being used."14493 },14494 {14495 "name": "<BetaManagedAgentsAgentToolUseEvent>.processed_at",14496 "type": "string",14497 "required": true,14498 "description": "A timestamp in RFC 3339 format",14499 "constraints": {14500 "format": "date-time"14501 }14502 },14503 {14504 "name": "<BetaManagedAgentsAgentToolUseEvent>.evaluated_permission",14505 "type": "\"allow\" or \"ask\" or \"deny\"",14506 "required": false,14507 "description": "AgentEvaluatedPermission enum",14508 "enum": [14509 "allow",14510 "ask",14511 "deny"14512 ]14513 },14514 {14515 "name": "<BetaManagedAgentsAgentToolUseEvent>.evaluation",14516 "type": "BetaManagedAgentsAgentToolEvaluation",14517 "required": false,14518 "description": "Names the resolved permission_policy that produced evaluated_permission, and under auto carries the judgement. Open union: clients must tolerate unknown variants."14519 },14520 {14521 "name": "<BetaManagedAgentsAgentToolUseEvent>.session_thread_id",14522 "type": "string or null",14523 "required": false,14524 "description": "When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Informational only: the server routes the matching `user.tool_confirmation` or `user.tool_result` by `tool_use_id`, so clients do not send it back."14525 },14526 {14527 "name": "<BetaManagedAgentsAgentToolResultEvent>",14528 "type": "BetaManagedAgentsAgentToolResultEvent object",14529 "required": false,14530 "description": "Event representing the result of an agent tool execution."14531 },14532 {14533 "name": "<BetaManagedAgentsAgentToolResultEvent>.type",14534 "type": "\"agent.tool_result\"",14535 "required": true,14536 "description": ""14537 },14538 {14539 "name": "<BetaManagedAgentsAgentToolResultEvent>.id",14540 "type": "string",14541 "required": true,14542 "description": "Unique identifier for this event."14543 },14544 {14545 "name": "<BetaManagedAgentsAgentToolResultEvent>.processed_at",14546 "type": "string",14547 "required": true,14548 "description": "A timestamp in RFC 3339 format",14549 "constraints": {14550 "format": "date-time"14551 }14552 },14553 {14554 "name": "<BetaManagedAgentsAgentToolResultEvent>.tool_use_id",14555 "type": "string",14556 "required": true,14557 "description": "The id of the `agent.tool_use` event this result corresponds to."14558 },14559 {14560 "name": "<BetaManagedAgentsAgentToolResultEvent>.content",14561 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock",14562 "required": false,14563 "description": "The result content returned by the tool."14564 },14565 {14566 "name": "<BetaManagedAgentsAgentToolResultEvent>.is_error",14567 "type": "boolean or null",14568 "required": false,14569 "description": "Whether the tool execution resulted in an error."14570 },14571 {14572 "name": "<BetaManagedAgentsAgentThreadMessageReceivedEvent>",14573 "type": "BetaManagedAgentsAgentThreadMessageReceivedEvent object",14574 "required": false,14575 "description": "Delivery event written to the target thread's input stream when an agent-to-agent message arrives."14576 },14577 {14578 "name": "<BetaManagedAgentsAgentThreadMessageReceivedEvent>.type",14579 "type": "\"agent.thread_message_received\"",14580 "required": true,14581 "description": ""14582 },14583 {14584 "name": "<BetaManagedAgentsAgentThreadMessageReceivedEvent>.id",14585 "type": "string",14586 "required": true,14587 "description": "Unique identifier for this event."14588 },14589 {14590 "name": "<BetaManagedAgentsAgentThreadMessageReceivedEvent>.content",14591 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock",14592 "required": true,14593 "description": "Message content blocks."14594 },14595 {14596 "name": "<BetaManagedAgentsAgentThreadMessageReceivedEvent>.from_session_thread_id",14597 "type": "string",14598 "required": true,14599 "description": "Public `sthr_` ID of the thread that sent the message."14600 },14601 {14602 "name": "<BetaManagedAgentsAgentThreadMessageReceivedEvent>.processed_at",14603 "type": "string",14604 "required": true,14605 "description": "A timestamp in RFC 3339 format",14606 "constraints": {14607 "format": "date-time"14608 }14609 },14610 {14611 "name": "<BetaManagedAgentsAgentThreadMessageReceivedEvent>.from_agent_name",14612 "type": "string or null",14613 "required": false,14614 "description": "Name of the callable agent this message came from. Absent when received from the primary agent."14615 },14616 {14617 "name": "<BetaManagedAgentsAgentThreadMessageSentEvent>",14618 "type": "BetaManagedAgentsAgentThreadMessageSentEvent object",14619 "required": false,14620 "description": "Observability event emitted to the sender's output stream when an agent-to-agent message is sent."14621 },14622 {14623 "name": "<BetaManagedAgentsAgentThreadMessageSentEvent>.type",14624 "type": "\"agent.thread_message_sent\"",14625 "required": true,14626 "description": ""14627 },14628 {14629 "name": "<BetaManagedAgentsAgentThreadMessageSentEvent>.id",14630 "type": "string",14631 "required": true,14632 "description": "Unique identifier for this event."14633 },14634 {14635 "name": "<BetaManagedAgentsAgentThreadMessageSentEvent>.content",14636 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock",14637 "required": true,14638 "description": "Message content blocks."14639 },14640 {14641 "name": "<BetaManagedAgentsAgentThreadMessageSentEvent>.processed_at",14642 "type": "string",14643 "required": true,14644 "description": "A timestamp in RFC 3339 format",14645 "constraints": {14646 "format": "date-time"14647 }14648 },14649 {14650 "name": "<BetaManagedAgentsAgentThreadMessageSentEvent>.to_session_thread_id",14651 "type": "string",14652 "required": true,14653 "description": "Public `sthr_` ID of the thread the message was sent to."14654 },14655 {14656 "name": "<BetaManagedAgentsAgentThreadMessageSentEvent>.to_agent_name",14657 "type": "string or null",14658 "required": false,14659 "description": "Name of the callable agent this message was sent to. Absent when sent to the primary agent."14660 },14661 {14662 "name": "<BetaManagedAgentsAgentThreadContextCompactedEvent>",14663 "type": "BetaManagedAgentsAgentThreadContextCompactedEvent object",14664 "required": false,14665 "description": "Indicates that context compaction (summarization) occurred during the session."14666 },14667 {14668 "name": "<BetaManagedAgentsAgentThreadContextCompactedEvent>.type",14669 "type": "\"agent.thread_context_compacted\"",14670 "required": true,14671 "description": ""14672 },14673 {14674 "name": "<BetaManagedAgentsAgentThreadContextCompactedEvent>.id",14675 "type": "string",14676 "required": true,14677 "description": "Unique identifier for this event."14678 },14679 {14680 "name": "<BetaManagedAgentsAgentThreadContextCompactedEvent>.processed_at",14681 "type": "string",14682 "required": true,14683 "description": "A timestamp in RFC 3339 format",14684 "constraints": {14685 "format": "date-time"14686 }14687 },14688 {14689 "name": "<BetaManagedAgentsSessionErrorEvent>",14690 "type": "BetaManagedAgentsSessionErrorEvent object",14691 "required": false,14692 "description": "An error event indicating a problem occurred during session execution."14693 },14694 {14695 "name": "<BetaManagedAgentsSessionErrorEvent>.type",14696 "type": "\"session.error\"",14697 "required": true,14698 "description": ""14699 },14700 {14701 "name": "<BetaManagedAgentsSessionErrorEvent>.id",14702 "type": "string",14703 "required": true,14704 "description": "Unique identifier for this event."14705 },14706 {14707 "name": "<BetaManagedAgentsSessionErrorEvent>.error",14708 "type": "BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 5 more",14709 "required": true,14710 "description": ""14711 },14712 {14713 "name": "<BetaManagedAgentsSessionErrorEvent>.processed_at",14714 "type": "string",14715 "required": true,14716 "description": "A timestamp in RFC 3339 format",14717 "constraints": {14718 "format": "date-time"14719 }14720 },14721 {14722 "name": "<BetaManagedAgentsSessionStatusRescheduledEvent>",14723 "type": "BetaManagedAgentsSessionStatusRescheduledEvent object",14724 "required": false,14725 "description": "Indicates the session is recovering from an error state and is rescheduled for execution."14726 },14727 {14728 "name": "<BetaManagedAgentsSessionStatusRescheduledEvent>.type",14729 "type": "\"session.status_rescheduled\"",14730 "required": true,14731 "description": ""14732 },14733 {14734 "name": "<BetaManagedAgentsSessionStatusRescheduledEvent>.id",14735 "type": "string",14736 "required": true,14737 "description": "Unique identifier for this event."14738 },14739 {14740 "name": "<BetaManagedAgentsSessionStatusRescheduledEvent>.processed_at",14741 "type": "string",14742 "required": true,14743 "description": "A timestamp in RFC 3339 format",14744 "constraints": {14745 "format": "date-time"14746 }14747 },14748 {14749 "name": "<BetaManagedAgentsSessionStatusRunningEvent>",14750 "type": "BetaManagedAgentsSessionStatusRunningEvent object",14751 "required": false,14752 "description": "Indicates the session is actively running and the agent is working."14753 },14754 {14755 "name": "<BetaManagedAgentsSessionStatusRunningEvent>.type",14756 "type": "\"session.status_running\"",14757 "required": true,14758 "description": ""14759 },14760 {14761 "name": "<BetaManagedAgentsSessionStatusRunningEvent>.id",14762 "type": "string",14763 "required": true,14764 "description": "Unique identifier for this event."14765 },14766 {14767 "name": "<BetaManagedAgentsSessionStatusRunningEvent>.processed_at",14768 "type": "string",14769 "required": true,14770 "description": "A timestamp in RFC 3339 format",14771 "constraints": {14772 "format": "date-time"14773 }14774 },14775 {14776 "name": "<BetaManagedAgentsSessionStatusIdleEvent>",14777 "type": "BetaManagedAgentsSessionStatusIdleEvent object",14778 "required": false,14779 "description": "Indicates the agent has paused and is awaiting user input."14780 },14781 {14782 "name": "<BetaManagedAgentsSessionStatusIdleEvent>.type",14783 "type": "\"session.status_idle\"",14784 "required": true,14785 "description": ""14786 },14787 {14788 "name": "<BetaManagedAgentsSessionStatusIdleEvent>.id",14789 "type": "string",14790 "required": true,14791 "description": "Unique identifier for this event."14792 },14793 {14794 "name": "<BetaManagedAgentsSessionStatusIdleEvent>.processed_at",14795 "type": "string",14796 "required": true,14797 "description": "A timestamp in RFC 3339 format",14798 "constraints": {14799 "format": "date-time"14800 }14801 },14802 {14803 "name": "<BetaManagedAgentsSessionStatusIdleEvent>.stop_reason",14804 "type": "BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted or BetaManagedAgentsSessionBudgetReached",14805 "required": true,14806 "description": ""14807 },14808 {14809 "name": "<BetaManagedAgentsSessionStatusTerminatedEvent>",14810 "type": "BetaManagedAgentsSessionStatusTerminatedEvent object",14811 "required": false,14812 "description": "Indicates the session has terminated, either due to an error or completion."14813 },14814 {14815 "name": "<BetaManagedAgentsSessionStatusTerminatedEvent>.type",14816 "type": "\"session.status_terminated\"",14817 "required": true,14818 "description": ""14819 },14820 {14821 "name": "<BetaManagedAgentsSessionStatusTerminatedEvent>.id",14822 "type": "string",14823 "required": true,14824 "description": "Unique identifier for this event."14825 },14826 {14827 "name": "<BetaManagedAgentsSessionStatusTerminatedEvent>.processed_at",14828 "type": "string",14829 "required": true,14830 "description": "A timestamp in RFC 3339 format",14831 "constraints": {14832 "format": "date-time"14833 }14834 },14835 {14836 "name": "<BetaManagedAgentsSessionThreadCreatedEvent>",14837 "type": "BetaManagedAgentsSessionThreadCreatedEvent object",14838 "required": false,14839 "description": "Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation."14840 },14841 {14842 "name": "<BetaManagedAgentsSessionThreadCreatedEvent>.type",14843 "type": "\"session.thread_created\"",14844 "required": true,14845 "description": ""14846 },14847 {14848 "name": "<BetaManagedAgentsSessionThreadCreatedEvent>.id",14849 "type": "string",14850 "required": true,14851 "description": "Unique identifier for this event."14852 },14853 {14854 "name": "<BetaManagedAgentsSessionThreadCreatedEvent>.agent_name",14855 "type": "string",14856 "required": true,14857 "description": "Name of the callable agent the thread runs."14858 },14859 {14860 "name": "<BetaManagedAgentsSessionThreadCreatedEvent>.processed_at",14861 "type": "string",14862 "required": true,14863 "description": "A timestamp in RFC 3339 format",14864 "constraints": {14865 "format": "date-time"14866 }14867 },14868 {14869 "name": "<BetaManagedAgentsSessionThreadCreatedEvent>.session_thread_id",14870 "type": "string",14871 "required": true,14872 "description": "Public `sthr_` ID of the newly created thread."14873 },14874 {14875 "name": "<BetaManagedAgentsSpanOutcomeEvaluationStartEvent>",14876 "type": "BetaManagedAgentsSpanOutcomeEvaluationStartEvent object",14877 "required": false,14878 "description": "Emitted when an outcome evaluation cycle begins."14879 },14880 {14881 "name": "<BetaManagedAgentsSpanOutcomeEvaluationStartEvent>.type",14882 "type": "\"span.outcome_evaluation_start\"",14883 "required": true,14884 "description": ""14885 },14886 {14887 "name": "<BetaManagedAgentsSpanOutcomeEvaluationStartEvent>.id",14888 "type": "string",14889 "required": true,14890 "description": "Unique identifier for this event."14891 },14892 {14893 "name": "<BetaManagedAgentsSpanOutcomeEvaluationStartEvent>.iteration",14894 "type": "number",14895 "required": true,14896 "description": "0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc.",14897 "constraints": {14898 "format": "int32"14899 }14900 },14901 {14902 "name": "<BetaManagedAgentsSpanOutcomeEvaluationStartEvent>.outcome_id",14903 "type": "string",14904 "required": true,14905 "description": "The `outc_` ID of the outcome being evaluated."14906 },14907 {14908 "name": "<BetaManagedAgentsSpanOutcomeEvaluationStartEvent>.processed_at",14909 "type": "string",14910 "required": true,14911 "description": "A timestamp in RFC 3339 format",14912 "constraints": {14913 "format": "date-time"14914 }14915 },14916 {14917 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>",14918 "type": "BetaManagedAgentsSpanOutcomeEvaluationEndEvent object",14919 "required": false,14920 "description": "Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow."14921 },14922 {14923 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.type",14924 "type": "\"span.outcome_evaluation_end\"",14925 "required": true,14926 "description": ""14927 },14928 {14929 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.id",14930 "type": "string",14931 "required": true,14932 "description": "Unique identifier for this event."14933 },14934 {14935 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.explanation",14936 "type": "string",14937 "required": true,14938 "description": "Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why."14939 },14940 {14941 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.iteration",14942 "type": "number",14943 "required": true,14944 "description": "0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`.",14945 "constraints": {14946 "format": "int32"14947 }14948 },14949 {14950 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.outcome_evaluation_start_id",14951 "type": "string",14952 "required": true,14953 "description": "The id of the corresponding `span.outcome_evaluation_start` event."14954 },14955 {14956 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.outcome_id",14957 "type": "string",14958 "required": true,14959 "description": "The `outc_` ID of the outcome being evaluated."14960 },14961 {14962 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.processed_at",14963 "type": "string",14964 "required": true,14965 "description": "A timestamp in RFC 3339 format",14966 "constraints": {14967 "format": "date-time"14968 }14969 },14970 {14971 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.result",14972 "type": "string",14973 "required": true,14974 "description": "Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress."14975 },14976 {14977 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.usage",14978 "type": "BetaManagedAgentsSpanModelUsage",14979 "required": true,14980 "description": "Token usage for a single model request."14981 },14982 {14983 "name": "<BetaManagedAgentsSpanModelRequestStartEvent>",14984 "type": "BetaManagedAgentsSpanModelRequestStartEvent object",14985 "required": false,14986 "description": "Emitted when a model request is initiated by the agent."14987 },14988 {14989 "name": "<BetaManagedAgentsSpanModelRequestStartEvent>.type",14990 "type": "\"span.model_request_start\"",14991 "required": true,14992 "description": ""14993 },14994 {14995 "name": "<BetaManagedAgentsSpanModelRequestStartEvent>.id",14996 "type": "string",14997 "required": true,14998 "description": "Unique identifier for this event."14999 },15000 {15001 "name": "<BetaManagedAgentsSpanModelRequestStartEvent>.processed_at",15002 "type": "string",15003 "required": true,15004 "description": "A timestamp in RFC 3339 format",15005 "constraints": {15006 "format": "date-time"15007 }15008 },15009 {15010 "name": "<BetaManagedAgentsSpanModelRequestEndEvent>",15011 "type": "BetaManagedAgentsSpanModelRequestEndEvent object",15012 "required": false,15013 "description": "Emitted when a model request completes."15014 },15015 {15016 "name": "<BetaManagedAgentsSpanModelRequestEndEvent>.type",15017 "type": "\"span.model_request_end\"",15018 "required": true,15019 "description": ""15020 },15021 {15022 "name": "<BetaManagedAgentsSpanModelRequestEndEvent>.id",15023 "type": "string",15024 "required": true,15025 "description": "Unique identifier for this event."15026 },15027 {15028 "name": "<BetaManagedAgentsSpanModelRequestEndEvent>.is_error",15029 "type": "boolean or null",15030 "required": true,15031 "description": "Whether the model request resulted in an error."15032 },15033 {15034 "name": "<BetaManagedAgentsSpanModelRequestEndEvent>.model_request_start_id",15035 "type": "string",15036 "required": true,15037 "description": "The id of the corresponding `span.model_request_start` event."15038 },15039 {15040 "name": "<BetaManagedAgentsSpanModelRequestEndEvent>.model_usage",15041 "type": "BetaManagedAgentsSpanModelUsage",15042 "required": true,15043 "description": "Token usage for a single model request."15044 },15045 {15046 "name": "<BetaManagedAgentsSpanModelRequestEndEvent>.processed_at",15047 "type": "string",15048 "required": true,15049 "description": "A timestamp in RFC 3339 format",15050 "constraints": {15051 "format": "date-time"15052 }15053 },15054 {15055 "name": "<BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent>",15056 "type": "BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent object",15057 "required": false,15058 "description": "Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events."15059 },15060 {15061 "name": "<BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent>.type",15062 "type": "\"span.outcome_evaluation_ongoing\"",15063 "required": true,15064 "description": ""15065 },15066 {15067 "name": "<BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent>.id",15068 "type": "string",15069 "required": true,15070 "description": "Unique identifier for this event."15071 },15072 {15073 "name": "<BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent>.iteration",15074 "type": "number",15075 "required": true,15076 "description": "0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`.",15077 "constraints": {15078 "format": "int32"15079 }15080 },15081 {15082 "name": "<BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent>.outcome_id",15083 "type": "string",15084 "required": true,15085 "description": "The `outc_` ID of the outcome being evaluated."15086 },15087 {15088 "name": "<BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent>.processed_at",15089 "type": "string",15090 "required": true,15091 "description": "A timestamp in RFC 3339 format",15092 "constraints": {15093 "format": "date-time"15094 }15095 },15096 {15097 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>",15098 "type": "BetaManagedAgentsUserDefineOutcomeEvent object",15099 "required": false,15100 "description": "Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference."15101 },15102 {15103 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>.type",15104 "type": "\"user.define_outcome\"",15105 "required": true,15106 "description": ""15107 },15108 {15109 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>.id",15110 "type": "string",15111 "required": true,15112 "description": "Unique identifier for this event."15113 },15114 {15115 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>.description",15116 "type": "string",15117 "required": true,15118 "description": "What the agent should produce. Copied from the input event."15119 },15120 {15121 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>.max_iterations",15122 "type": "number or null",15123 "required": true,15124 "description": "Evaluate-then-revise cycles before giving up. Default 3, max 20.",15125 "constraints": {15126 "format": "int32"15127 }15128 },15129 {15130 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>.outcome_id",15131 "type": "string",15132 "required": true,15133 "description": "Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list."15134 },15135 {15136 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>.processed_at",15137 "type": "string",15138 "required": true,15139 "description": "A timestamp in RFC 3339 format",15140 "constraints": {15141 "format": "date-time"15142 }15143 },15144 {15145 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>.rubric",15146 "type": "BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric",15147 "required": true,15148 "description": "Rubric for grading the quality of an outcome."15149 },15150 {15151 "name": "<BetaManagedAgentsSessionDeletedEvent>",15152 "type": "BetaManagedAgentsSessionDeletedEvent object",15153 "required": false,15154 "description": "Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session."15155 },15156 {15157 "name": "<BetaManagedAgentsSessionDeletedEvent>.type",15158 "type": "\"session.deleted\"",15159 "required": true,15160 "description": ""15161 },15162 {15163 "name": "<BetaManagedAgentsSessionDeletedEvent>.id",15164 "type": "string",15165 "required": true,15166 "description": "Unique identifier for this event."15167 },15168 {15169 "name": "<BetaManagedAgentsSessionDeletedEvent>.processed_at",15170 "type": "string",15171 "required": true,15172 "description": "A timestamp in RFC 3339 format",15173 "constraints": {15174 "format": "date-time"15175 }15176 },15177 {15178 "name": "<BetaManagedAgentsSessionThreadStatusRunningEvent>",15179 "type": "BetaManagedAgentsSessionThreadStatusRunningEvent object",15180 "required": false,15181 "description": "A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads."15182 },15183 {15184 "name": "<BetaManagedAgentsSessionThreadStatusRunningEvent>.type",15185 "type": "\"session.thread_status_running\"",15186 "required": true,15187 "description": ""15188 },15189 {15190 "name": "<BetaManagedAgentsSessionThreadStatusRunningEvent>.id",15191 "type": "string",15192 "required": true,15193 "description": "Unique identifier for this event."15194 },15195 {15196 "name": "<BetaManagedAgentsSessionThreadStatusRunningEvent>.agent_name",15197 "type": "string",15198 "required": true,15199 "description": "Name of the agent the thread runs."15200 },15201 {15202 "name": "<BetaManagedAgentsSessionThreadStatusRunningEvent>.processed_at",15203 "type": "string",15204 "required": true,15205 "description": "A timestamp in RFC 3339 format",15206 "constraints": {15207 "format": "date-time"15208 }15209 },15210 {15211 "name": "<BetaManagedAgentsSessionThreadStatusRunningEvent>.session_thread_id",15212 "type": "string",15213 "required": true,15214 "description": "Public sthr_ ID of the thread that started running."15215 },15216 {15217 "name": "<BetaManagedAgentsSessionThreadStatusIdleEvent>",15218 "type": "BetaManagedAgentsSessionThreadStatusIdleEvent object",15219 "required": false,15220 "description": "A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads."15221 },15222 {15223 "name": "<BetaManagedAgentsSessionThreadStatusIdleEvent>.type",15224 "type": "\"session.thread_status_idle\"",15225 "required": true,15226 "description": ""15227 },15228 {15229 "name": "<BetaManagedAgentsSessionThreadStatusIdleEvent>.id",15230 "type": "string",15231 "required": true,15232 "description": "Unique identifier for this event."15233 },15234 {15235 "name": "<BetaManagedAgentsSessionThreadStatusIdleEvent>.agent_name",15236 "type": "string",15237 "required": true,15238 "description": "Name of the agent the thread runs."15239 },15240 {15241 "name": "<BetaManagedAgentsSessionThreadStatusIdleEvent>.processed_at",15242 "type": "string",15243 "required": true,15244 "description": "A timestamp in RFC 3339 format",15245 "constraints": {15246 "format": "date-time"15247 }15248 },15249 {15250 "name": "<BetaManagedAgentsSessionThreadStatusIdleEvent>.session_thread_id",15251 "type": "string",15252 "required": true,15253 "description": "Public sthr_ ID of the thread that went idle."15254 },15255 {15256 "name": "<BetaManagedAgentsSessionThreadStatusIdleEvent>.stop_reason",15257 "type": "BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted or BetaManagedAgentsSessionBudgetReached",15258 "required": true,15259 "description": ""15260 },15261 {15262 "name": "<BetaManagedAgentsSessionThreadStatusTerminatedEvent>",15263 "type": "BetaManagedAgentsSessionThreadStatusTerminatedEvent object",15264 "required": false,15265 "description": "A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads."15266 },15267 {15268 "name": "<BetaManagedAgentsSessionThreadStatusTerminatedEvent>.type",15269 "type": "\"session.thread_status_terminated\"",15270 "required": true,15271 "description": ""15272 },15273 {15274 "name": "<BetaManagedAgentsSessionThreadStatusTerminatedEvent>.id",15275 "type": "string",15276 "required": true,15277 "description": "Unique identifier for this event."15278 },15279 {15280 "name": "<BetaManagedAgentsSessionThreadStatusTerminatedEvent>.agent_name",15281 "type": "string",15282 "required": true,15283 "description": "Name of the agent the thread runs."15284 },15285 {15286 "name": "<BetaManagedAgentsSessionThreadStatusTerminatedEvent>.processed_at",15287 "type": "string",15288 "required": true,15289 "description": "A timestamp in RFC 3339 format",15290 "constraints": {15291 "format": "date-time"15292 }15293 },15294 {15295 "name": "<BetaManagedAgentsSessionThreadStatusTerminatedEvent>.session_thread_id",15296 "type": "string",15297 "required": true,15298 "description": "Public sthr_ ID of the thread that terminated."15299 },15300 {15301 "name": "<BetaManagedAgentsUserToolResultEvent>",15302 "type": "BetaManagedAgentsUserToolResultEvent object",15303 "required": false,15304 "description": "Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server."15305 },15306 {15307 "name": "<BetaManagedAgentsUserToolResultEvent>.type",15308 "type": "\"user.tool_result\"",15309 "required": true,15310 "description": ""15311 },15312 {15313 "name": "<BetaManagedAgentsUserToolResultEvent>.id",15314 "type": "string",15315 "required": true,15316 "description": "Unique identifier for this event."15317 },15318 {15319 "name": "<BetaManagedAgentsUserToolResultEvent>.tool_use_id",15320 "type": "string",15321 "required": true,15322 "description": "The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field."15323 },15324 {15325 "name": "<BetaManagedAgentsUserToolResultEvent>.content",15326 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock",15327 "required": false,15328 "description": "The result content returned by the tool."15329 },15330 {15331 "name": "<BetaManagedAgentsUserToolResultEvent>.is_error",15332 "type": "boolean or null",15333 "required": false,15334 "description": "Whether the tool execution resulted in an error."15335 },15336 {15337 "name": "<BetaManagedAgentsUserToolResultEvent>.processed_at",15338 "type": "string or null",15339 "required": false,15340 "description": "A timestamp in RFC 3339 format",15341 "constraints": {15342 "format": "date-time"15343 }15344 },15345 {15346 "name": "<BetaManagedAgentsUserToolResultEvent>.session_thread_id",15347 "type": "string or null",15348 "required": false,15349 "description": "Set by the server to the subagent thread this result was routed to. Omitted when it was routed to the primary thread."15350 },15351 {15352 "name": "<BetaManagedAgentsSessionThreadStatusRescheduledEvent>",15353 "type": "BetaManagedAgentsSessionThreadStatusRescheduledEvent object",15354 "required": false,15355 "description": "A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads."15356 },15357 {15358 "name": "<BetaManagedAgentsSessionThreadStatusRescheduledEvent>.type",15359 "type": "\"session.thread_status_rescheduled\"",15360 "required": true,15361 "description": ""15362 },15363 {15364 "name": "<BetaManagedAgentsSessionThreadStatusRescheduledEvent>.id",15365 "type": "string",15366 "required": true,15367 "description": "Unique identifier for this event."15368 },15369 {15370 "name": "<BetaManagedAgentsSessionThreadStatusRescheduledEvent>.agent_name",15371 "type": "string",15372 "required": true,15373 "description": "Name of the agent the thread runs."15374 },15375 {15376 "name": "<BetaManagedAgentsSessionThreadStatusRescheduledEvent>.processed_at",15377 "type": "string",15378 "required": true,15379 "description": "A timestamp in RFC 3339 format",15380 "constraints": {15381 "format": "date-time"15382 }15383 },15384 {15385 "name": "<BetaManagedAgentsSessionThreadStatusRescheduledEvent>.session_thread_id",15386 "type": "string",15387 "required": true,15388 "description": "Public sthr_ ID of the thread that is retrying."15389 },15390 {15391 "name": "<BetaManagedAgentsSessionUpdatedEvent>",15392 "type": "BetaManagedAgentsSessionUpdatedEvent object",15393 "required": false,15394 "description": "Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn."15395 },15396 {15397 "name": "<BetaManagedAgentsSessionUpdatedEvent>.type",15398 "type": "\"session.updated\"",15399 "required": true,15400 "description": ""15401 },15402 {15403 "name": "<BetaManagedAgentsSessionUpdatedEvent>.id",15404 "type": "string",15405 "required": true,15406 "description": "Unique identifier for this event."15407 },15408 {15409 "name": "<BetaManagedAgentsSessionUpdatedEvent>.processed_at",15410 "type": "string",15411 "required": true,15412 "description": "A timestamp in RFC 3339 format",15413 "constraints": {15414 "format": "date-time"15415 }15416 },15417 {15418 "name": "<BetaManagedAgentsSessionUpdatedEvent>.agent",15419 "type": "BetaManagedAgentsSessionAgent or null",15420 "required": false,15421 "description": "Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time."15422 },15423 {15424 "name": "<BetaManagedAgentsSessionUpdatedEvent>.budget",15425 "type": "BetaManagedAgentsBudgetLimit or null",15426 "required": false,15427 "description": "A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`."15428 },15429 {15430 "name": "<BetaManagedAgentsSessionUpdatedEvent>.metadata",15431 "type": "map[string]",15432 "required": false,15433 "description": "The session's full metadata bag after the update. Present when the update set non-empty metadata; absent when metadata was unchanged or cleared to empty."15434 },15435 {15436 "name": "<BetaManagedAgentsSessionUpdatedEvent>.title",15437 "type": "string or null",15438 "required": false,15439 "description": "The session's new title. Present only when the update changed it."15440 },15441 {15442 "name": "<BetaManagedAgentsSystemMessageEvent>",15443 "type": "BetaManagedAgentsSystemMessageEvent object",15444 "required": false,15445 "description": "A mid-conversation system message event. Carries system-role content that is appended to the session as a `role: \"system\"` turn."15446 },15447 {15448 "name": "<BetaManagedAgentsSystemMessageEvent>.type",15449 "type": "\"system.message\"",15450 "required": true,15451 "description": ""15452 },15453 {15454 "name": "<BetaManagedAgentsSystemMessageEvent>.id",15455 "type": "string",15456 "required": true,15457 "description": "Unique identifier for this event."15458 },15459 {15460 "name": "<BetaManagedAgentsSystemMessageEvent>.content",15461 "type": "array of BetaManagedAgentsSystemContentBlock",15462 "required": true,15463 "description": "System content blocks. Text-only."15464 },15465 {15466 "name": "<BetaManagedAgentsSystemMessageEvent>.processed_at",15467 "type": "string or null",15468 "required": false,15469 "description": "A timestamp in RFC 3339 format",15470 "constraints": {15471 "format": "date-time"15472 }15473 },15474 {15475 "name": "<BetaManagedAgentsSessionUsageEvent>",15476 "type": "BetaManagedAgentsSessionUsageEvent object",15477 "required": false,15478 "description": "Periodic snapshot of the session's cumulative usage and tracked list cost."15479 },15480 {15481 "name": "<BetaManagedAgentsSessionUsageEvent>.type",15482 "type": "\"session.usage\"",15483 "required": true,15484 "description": ""15485 },15486 {15487 "name": "<BetaManagedAgentsSessionUsageEvent>.id",15488 "type": "string",15489 "required": true,15490 "description": "Unique identifier for this event."15491 },15492 {15493 "name": "<BetaManagedAgentsSessionUsageEvent>.processed_at",15494 "type": "string",15495 "required": true,15496 "description": "A timestamp in RFC 3339 format",15497 "constraints": {15498 "format": "date-time"15499 }15500 },15501 {15502 "name": "<BetaManagedAgentsSessionUsageEvent>.usage",15503 "type": "BetaManagedAgentsSessionUsageSnapshot",15504 "required": true,15505 "description": "Point-in-time snapshot of a session's cumulative usage."15506 },15507 {15508 "name": "<BetaManagedAgentsSessionUsageEvent>.budget",15509 "type": "BetaManagedAgentsBudgetLimit or null",15510 "required": false,15511 "description": "A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`."15512 }15513 ],15514 "status": [15515 "DOCUMENTED",15516 "BETA"15517 ],15518 "sources": [15519 {15520 "url": "https://platform.claude.com/docs/en/api/beta/sessions/events/list",15521 "retrieved_at": "2026-09-18"15522 },15523 {15524 "url": "https://platform.claude.com/docs/en/managed-agents/events-and-streaming",15525 "retrieved_at": "2026-09-18"15526 },15527 {15528 "url": "https://platform.claude.com/docs/en/managed-agents/reference",15529 "retrieved_at": "2026-09-18"15530 }15531 ],15532 "beta_header": "managed-agents-2026-04-01"15533 },15534 {15535 "provider": "anthropic",15536 "api_family": "managed-agents",15537 "name": "StreamSessionEvents (SSE union incl. event_start/event_delta)",15538 "official_type_name": "BetaManagedAgentsStreamSessionEvents",15539 "description": "Server-sent event in the session stream.",15540 "fields": [15541 {15542 "name": "<BetaManagedAgentsUserMessageEvent>",15543 "type": "BetaManagedAgentsUserMessageEvent object",15544 "required": false,15545 "description": "A user message event in the session conversation."15546 },15547 {15548 "name": "<BetaManagedAgentsUserMessageEvent>.type",15549 "type": "\"user.message\"",15550 "required": true,15551 "description": ""15552 },15553 {15554 "name": "<BetaManagedAgentsUserMessageEvent>.id",15555 "type": "string",15556 "required": true,15557 "description": "Unique identifier for this event."15558 },15559 {15560 "name": "<BetaManagedAgentsUserMessageEvent>.content",15561 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock",15562 "required": true,15563 "description": "Array of content blocks comprising the user message."15564 },15565 {15566 "name": "<BetaManagedAgentsUserMessageEvent>.processed_at",15567 "type": "string or null",15568 "required": false,15569 "description": "A timestamp in RFC 3339 format",15570 "constraints": {15571 "format": "date-time"15572 }15573 },15574 {15575 "name": "<BetaManagedAgentsUserInterruptEvent>",15576 "type": "BetaManagedAgentsUserInterruptEvent object",15577 "required": false,15578 "description": "An interrupt event that pauses agent execution and returns control to the user."15579 },15580 {15581 "name": "<BetaManagedAgentsUserInterruptEvent>.type",15582 "type": "\"user.interrupt\"",15583 "required": true,15584 "description": ""15585 },15586 {15587 "name": "<BetaManagedAgentsUserInterruptEvent>.id",15588 "type": "string",15589 "required": true,15590 "description": "Unique identifier for this event."15591 },15592 {15593 "name": "<BetaManagedAgentsUserInterruptEvent>.processed_at",15594 "type": "string or null",15595 "required": false,15596 "description": "A timestamp in RFC 3339 format",15597 "constraints": {15598 "format": "date-time"15599 }15600 },15601 {15602 "name": "<BetaManagedAgentsUserInterruptEvent>.session_thread_id",15603 "type": "string or null",15604 "required": false,15605 "description": "If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread."15606 },15607 {15608 "name": "<BetaManagedAgentsUserToolConfirmationEvent>",15609 "type": "BetaManagedAgentsUserToolConfirmationEvent object",15610 "required": false,15611 "description": "A tool confirmation event that approves or denies a pending tool execution."15612 },15613 {15614 "name": "<BetaManagedAgentsUserToolConfirmationEvent>.type",15615 "type": "\"user.tool_confirmation\"",15616 "required": true,15617 "description": ""15618 },15619 {15620 "name": "<BetaManagedAgentsUserToolConfirmationEvent>.id",15621 "type": "string",15622 "required": true,15623 "description": "Unique identifier for this event."15624 },15625 {15626 "name": "<BetaManagedAgentsUserToolConfirmationEvent>.result",15627 "type": "\"allow\" or \"deny\"",15628 "required": true,15629 "description": "UserToolConfirmationResult enum",15630 "enum": [15631 "allow",15632 "deny"15633 ]15634 },15635 {15636 "name": "<BetaManagedAgentsUserToolConfirmationEvent>.tool_use_id",15637 "type": "string",15638 "required": true,15639 "description": "The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field."15640 },15641 {15642 "name": "<BetaManagedAgentsUserToolConfirmationEvent>.deny_message",15643 "type": "string or null",15644 "required": false,15645 "description": "Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'.",15646 "constraints": {15647 "maxLength": "10000"15648 }15649 },15650 {15651 "name": "<BetaManagedAgentsUserToolConfirmationEvent>.processed_at",15652 "type": "string or null",15653 "required": false,15654 "description": "A timestamp in RFC 3339 format",15655 "constraints": {15656 "format": "date-time"15657 }15658 },15659 {15660 "name": "<BetaManagedAgentsUserToolConfirmationEvent>.session_thread_id",15661 "type": "string or null",15662 "required": false,15663 "description": "Set by the server to the subagent thread this confirmation was routed to. Omitted when it was routed to the primary thread."15664 },15665 {15666 "name": "<BetaManagedAgentsUserCustomToolResultEvent>",15667 "type": "BetaManagedAgentsUserCustomToolResultEvent object",15668 "required": false,15669 "description": "Event sent by the client providing the result of a custom tool execution."15670 },15671 {15672 "name": "<BetaManagedAgentsUserCustomToolResultEvent>.type",15673 "type": "\"user.custom_tool_result\"",15674 "required": true,15675 "description": ""15676 },15677 {15678 "name": "<BetaManagedAgentsUserCustomToolResultEvent>.id",15679 "type": "string",15680 "required": true,15681 "description": "Unique identifier for this event."15682 },15683 {15684 "name": "<BetaManagedAgentsUserCustomToolResultEvent>.custom_tool_use_id",15685 "type": "string",15686 "required": true,15687 "description": "The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field."15688 },15689 {15690 "name": "<BetaManagedAgentsUserCustomToolResultEvent>.content",15691 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock",15692 "required": false,15693 "description": "The result content returned by the tool."15694 },15695 {15696 "name": "<BetaManagedAgentsUserCustomToolResultEvent>.is_error",15697 "type": "boolean or null",15698 "required": false,15699 "description": "Whether the tool execution resulted in an error."15700 },15701 {15702 "name": "<BetaManagedAgentsUserCustomToolResultEvent>.processed_at",15703 "type": "string or null",15704 "required": false,15705 "description": "A timestamp in RFC 3339 format",15706 "constraints": {15707 "format": "date-time"15708 }15709 },15710 {15711 "name": "<BetaManagedAgentsUserCustomToolResultEvent>.session_thread_id",15712 "type": "string or null",15713 "required": false,15714 "description": "Set by the server to the subagent thread this result was routed to. Omitted when it was routed to the primary thread."15715 },15716 {15717 "name": "<BetaManagedAgentsAgentCustomToolUseEvent>",15718 "type": "BetaManagedAgentsAgentCustomToolUseEvent object",15719 "required": false,15720 "description": "Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result."15721 },15722 {15723 "name": "<BetaManagedAgentsAgentCustomToolUseEvent>.type",15724 "type": "\"agent.custom_tool_use\"",15725 "required": true,15726 "description": ""15727 },15728 {15729 "name": "<BetaManagedAgentsAgentCustomToolUseEvent>.id",15730 "type": "string",15731 "required": true,15732 "description": "Unique identifier for this event."15733 },15734 {15735 "name": "<BetaManagedAgentsAgentCustomToolUseEvent>.input",15736 "type": "map[unknown]",15737 "required": true,15738 "description": "Input parameters for the tool call."15739 },15740 {15741 "name": "<BetaManagedAgentsAgentCustomToolUseEvent>.name",15742 "type": "string",15743 "required": true,15744 "description": "Name of the custom tool being called."15745 },15746 {15747 "name": "<BetaManagedAgentsAgentCustomToolUseEvent>.processed_at",15748 "type": "string",15749 "required": true,15750 "description": "A timestamp in RFC 3339 format",15751 "constraints": {15752 "format": "date-time"15753 }15754 },15755 {15756 "name": "<BetaManagedAgentsAgentCustomToolUseEvent>.session_thread_id",15757 "type": "string or null",15758 "required": false,15759 "description": "When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Informational only: the server routes the matching `user.custom_tool_result` by `custom_tool_use_id`, so clients do not send it back."15760 },15761 {15762 "name": "<BetaManagedAgentsAgentMessageEvent>",15763 "type": "BetaManagedAgentsAgentMessageEvent object",15764 "required": false,15765 "description": "An agent response event in the session conversation."15766 },15767 {15768 "name": "<BetaManagedAgentsAgentMessageEvent>.type",15769 "type": "\"agent.message\"",15770 "required": true,15771 "description": ""15772 },15773 {15774 "name": "<BetaManagedAgentsAgentMessageEvent>.id",15775 "type": "string",15776 "required": true,15777 "description": "Unique identifier for this event."15778 },15779 {15780 "name": "<BetaManagedAgentsAgentMessageEvent>.content",15781 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsRedactedBlock",15782 "required": true,15783 "description": "Array of text blocks comprising the agent response."15784 },15785 {15786 "name": "<BetaManagedAgentsAgentMessageEvent>.processed_at",15787 "type": "string",15788 "required": true,15789 "description": "A timestamp in RFC 3339 format",15790 "constraints": {15791 "format": "date-time"15792 }15793 },15794 {15795 "name": "<BetaManagedAgentsAgentThinkingEvent>",15796 "type": "BetaManagedAgentsAgentThinkingEvent object",15797 "required": false,15798 "description": "Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier."15799 },15800 {15801 "name": "<BetaManagedAgentsAgentThinkingEvent>.type",15802 "type": "\"agent.thinking\"",15803 "required": true,15804 "description": ""15805 },15806 {15807 "name": "<BetaManagedAgentsAgentThinkingEvent>.id",15808 "type": "string",15809 "required": true,15810 "description": "Unique identifier for this event."15811 },15812 {15813 "name": "<BetaManagedAgentsAgentThinkingEvent>.processed_at",15814 "type": "string",15815 "required": true,15816 "description": "A timestamp in RFC 3339 format",15817 "constraints": {15818 "format": "date-time"15819 }15820 },15821 {15822 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>",15823 "type": "BetaManagedAgentsAgentMCPToolUseEvent object",15824 "required": false,15825 "description": "Event emitted when the agent invokes a tool provided by an MCP server."15826 },15827 {15828 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.type",15829 "type": "\"agent.mcp_tool_use\"",15830 "required": true,15831 "description": ""15832 },15833 {15834 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.id",15835 "type": "string",15836 "required": true,15837 "description": "Unique identifier for this event."15838 },15839 {15840 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.input",15841 "type": "map[unknown]",15842 "required": true,15843 "description": "Input parameters for the tool call."15844 },15845 {15846 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.mcp_server_name",15847 "type": "string",15848 "required": true,15849 "description": "Name of the MCP server providing the tool."15850 },15851 {15852 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.name",15853 "type": "string",15854 "required": true,15855 "description": "Name of the MCP tool being used."15856 },15857 {15858 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.processed_at",15859 "type": "string",15860 "required": true,15861 "description": "A timestamp in RFC 3339 format",15862 "constraints": {15863 "format": "date-time"15864 }15865 },15866 {15867 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.evaluated_permission",15868 "type": "\"allow\" or \"ask\" or \"deny\"",15869 "required": false,15870 "description": "AgentEvaluatedPermission enum",15871 "enum": [15872 "allow",15873 "ask",15874 "deny"15875 ]15876 },15877 {15878 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.evaluation",15879 "type": "BetaManagedAgentsAgentToolEvaluation",15880 "required": false,15881 "description": "Names the resolved permission_policy that produced evaluated_permission, and under auto carries the judgement. Open union: clients must tolerate unknown variants."15882 },15883 {15884 "name": "<BetaManagedAgentsAgentMCPToolUseEvent>.session_thread_id",15885 "type": "string or null",15886 "required": false,15887 "description": "When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Informational only: the server routes the matching `user.tool_confirmation` by `tool_use_id`, so clients do not send it back."15888 },15889 {15890 "name": "<BetaManagedAgentsAgentMCPToolResultEvent>",15891 "type": "BetaManagedAgentsAgentMCPToolResultEvent object",15892 "required": false,15893 "description": "Event representing the result of an MCP tool execution."15894 },15895 {15896 "name": "<BetaManagedAgentsAgentMCPToolResultEvent>.type",15897 "type": "\"agent.mcp_tool_result\"",15898 "required": true,15899 "description": ""15900 },15901 {15902 "name": "<BetaManagedAgentsAgentMCPToolResultEvent>.id",15903 "type": "string",15904 "required": true,15905 "description": "Unique identifier for this event."15906 },15907 {15908 "name": "<BetaManagedAgentsAgentMCPToolResultEvent>.mcp_tool_use_id",15909 "type": "string",15910 "required": true,15911 "description": "The id of the `agent.mcp_tool_use` event this result corresponds to."15912 },15913 {15914 "name": "<BetaManagedAgentsAgentMCPToolResultEvent>.processed_at",15915 "type": "string",15916 "required": true,15917 "description": "A timestamp in RFC 3339 format",15918 "constraints": {15919 "format": "date-time"15920 }15921 },15922 {15923 "name": "<BetaManagedAgentsAgentMCPToolResultEvent>.content",15924 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock",15925 "required": false,15926 "description": "The result content returned by the tool."15927 },15928 {15929 "name": "<BetaManagedAgentsAgentMCPToolResultEvent>.is_error",15930 "type": "boolean or null",15931 "required": false,15932 "description": "Whether the tool execution resulted in an error."15933 },15934 {15935 "name": "<BetaManagedAgentsAgentToolUseEvent>",15936 "type": "BetaManagedAgentsAgentToolUseEvent object",15937 "required": false,15938 "description": "Event emitted when the agent invokes a built-in agent tool."15939 },15940 {15941 "name": "<BetaManagedAgentsAgentToolUseEvent>.type",15942 "type": "\"agent.tool_use\"",15943 "required": true,15944 "description": ""15945 },15946 {15947 "name": "<BetaManagedAgentsAgentToolUseEvent>.id",15948 "type": "string",15949 "required": true,15950 "description": "Unique identifier for this event."15951 },15952 {15953 "name": "<BetaManagedAgentsAgentToolUseEvent>.input",15954 "type": "map[unknown]",15955 "required": true,15956 "description": "Input parameters for the tool call."15957 },15958 {15959 "name": "<BetaManagedAgentsAgentToolUseEvent>.name",15960 "type": "string",15961 "required": true,15962 "description": "Name of the agent tool being used."15963 },15964 {15965 "name": "<BetaManagedAgentsAgentToolUseEvent>.processed_at",15966 "type": "string",15967 "required": true,15968 "description": "A timestamp in RFC 3339 format",15969 "constraints": {15970 "format": "date-time"15971 }15972 },15973 {15974 "name": "<BetaManagedAgentsAgentToolUseEvent>.evaluated_permission",15975 "type": "\"allow\" or \"ask\" or \"deny\"",15976 "required": false,15977 "description": "AgentEvaluatedPermission enum",15978 "enum": [15979 "allow",15980 "ask",15981 "deny"15982 ]15983 },15984 {15985 "name": "<BetaManagedAgentsAgentToolUseEvent>.evaluation",15986 "type": "BetaManagedAgentsAgentToolEvaluation",15987 "required": false,15988 "description": "Names the resolved permission_policy that produced evaluated_permission, and under auto carries the judgement. Open union: clients must tolerate unknown variants."15989 },15990 {15991 "name": "<BetaManagedAgentsAgentToolUseEvent>.session_thread_id",15992 "type": "string or null",15993 "required": false,15994 "description": "When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Informational only: the server routes the matching `user.tool_confirmation` or `user.tool_result` by `tool_use_id`, so clients do not send it back."15995 },15996 {15997 "name": "<BetaManagedAgentsAgentToolResultEvent>",15998 "type": "BetaManagedAgentsAgentToolResultEvent object",15999 "required": false,16000 "description": "Event representing the result of an agent tool execution."16001 },16002 {16003 "name": "<BetaManagedAgentsAgentToolResultEvent>.type",16004 "type": "\"agent.tool_result\"",16005 "required": true,16006 "description": ""16007 },16008 {16009 "name": "<BetaManagedAgentsAgentToolResultEvent>.id",16010 "type": "string",16011 "required": true,16012 "description": "Unique identifier for this event."16013 },16014 {16015 "name": "<BetaManagedAgentsAgentToolResultEvent>.processed_at",16016 "type": "string",16017 "required": true,16018 "description": "A timestamp in RFC 3339 format",16019 "constraints": {16020 "format": "date-time"16021 }16022 },16023 {16024 "name": "<BetaManagedAgentsAgentToolResultEvent>.tool_use_id",16025 "type": "string",16026 "required": true,16027 "description": "The id of the `agent.tool_use` event this result corresponds to."16028 },16029 {16030 "name": "<BetaManagedAgentsAgentToolResultEvent>.content",16031 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock",16032 "required": false,16033 "description": "The result content returned by the tool."16034 },16035 {16036 "name": "<BetaManagedAgentsAgentToolResultEvent>.is_error",16037 "type": "boolean or null",16038 "required": false,16039 "description": "Whether the tool execution resulted in an error."16040 },16041 {16042 "name": "<BetaManagedAgentsAgentThreadMessageReceivedEvent>",16043 "type": "BetaManagedAgentsAgentThreadMessageReceivedEvent object",16044 "required": false,16045 "description": "Delivery event written to the target thread's input stream when an agent-to-agent message arrives."16046 },16047 {16048 "name": "<BetaManagedAgentsAgentThreadMessageReceivedEvent>.type",16049 "type": "\"agent.thread_message_received\"",16050 "required": true,16051 "description": ""16052 },16053 {16054 "name": "<BetaManagedAgentsAgentThreadMessageReceivedEvent>.id",16055 "type": "string",16056 "required": true,16057 "description": "Unique identifier for this event."16058 },16059 {16060 "name": "<BetaManagedAgentsAgentThreadMessageReceivedEvent>.content",16061 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock",16062 "required": true,16063 "description": "Message content blocks."16064 },16065 {16066 "name": "<BetaManagedAgentsAgentThreadMessageReceivedEvent>.from_session_thread_id",16067 "type": "string",16068 "required": true,16069 "description": "Public `sthr_` ID of the thread that sent the message."16070 },16071 {16072 "name": "<BetaManagedAgentsAgentThreadMessageReceivedEvent>.processed_at",16073 "type": "string",16074 "required": true,16075 "description": "A timestamp in RFC 3339 format",16076 "constraints": {16077 "format": "date-time"16078 }16079 },16080 {16081 "name": "<BetaManagedAgentsAgentThreadMessageReceivedEvent>.from_agent_name",16082 "type": "string or null",16083 "required": false,16084 "description": "Name of the callable agent this message came from. Absent when received from the primary agent."16085 },16086 {16087 "name": "<BetaManagedAgentsAgentThreadMessageSentEvent>",16088 "type": "BetaManagedAgentsAgentThreadMessageSentEvent object",16089 "required": false,16090 "description": "Observability event emitted to the sender's output stream when an agent-to-agent message is sent."16091 },16092 {16093 "name": "<BetaManagedAgentsAgentThreadMessageSentEvent>.type",16094 "type": "\"agent.thread_message_sent\"",16095 "required": true,16096 "description": ""16097 },16098 {16099 "name": "<BetaManagedAgentsAgentThreadMessageSentEvent>.id",16100 "type": "string",16101 "required": true,16102 "description": "Unique identifier for this event."16103 },16104 {16105 "name": "<BetaManagedAgentsAgentThreadMessageSentEvent>.content",16106 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock",16107 "required": true,16108 "description": "Message content blocks."16109 },16110 {16111 "name": "<BetaManagedAgentsAgentThreadMessageSentEvent>.processed_at",16112 "type": "string",16113 "required": true,16114 "description": "A timestamp in RFC 3339 format",16115 "constraints": {16116 "format": "date-time"16117 }16118 },16119 {16120 "name": "<BetaManagedAgentsAgentThreadMessageSentEvent>.to_session_thread_id",16121 "type": "string",16122 "required": true,16123 "description": "Public `sthr_` ID of the thread the message was sent to."16124 },16125 {16126 "name": "<BetaManagedAgentsAgentThreadMessageSentEvent>.to_agent_name",16127 "type": "string or null",16128 "required": false,16129 "description": "Name of the callable agent this message was sent to. Absent when sent to the primary agent."16130 },16131 {16132 "name": "<BetaManagedAgentsAgentThreadContextCompactedEvent>",16133 "type": "BetaManagedAgentsAgentThreadContextCompactedEvent object",16134 "required": false,16135 "description": "Indicates that context compaction (summarization) occurred during the session."16136 },16137 {16138 "name": "<BetaManagedAgentsAgentThreadContextCompactedEvent>.type",16139 "type": "\"agent.thread_context_compacted\"",16140 "required": true,16141 "description": ""16142 },16143 {16144 "name": "<BetaManagedAgentsAgentThreadContextCompactedEvent>.id",16145 "type": "string",16146 "required": true,16147 "description": "Unique identifier for this event."16148 },16149 {16150 "name": "<BetaManagedAgentsAgentThreadContextCompactedEvent>.processed_at",16151 "type": "string",16152 "required": true,16153 "description": "A timestamp in RFC 3339 format",16154 "constraints": {16155 "format": "date-time"16156 }16157 },16158 {16159 "name": "<BetaManagedAgentsSessionErrorEvent>",16160 "type": "BetaManagedAgentsSessionErrorEvent object",16161 "required": false,16162 "description": "An error event indicating a problem occurred during session execution."16163 },16164 {16165 "name": "<BetaManagedAgentsSessionErrorEvent>.type",16166 "type": "\"session.error\"",16167 "required": true,16168 "description": ""16169 },16170 {16171 "name": "<BetaManagedAgentsSessionErrorEvent>.id",16172 "type": "string",16173 "required": true,16174 "description": "Unique identifier for this event."16175 },16176 {16177 "name": "<BetaManagedAgentsSessionErrorEvent>.error",16178 "type": "BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 5 more",16179 "required": true,16180 "description": ""16181 },16182 {16183 "name": "<BetaManagedAgentsSessionErrorEvent>.processed_at",16184 "type": "string",16185 "required": true,16186 "description": "A timestamp in RFC 3339 format",16187 "constraints": {16188 "format": "date-time"16189 }16190 },16191 {16192 "name": "<BetaManagedAgentsSessionStatusRescheduledEvent>",16193 "type": "BetaManagedAgentsSessionStatusRescheduledEvent object",16194 "required": false,16195 "description": "Indicates the session is recovering from an error state and is rescheduled for execution."16196 },16197 {16198 "name": "<BetaManagedAgentsSessionStatusRescheduledEvent>.type",16199 "type": "\"session.status_rescheduled\"",16200 "required": true,16201 "description": ""16202 },16203 {16204 "name": "<BetaManagedAgentsSessionStatusRescheduledEvent>.id",16205 "type": "string",16206 "required": true,16207 "description": "Unique identifier for this event."16208 },16209 {16210 "name": "<BetaManagedAgentsSessionStatusRescheduledEvent>.processed_at",16211 "type": "string",16212 "required": true,16213 "description": "A timestamp in RFC 3339 format",16214 "constraints": {16215 "format": "date-time"16216 }16217 },16218 {16219 "name": "<BetaManagedAgentsSessionStatusRunningEvent>",16220 "type": "BetaManagedAgentsSessionStatusRunningEvent object",16221 "required": false,16222 "description": "Indicates the session is actively running and the agent is working."16223 },16224 {16225 "name": "<BetaManagedAgentsSessionStatusRunningEvent>.type",16226 "type": "\"session.status_running\"",16227 "required": true,16228 "description": ""16229 },16230 {16231 "name": "<BetaManagedAgentsSessionStatusRunningEvent>.id",16232 "type": "string",16233 "required": true,16234 "description": "Unique identifier for this event."16235 },16236 {16237 "name": "<BetaManagedAgentsSessionStatusRunningEvent>.processed_at",16238 "type": "string",16239 "required": true,16240 "description": "A timestamp in RFC 3339 format",16241 "constraints": {16242 "format": "date-time"16243 }16244 },16245 {16246 "name": "<BetaManagedAgentsSessionStatusIdleEvent>",16247 "type": "BetaManagedAgentsSessionStatusIdleEvent object",16248 "required": false,16249 "description": "Indicates the agent has paused and is awaiting user input."16250 },16251 {16252 "name": "<BetaManagedAgentsSessionStatusIdleEvent>.type",16253 "type": "\"session.status_idle\"",16254 "required": true,16255 "description": ""16256 },16257 {16258 "name": "<BetaManagedAgentsSessionStatusIdleEvent>.id",16259 "type": "string",16260 "required": true,16261 "description": "Unique identifier for this event."16262 },16263 {16264 "name": "<BetaManagedAgentsSessionStatusIdleEvent>.processed_at",16265 "type": "string",16266 "required": true,16267 "description": "A timestamp in RFC 3339 format",16268 "constraints": {16269 "format": "date-time"16270 }16271 },16272 {16273 "name": "<BetaManagedAgentsSessionStatusIdleEvent>.stop_reason",16274 "type": "BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted or BetaManagedAgentsSessionBudgetReached",16275 "required": true,16276 "description": ""16277 },16278 {16279 "name": "<BetaManagedAgentsSessionStatusTerminatedEvent>",16280 "type": "BetaManagedAgentsSessionStatusTerminatedEvent object",16281 "required": false,16282 "description": "Indicates the session has terminated, either due to an error or completion."16283 },16284 {16285 "name": "<BetaManagedAgentsSessionStatusTerminatedEvent>.type",16286 "type": "\"session.status_terminated\"",16287 "required": true,16288 "description": ""16289 },16290 {16291 "name": "<BetaManagedAgentsSessionStatusTerminatedEvent>.id",16292 "type": "string",16293 "required": true,16294 "description": "Unique identifier for this event."16295 },16296 {16297 "name": "<BetaManagedAgentsSessionStatusTerminatedEvent>.processed_at",16298 "type": "string",16299 "required": true,16300 "description": "A timestamp in RFC 3339 format",16301 "constraints": {16302 "format": "date-time"16303 }16304 },16305 {16306 "name": "<BetaManagedAgentsSessionThreadCreatedEvent>",16307 "type": "BetaManagedAgentsSessionThreadCreatedEvent object",16308 "required": false,16309 "description": "Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation."16310 },16311 {16312 "name": "<BetaManagedAgentsSessionThreadCreatedEvent>.type",16313 "type": "\"session.thread_created\"",16314 "required": true,16315 "description": ""16316 },16317 {16318 "name": "<BetaManagedAgentsSessionThreadCreatedEvent>.id",16319 "type": "string",16320 "required": true,16321 "description": "Unique identifier for this event."16322 },16323 {16324 "name": "<BetaManagedAgentsSessionThreadCreatedEvent>.agent_name",16325 "type": "string",16326 "required": true,16327 "description": "Name of the callable agent the thread runs."16328 },16329 {16330 "name": "<BetaManagedAgentsSessionThreadCreatedEvent>.processed_at",16331 "type": "string",16332 "required": true,16333 "description": "A timestamp in RFC 3339 format",16334 "constraints": {16335 "format": "date-time"16336 }16337 },16338 {16339 "name": "<BetaManagedAgentsSessionThreadCreatedEvent>.session_thread_id",16340 "type": "string",16341 "required": true,16342 "description": "Public `sthr_` ID of the newly created thread."16343 },16344 {16345 "name": "<BetaManagedAgentsSpanOutcomeEvaluationStartEvent>",16346 "type": "BetaManagedAgentsSpanOutcomeEvaluationStartEvent object",16347 "required": false,16348 "description": "Emitted when an outcome evaluation cycle begins."16349 },16350 {16351 "name": "<BetaManagedAgentsSpanOutcomeEvaluationStartEvent>.type",16352 "type": "\"span.outcome_evaluation_start\"",16353 "required": true,16354 "description": ""16355 },16356 {16357 "name": "<BetaManagedAgentsSpanOutcomeEvaluationStartEvent>.id",16358 "type": "string",16359 "required": true,16360 "description": "Unique identifier for this event."16361 },16362 {16363 "name": "<BetaManagedAgentsSpanOutcomeEvaluationStartEvent>.iteration",16364 "type": "number",16365 "required": true,16366 "description": "0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc.",16367 "constraints": {16368 "format": "int32"16369 }16370 },16371 {16372 "name": "<BetaManagedAgentsSpanOutcomeEvaluationStartEvent>.outcome_id",16373 "type": "string",16374 "required": true,16375 "description": "The `outc_` ID of the outcome being evaluated."16376 },16377 {16378 "name": "<BetaManagedAgentsSpanOutcomeEvaluationStartEvent>.processed_at",16379 "type": "string",16380 "required": true,16381 "description": "A timestamp in RFC 3339 format",16382 "constraints": {16383 "format": "date-time"16384 }16385 },16386 {16387 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>",16388 "type": "BetaManagedAgentsSpanOutcomeEvaluationEndEvent object",16389 "required": false,16390 "description": "Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow."16391 },16392 {16393 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.type",16394 "type": "\"span.outcome_evaluation_end\"",16395 "required": true,16396 "description": ""16397 },16398 {16399 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.id",16400 "type": "string",16401 "required": true,16402 "description": "Unique identifier for this event."16403 },16404 {16405 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.explanation",16406 "type": "string",16407 "required": true,16408 "description": "Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why."16409 },16410 {16411 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.iteration",16412 "type": "number",16413 "required": true,16414 "description": "0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`.",16415 "constraints": {16416 "format": "int32"16417 }16418 },16419 {16420 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.outcome_evaluation_start_id",16421 "type": "string",16422 "required": true,16423 "description": "The id of the corresponding `span.outcome_evaluation_start` event."16424 },16425 {16426 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.outcome_id",16427 "type": "string",16428 "required": true,16429 "description": "The `outc_` ID of the outcome being evaluated."16430 },16431 {16432 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.processed_at",16433 "type": "string",16434 "required": true,16435 "description": "A timestamp in RFC 3339 format",16436 "constraints": {16437 "format": "date-time"16438 }16439 },16440 {16441 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.result",16442 "type": "string",16443 "required": true,16444 "description": "Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress."16445 },16446 {16447 "name": "<BetaManagedAgentsSpanOutcomeEvaluationEndEvent>.usage",16448 "type": "BetaManagedAgentsSpanModelUsage",16449 "required": true,16450 "description": "Token usage for a single model request."16451 },16452 {16453 "name": "<BetaManagedAgentsSpanModelRequestStartEvent>",16454 "type": "BetaManagedAgentsSpanModelRequestStartEvent object",16455 "required": false,16456 "description": "Emitted when a model request is initiated by the agent."16457 },16458 {16459 "name": "<BetaManagedAgentsSpanModelRequestStartEvent>.type",16460 "type": "\"span.model_request_start\"",16461 "required": true,16462 "description": ""16463 },16464 {16465 "name": "<BetaManagedAgentsSpanModelRequestStartEvent>.id",16466 "type": "string",16467 "required": true,16468 "description": "Unique identifier for this event."16469 },16470 {16471 "name": "<BetaManagedAgentsSpanModelRequestStartEvent>.processed_at",16472 "type": "string",16473 "required": true,16474 "description": "A timestamp in RFC 3339 format",16475 "constraints": {16476 "format": "date-time"16477 }16478 },16479 {16480 "name": "<BetaManagedAgentsSpanModelRequestEndEvent>",16481 "type": "BetaManagedAgentsSpanModelRequestEndEvent object",16482 "required": false,16483 "description": "Emitted when a model request completes."16484 },16485 {16486 "name": "<BetaManagedAgentsSpanModelRequestEndEvent>.type",16487 "type": "\"span.model_request_end\"",16488 "required": true,16489 "description": ""16490 },16491 {16492 "name": "<BetaManagedAgentsSpanModelRequestEndEvent>.id",16493 "type": "string",16494 "required": true,16495 "description": "Unique identifier for this event."16496 },16497 {16498 "name": "<BetaManagedAgentsSpanModelRequestEndEvent>.is_error",16499 "type": "boolean or null",16500 "required": true,16501 "description": "Whether the model request resulted in an error."16502 },16503 {16504 "name": "<BetaManagedAgentsSpanModelRequestEndEvent>.model_request_start_id",16505 "type": "string",16506 "required": true,16507 "description": "The id of the corresponding `span.model_request_start` event."16508 },16509 {16510 "name": "<BetaManagedAgentsSpanModelRequestEndEvent>.model_usage",16511 "type": "BetaManagedAgentsSpanModelUsage",16512 "required": true,16513 "description": "Token usage for a single model request."16514 },16515 {16516 "name": "<BetaManagedAgentsSpanModelRequestEndEvent>.processed_at",16517 "type": "string",16518 "required": true,16519 "description": "A timestamp in RFC 3339 format",16520 "constraints": {16521 "format": "date-time"16522 }16523 },16524 {16525 "name": "<BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent>",16526 "type": "BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent object",16527 "required": false,16528 "description": "Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events."16529 },16530 {16531 "name": "<BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent>.type",16532 "type": "\"span.outcome_evaluation_ongoing\"",16533 "required": true,16534 "description": ""16535 },16536 {16537 "name": "<BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent>.id",16538 "type": "string",16539 "required": true,16540 "description": "Unique identifier for this event."16541 },16542 {16543 "name": "<BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent>.iteration",16544 "type": "number",16545 "required": true,16546 "description": "0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`.",16547 "constraints": {16548 "format": "int32"16549 }16550 },16551 {16552 "name": "<BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent>.outcome_id",16553 "type": "string",16554 "required": true,16555 "description": "The `outc_` ID of the outcome being evaluated."16556 },16557 {16558 "name": "<BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent>.processed_at",16559 "type": "string",16560 "required": true,16561 "description": "A timestamp in RFC 3339 format",16562 "constraints": {16563 "format": "date-time"16564 }16565 },16566 {16567 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>",16568 "type": "BetaManagedAgentsUserDefineOutcomeEvent object",16569 "required": false,16570 "description": "Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference."16571 },16572 {16573 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>.type",16574 "type": "\"user.define_outcome\"",16575 "required": true,16576 "description": ""16577 },16578 {16579 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>.id",16580 "type": "string",16581 "required": true,16582 "description": "Unique identifier for this event."16583 },16584 {16585 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>.description",16586 "type": "string",16587 "required": true,16588 "description": "What the agent should produce. Copied from the input event."16589 },16590 {16591 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>.max_iterations",16592 "type": "number or null",16593 "required": true,16594 "description": "Evaluate-then-revise cycles before giving up. Default 3, max 20.",16595 "constraints": {16596 "format": "int32"16597 }16598 },16599 {16600 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>.outcome_id",16601 "type": "string",16602 "required": true,16603 "description": "Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list."16604 },16605 {16606 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>.processed_at",16607 "type": "string",16608 "required": true,16609 "description": "A timestamp in RFC 3339 format",16610 "constraints": {16611 "format": "date-time"16612 }16613 },16614 {16615 "name": "<BetaManagedAgentsUserDefineOutcomeEvent>.rubric",16616 "type": "BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric",16617 "required": true,16618 "description": "Rubric for grading the quality of an outcome."16619 },16620 {16621 "name": "<BetaManagedAgentsSessionDeletedEvent>",16622 "type": "BetaManagedAgentsSessionDeletedEvent object",16623 "required": false,16624 "description": "Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session."16625 },16626 {16627 "name": "<BetaManagedAgentsSessionDeletedEvent>.type",16628 "type": "\"session.deleted\"",16629 "required": true,16630 "description": ""16631 },16632 {16633 "name": "<BetaManagedAgentsSessionDeletedEvent>.id",16634 "type": "string",16635 "required": true,16636 "description": "Unique identifier for this event."16637 },16638 {16639 "name": "<BetaManagedAgentsSessionDeletedEvent>.processed_at",16640 "type": "string",16641 "required": true,16642 "description": "A timestamp in RFC 3339 format",16643 "constraints": {16644 "format": "date-time"16645 }16646 },16647 {16648 "name": "<BetaManagedAgentsSessionThreadStatusRunningEvent>",16649 "type": "BetaManagedAgentsSessionThreadStatusRunningEvent object",16650 "required": false,16651 "description": "A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads."16652 },16653 {16654 "name": "<BetaManagedAgentsSessionThreadStatusRunningEvent>.type",16655 "type": "\"session.thread_status_running\"",16656 "required": true,16657 "description": ""16658 },16659 {16660 "name": "<BetaManagedAgentsSessionThreadStatusRunningEvent>.id",16661 "type": "string",16662 "required": true,16663 "description": "Unique identifier for this event."16664 },16665 {16666 "name": "<BetaManagedAgentsSessionThreadStatusRunningEvent>.agent_name",16667 "type": "string",16668 "required": true,16669 "description": "Name of the agent the thread runs."16670 },16671 {16672 "name": "<BetaManagedAgentsSessionThreadStatusRunningEvent>.processed_at",16673 "type": "string",16674 "required": true,16675 "description": "A timestamp in RFC 3339 format",16676 "constraints": {16677 "format": "date-time"16678 }16679 },16680 {16681 "name": "<BetaManagedAgentsSessionThreadStatusRunningEvent>.session_thread_id",16682 "type": "string",16683 "required": true,16684 "description": "Public sthr_ ID of the thread that started running."16685 },16686 {16687 "name": "<BetaManagedAgentsSessionThreadStatusIdleEvent>",16688 "type": "BetaManagedAgentsSessionThreadStatusIdleEvent object",16689 "required": false,16690 "description": "A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads."16691 },16692 {16693 "name": "<BetaManagedAgentsSessionThreadStatusIdleEvent>.type",16694 "type": "\"session.thread_status_idle\"",16695 "required": true,16696 "description": ""16697 },16698 {16699 "name": "<BetaManagedAgentsSessionThreadStatusIdleEvent>.id",16700 "type": "string",16701 "required": true,16702 "description": "Unique identifier for this event."16703 },16704 {16705 "name": "<BetaManagedAgentsSessionThreadStatusIdleEvent>.agent_name",16706 "type": "string",16707 "required": true,16708 "description": "Name of the agent the thread runs."16709 },16710 {16711 "name": "<BetaManagedAgentsSessionThreadStatusIdleEvent>.processed_at",16712 "type": "string",16713 "required": true,16714 "description": "A timestamp in RFC 3339 format",16715 "constraints": {16716 "format": "date-time"16717 }16718 },16719 {16720 "name": "<BetaManagedAgentsSessionThreadStatusIdleEvent>.session_thread_id",16721 "type": "string",16722 "required": true,16723 "description": "Public sthr_ ID of the thread that went idle."16724 },16725 {16726 "name": "<BetaManagedAgentsSessionThreadStatusIdleEvent>.stop_reason",16727 "type": "BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted or BetaManagedAgentsSessionBudgetReached",16728 "required": true,16729 "description": ""16730 },16731 {16732 "name": "<BetaManagedAgentsSessionThreadStatusTerminatedEvent>",16733 "type": "BetaManagedAgentsSessionThreadStatusTerminatedEvent object",16734 "required": false,16735 "description": "A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads."16736 },16737 {16738 "name": "<BetaManagedAgentsSessionThreadStatusTerminatedEvent>.type",16739 "type": "\"session.thread_status_terminated\"",16740 "required": true,16741 "description": ""16742 },16743 {16744 "name": "<BetaManagedAgentsSessionThreadStatusTerminatedEvent>.id",16745 "type": "string",16746 "required": true,16747 "description": "Unique identifier for this event."16748 },16749 {16750 "name": "<BetaManagedAgentsSessionThreadStatusTerminatedEvent>.agent_name",16751 "type": "string",16752 "required": true,16753 "description": "Name of the agent the thread runs."16754 },16755 {16756 "name": "<BetaManagedAgentsSessionThreadStatusTerminatedEvent>.processed_at",16757 "type": "string",16758 "required": true,16759 "description": "A timestamp in RFC 3339 format",16760 "constraints": {16761 "format": "date-time"16762 }16763 },16764 {16765 "name": "<BetaManagedAgentsSessionThreadStatusTerminatedEvent>.session_thread_id",16766 "type": "string",16767 "required": true,16768 "description": "Public sthr_ ID of the thread that terminated."16769 },16770 {16771 "name": "<BetaManagedAgentsUserToolResultEvent>",16772 "type": "BetaManagedAgentsUserToolResultEvent object",16773 "required": false,16774 "description": "Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server."16775 },16776 {16777 "name": "<BetaManagedAgentsUserToolResultEvent>.type",16778 "type": "\"user.tool_result\"",16779 "required": true,16780 "description": ""16781 },16782 {16783 "name": "<BetaManagedAgentsUserToolResultEvent>.id",16784 "type": "string",16785 "required": true,16786 "description": "Unique identifier for this event."16787 },16788 {16789 "name": "<BetaManagedAgentsUserToolResultEvent>.tool_use_id",16790 "type": "string",16791 "required": true,16792 "description": "The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field."16793 },16794 {16795 "name": "<BetaManagedAgentsUserToolResultEvent>.content",16796 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock",16797 "required": false,16798 "description": "The result content returned by the tool."16799 },16800 {16801 "name": "<BetaManagedAgentsUserToolResultEvent>.is_error",16802 "type": "boolean or null",16803 "required": false,16804 "description": "Whether the tool execution resulted in an error."16805 },16806 {16807 "name": "<BetaManagedAgentsUserToolResultEvent>.processed_at",16808 "type": "string or null",16809 "required": false,16810 "description": "A timestamp in RFC 3339 format",16811 "constraints": {16812 "format": "date-time"16813 }16814 },16815 {16816 "name": "<BetaManagedAgentsUserToolResultEvent>.session_thread_id",16817 "type": "string or null",16818 "required": false,16819 "description": "Set by the server to the subagent thread this result was routed to. Omitted when it was routed to the primary thread."16820 },16821 {16822 "name": "<BetaManagedAgentsSessionThreadStatusRescheduledEvent>",16823 "type": "BetaManagedAgentsSessionThreadStatusRescheduledEvent object",16824 "required": false,16825 "description": "A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads."16826 },16827 {16828 "name": "<BetaManagedAgentsSessionThreadStatusRescheduledEvent>.type",16829 "type": "\"session.thread_status_rescheduled\"",16830 "required": true,16831 "description": ""16832 },16833 {16834 "name": "<BetaManagedAgentsSessionThreadStatusRescheduledEvent>.id",16835 "type": "string",16836 "required": true,16837 "description": "Unique identifier for this event."16838 },16839 {16840 "name": "<BetaManagedAgentsSessionThreadStatusRescheduledEvent>.agent_name",16841 "type": "string",16842 "required": true,16843 "description": "Name of the agent the thread runs."16844 },16845 {16846 "name": "<BetaManagedAgentsSessionThreadStatusRescheduledEvent>.processed_at",16847 "type": "string",16848 "required": true,16849 "description": "A timestamp in RFC 3339 format",16850 "constraints": {16851 "format": "date-time"16852 }16853 },16854 {16855 "name": "<BetaManagedAgentsSessionThreadStatusRescheduledEvent>.session_thread_id",16856 "type": "string",16857 "required": true,16858 "description": "Public sthr_ ID of the thread that is retrying."16859 },16860 {16861 "name": "<BetaManagedAgentsSessionUpdatedEvent>",16862 "type": "BetaManagedAgentsSessionUpdatedEvent object",16863 "required": false,16864 "description": "Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn."16865 },16866 {16867 "name": "<BetaManagedAgentsSessionUpdatedEvent>.type",16868 "type": "\"session.updated\"",16869 "required": true,16870 "description": ""16871 },16872 {16873 "name": "<BetaManagedAgentsSessionUpdatedEvent>.id",16874 "type": "string",16875 "required": true,16876 "description": "Unique identifier for this event."16877 },16878 {16879 "name": "<BetaManagedAgentsSessionUpdatedEvent>.processed_at",16880 "type": "string",16881 "required": true,16882 "description": "A timestamp in RFC 3339 format",16883 "constraints": {16884 "format": "date-time"16885 }16886 },16887 {16888 "name": "<BetaManagedAgentsSessionUpdatedEvent>.agent",16889 "type": "BetaManagedAgentsSessionAgent or null",16890 "required": false,16891 "description": "Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time."16892 },16893 {16894 "name": "<BetaManagedAgentsSessionUpdatedEvent>.budget",16895 "type": "BetaManagedAgentsBudgetLimit or null",16896 "required": false,16897 "description": "A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`."16898 },16899 {16900 "name": "<BetaManagedAgentsSessionUpdatedEvent>.metadata",16901 "type": "map[string]",16902 "required": false,16903 "description": "The session's full metadata bag after the update. Present when the update set non-empty metadata; absent when metadata was unchanged or cleared to empty."16904 },16905 {16906 "name": "<BetaManagedAgentsSessionUpdatedEvent>.title",16907 "type": "string or null",16908 "required": false,16909 "description": "The session's new title. Present only when the update changed it."16910 },16911 {16912 "name": "<BetaManagedAgentsStartEvent>",16913 "type": "BetaManagedAgentsStartEvent object",16914 "required": false,16915 "description": "Opens a preview of a buffered event. Carries the previewed event's type and id only. Followed by zero or more event_delta events with the same event id, normally concluded by the buffered event carrying that id. If the producing model request ends without that event (an error or interrupt mid-stream), its terminal span.model_request_end closes the preview. Only sent on stream connections that opt in via event_deltas; never appears in event history."16916 },16917 {16918 "name": "<BetaManagedAgentsStartEvent>.type",16919 "type": "\"event_start\"",16920 "required": true,16921 "description": ""16922 },16923 {16924 "name": "<BetaManagedAgentsStartEvent>.event",16925 "type": "BetaManagedAgentsStartEventPreview",16926 "required": true,16927 "description": "The previewed event's type and id. The event type determines which delta types the preview's event_delta events carry: agent.message events stream content_delta fragments; agent.thinking previews are start-only — no deltas follow, and the buffered agent.thinking with the same id concludes them."16928 },16929 {16930 "name": "<BetaManagedAgentsDeltaEvent>",16931 "type": "BetaManagedAgentsDeltaEvent object",16932 "required": false,16933 "description": "An incremental update to an event that is still being streamed. Deltas are best-effort and may stop early; when the buffered event with id == event_id is produced it carries the complete content. A model request that ends early (an error or interrupt) produces no buffered event — its terminal span.model_request_end closes the preview. Only sent on stream connections that opt in via event_deltas; never appears in event history."16934 },16935 {16936 "name": "<BetaManagedAgentsDeltaEvent>.type",16937 "type": "\"event_delta\"",16938 "required": true,16939 "description": ""16940 },16941 {16942 "name": "<BetaManagedAgentsDeltaEvent>.delta",16943 "type": "BetaManagedAgentsDeltaContent",16944 "required": true,16945 "description": "One fragment of the previewed event. The delta type is named for the previewed event's field it streams into: agent.message events stream content_delta fragments, each a partial element of the content array."16946 },16947 {16948 "name": "<BetaManagedAgentsDeltaEvent>.event_id",16949 "type": "string",16950 "required": true,16951 "description": "The id of the event being previewed. Matches event.id on the corresponding event_start and the buffered event that reconciles the preview."16952 },16953 {16954 "name": "<BetaManagedAgentsSystemMessageEvent>",16955 "type": "BetaManagedAgentsSystemMessageEvent object",16956 "required": false,16957 "description": "A mid-conversation system message event. Carries system-role content that is appended to the session as a `role: \"system\"` turn."16958 },16959 {16960 "name": "<BetaManagedAgentsSystemMessageEvent>.type",16961 "type": "\"system.message\"",16962 "required": true,16963 "description": ""16964 },16965 {16966 "name": "<BetaManagedAgentsSystemMessageEvent>.id",16967 "type": "string",16968 "required": true,16969 "description": "Unique identifier for this event."16970 },16971 {16972 "name": "<BetaManagedAgentsSystemMessageEvent>.content",16973 "type": "array of BetaManagedAgentsSystemContentBlock",16974 "required": true,16975 "description": "System content blocks. Text-only."16976 },16977 {16978 "name": "<BetaManagedAgentsSystemMessageEvent>.processed_at",16979 "type": "string or null",16980 "required": false,16981 "description": "A timestamp in RFC 3339 format",16982 "constraints": {16983 "format": "date-time"16984 }16985 },16986 {16987 "name": "<BetaManagedAgentsSessionUsageEvent>",16988 "type": "BetaManagedAgentsSessionUsageEvent object",16989 "required": false,16990 "description": "Periodic snapshot of the session's cumulative usage and tracked list cost."16991 },16992 {16993 "name": "<BetaManagedAgentsSessionUsageEvent>.type",16994 "type": "\"session.usage\"",16995 "required": true,16996 "description": ""16997 },16998 {16999 "name": "<BetaManagedAgentsSessionUsageEvent>.id",17000 "type": "string",17001 "required": true,17002 "description": "Unique identifier for this event."17003 },17004 {17005 "name": "<BetaManagedAgentsSessionUsageEvent>.processed_at",17006 "type": "string",17007 "required": true,17008 "description": "A timestamp in RFC 3339 format",17009 "constraints": {17010 "format": "date-time"17011 }17012 },17013 {17014 "name": "<BetaManagedAgentsSessionUsageEvent>.usage",17015 "type": "BetaManagedAgentsSessionUsageSnapshot",17016 "required": true,17017 "description": "Point-in-time snapshot of a session's cumulative usage."17018 },17019 {17020 "name": "<BetaManagedAgentsSessionUsageEvent>.budget",17021 "type": "BetaManagedAgentsBudgetLimit or null",17022 "required": false,17023 "description": "A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`."17024 }17025 ],17026 "status": [17027 "DOCUMENTED",17028 "BETA"17029 ],17030 "sources": [17031 {17032 "url": "https://platform.claude.com/docs/en/api/beta/sessions/events/stream",17033 "retrieved_at": "2026-09-18"17034 },17035 {17036 "url": "https://platform.claude.com/docs/en/managed-agents/events-and-streaming",17037 "retrieved_at": "2026-09-18"17038 }17039 ],17040 "beta_header": "managed-agents-2026-04-01"17041 },17042 {17043 "provider": "anthropic",17044 "api_family": "managed-agents",17045 "name": "SendSessionEventsParams (request body)",17046 "official_type_name": "BetaManagedAgentsEventParams",17047 "description": "Send Events",17048 "fields": [17049 {17050 "name": "events",17051 "type": "array of BetaManagedAgentsEventParams",17052 "required": true,17053 "description": "Events to send to the `session`."17054 },17055 {17056 "name": "events<BetaManagedAgentsUserMessageEventParams>",17057 "type": "BetaManagedAgentsUserMessageEventParams object",17058 "required": false,17059 "description": "Parameters for sending a user message to the session."17060 },17061 {17062 "name": "events<BetaManagedAgentsUserMessageEventParams>.type",17063 "type": "\"user.message\"",17064 "required": true,17065 "description": ""17066 },17067 {17068 "name": "events<BetaManagedAgentsUserMessageEventParams>.content",17069 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock",17070 "required": true,17071 "description": "Array of content blocks for the user message."17072 },17073 {17074 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsTextBlock>",17075 "type": "BetaManagedAgentsTextBlock object",17076 "required": false,17077 "description": "Regular text content."17078 },17079 {17080 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsTextBlock>.type",17081 "type": "\"text\"",17082 "required": true,17083 "description": ""17084 },17085 {17086 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsTextBlock>.text",17087 "type": "string",17088 "required": true,17089 "description": "The text content.",17090 "constraints": {17091 "minLength": "1"17092 }17093 },17094 {17095 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>",17096 "type": "BetaManagedAgentsImageBlock object",17097 "required": false,17098 "description": "Image content specified directly as base64 data or as a reference via a URL."17099 },17100 {17101 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.type",17102 "type": "\"image\"",17103 "required": true,17104 "description": ""17105 },17106 {17107 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source",17108 "type": "BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource",17109 "required": true,17110 "description": "Union type for image source variants."17111 },17112 {17113 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsBase64ImageSource>",17114 "type": "BetaManagedAgentsBase64ImageSource object",17115 "required": false,17116 "description": "Base64-encoded image data."17117 },17118 {17119 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsBase64ImageSource>.type",17120 "type": "\"base64\"",17121 "required": true,17122 "description": ""17123 },17124 {17125 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsBase64ImageSource>.data",17126 "type": "string",17127 "required": true,17128 "description": "Base64-encoded image data.",17129 "constraints": {17130 "minLength": "1"17131 }17132 },17133 {17134 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsBase64ImageSource>.media_type",17135 "type": "string",17136 "required": true,17137 "description": "MIME type of the image (e.g., \"image/png\", \"image/jpeg\", \"image/gif\", \"image/webp\").",17138 "constraints": {17139 "minLength": "1"17140 }17141 },17142 {17143 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsURLImageSource>",17144 "type": "BetaManagedAgentsURLImageSource object",17145 "required": false,17146 "description": "Image referenced by URL."17147 },17148 {17149 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsURLImageSource>.type",17150 "type": "\"url\"",17151 "required": true,17152 "description": ""17153 },17154 {17155 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsURLImageSource>.url",17156 "type": "string",17157 "required": true,17158 "description": "URL of the image to fetch.",17159 "constraints": {17160 "minLength": "1"17161 }17162 },17163 {17164 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsFileImageSource>",17165 "type": "BetaManagedAgentsFileImageSource object",17166 "required": false,17167 "description": "Image referenced by file ID."17168 },17169 {17170 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsFileImageSource>.type",17171 "type": "\"file\"",17172 "required": true,17173 "description": ""17174 },17175 {17176 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsFileImageSource>.file_id",17177 "type": "string",17178 "required": true,17179 "description": "ID of a previously uploaded file.",17180 "constraints": {17181 "minLength": "1"17182 }17183 },17184 {17185 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>",17186 "type": "BetaManagedAgentsDocumentBlock object",17187 "required": false,17188 "description": "Document content, either specified directly as base64 data, as text, or as a reference via a URL."17189 },17190 {17191 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.type",17192 "type": "\"document\"",17193 "required": true,17194 "description": ""17195 },17196 {17197 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source",17198 "type": "BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource",17199 "required": true,17200 "description": "Union type for document source variants."17201 },17202 {17203 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsBase64DocumentSource>",17204 "type": "BetaManagedAgentsBase64DocumentSource object",17205 "required": false,17206 "description": "Base64-encoded document data."17207 },17208 {17209 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsBase64DocumentSource>.type",17210 "type": "\"base64\"",17211 "required": true,17212 "description": ""17213 },17214 {17215 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsBase64DocumentSource>.data",17216 "type": "string",17217 "required": true,17218 "description": "Base64-encoded document data.",17219 "constraints": {17220 "minLength": "1"17221 }17222 },17223 {17224 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsBase64DocumentSource>.media_type",17225 "type": "string",17226 "required": true,17227 "description": "MIME type of the document (e.g., \"application/pdf\").",17228 "constraints": {17229 "minLength": "1"17230 }17231 },17232 {17233 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsPlainTextDocumentSource>",17234 "type": "BetaManagedAgentsPlainTextDocumentSource object",17235 "required": false,17236 "description": "Plain text document content."17237 },17238 {17239 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsPlainTextDocumentSource>.type",17240 "type": "\"text\"",17241 "required": true,17242 "description": ""17243 },17244 {17245 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsPlainTextDocumentSource>.data",17246 "type": "string",17247 "required": true,17248 "description": "The plain text content.",17249 "constraints": {17250 "minLength": "1"17251 }17252 },17253 {17254 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsPlainTextDocumentSource>.media_type",17255 "type": "\"text/plain\"",17256 "required": true,17257 "description": "MIME type of the text content. Must be \"text/plain\"."17258 },17259 {17260 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsURLDocumentSource>",17261 "type": "BetaManagedAgentsURLDocumentSource object",17262 "required": false,17263 "description": "Document referenced by URL."17264 },17265 {17266 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsURLDocumentSource>.type",17267 "type": "\"url\"",17268 "required": true,17269 "description": ""17270 },17271 {17272 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsURLDocumentSource>.url",17273 "type": "string",17274 "required": true,17275 "description": "URL of the document to fetch.",17276 "constraints": {17277 "minLength": "1"17278 }17279 },17280 {17281 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsFileDocumentSource>",17282 "type": "BetaManagedAgentsFileDocumentSource object",17283 "required": false,17284 "description": "Document referenced by file ID."17285 },17286 {17287 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsFileDocumentSource>.type",17288 "type": "\"file\"",17289 "required": true,17290 "description": ""17291 },17292 {17293 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsFileDocumentSource>.file_id",17294 "type": "string",17295 "required": true,17296 "description": "ID of a previously uploaded file.",17297 "constraints": {17298 "minLength": "1"17299 }17300 },17301 {17302 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.context",17303 "type": "string or null",17304 "required": false,17305 "description": "Additional context about the document for the model."17306 },17307 {17308 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.title",17309 "type": "string or null",17310 "required": false,17311 "description": "The title of the document."17312 },17313 {17314 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsRedactedBlock>",17315 "type": "BetaManagedAgentsRedactedBlock object",17316 "required": false,17317 "description": "Placeholder for content withheld by Anthropic model policy."17318 },17319 {17320 "name": "events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsRedactedBlock>.type",17321 "type": "\"redacted\"",17322 "required": true,17323 "description": ""17324 },17325 {17326 "name": "events<BetaManagedAgentsUserInterruptEventParams>",17327 "type": "BetaManagedAgentsUserInterruptEventParams object",17328 "required": false,17329 "description": "Parameters for sending an interrupt to pause the agent."17330 },17331 {17332 "name": "events<BetaManagedAgentsUserInterruptEventParams>.type",17333 "type": "\"user.interrupt\"",17334 "required": true,17335 "description": ""17336 },17337 {17338 "name": "events<BetaManagedAgentsUserInterruptEventParams>.session_thread_id",17339 "type": "string or null",17340 "required": false,17341 "description": "If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread."17342 },17343 {17344 "name": "events<BetaManagedAgentsUserToolConfirmationEventParams>",17345 "type": "BetaManagedAgentsUserToolConfirmationEventParams object",17346 "required": false,17347 "description": "Parameters for confirming or denying a tool execution request."17348 },17349 {17350 "name": "events<BetaManagedAgentsUserToolConfirmationEventParams>.type",17351 "type": "\"user.tool_confirmation\"",17352 "required": true,17353 "description": ""17354 },17355 {17356 "name": "events<BetaManagedAgentsUserToolConfirmationEventParams>.result",17357 "type": "\"allow\" or \"deny\"",17358 "required": true,17359 "description": "UserToolConfirmationResult enum",17360 "enum": [17361 "allow",17362 "deny"17363 ]17364 },17365 {17366 "name": "events<BetaManagedAgentsUserToolConfirmationEventParams>.tool_use_id",17367 "type": "string",17368 "required": true,17369 "description": "The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.",17370 "constraints": {17371 "minLength": "1",17372 "maxLength": "128"17373 }17374 },17375 {17376 "name": "events<BetaManagedAgentsUserToolConfirmationEventParams>.deny_message",17377 "type": "string or null",17378 "required": false,17379 "description": "Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'.",17380 "constraints": {17381 "maxLength": "10000"17382 }17383 },17384 {17385 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>",17386 "type": "BetaManagedAgentsUserCustomToolResultEventParams object",17387 "required": false,17388 "description": "Parameters for providing the result of a custom tool execution."17389 },17390 {17391 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.type",17392 "type": "\"user.custom_tool_result\"",17393 "required": true,17394 "description": ""17395 },17396 {17397 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.custom_tool_use_id",17398 "type": "string",17399 "required": true,17400 "description": "The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.",17401 "constraints": {17402 "minLength": "1",17403 "maxLength": "128"17404 }17405 },17406 {17407 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.content",17408 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock",17409 "required": false,17410 "description": "The result content returned by the tool."17411 },17412 {17413 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.content<BetaManagedAgentsTextBlock>",17414 "type": "BetaManagedAgentsTextBlock object",17415 "required": false,17416 "description": "Regular text content."17417 },17418 {17419 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.content<BetaManagedAgentsImageBlock>",17420 "type": "BetaManagedAgentsImageBlock object",17421 "required": false,17422 "description": "Image content specified directly as base64 data or as a reference via a URL."17423 },17424 {17425 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.content<BetaManagedAgentsDocumentBlock>",17426 "type": "BetaManagedAgentsDocumentBlock object",17427 "required": false,17428 "description": "Document content, either specified directly as base64 data, as text, or as a reference via a URL."17429 },17430 {17431 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.content<BetaManagedAgentsSearchResultBlock>",17432 "type": "BetaManagedAgentsSearchResultBlock object",17433 "required": false,17434 "description": "A block containing a web search result."17435 },17436 {17437 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.content<BetaManagedAgentsSearchResultBlock>.type",17438 "type": "\"search_result\"",17439 "required": true,17440 "description": ""17441 },17442 {17443 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.content<BetaManagedAgentsSearchResultBlock>.citations",17444 "type": "BetaManagedAgentsSearchResultCitations",17445 "required": true,17446 "description": "Citation settings for a search result."17447 },17448 {17449 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.content<BetaManagedAgentsSearchResultBlock>.citations.enabled",17450 "type": "boolean",17451 "required": true,17452 "description": "Whether citations are enabled for this search result."17453 },17454 {17455 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.content<BetaManagedAgentsSearchResultBlock>.content",17456 "type": "array of BetaManagedAgentsSearchResultContent",17457 "required": true,17458 "description": "Array of text content blocks from the search result."17459 },17460 {17461 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.content<BetaManagedAgentsSearchResultBlock>.content.type",17462 "type": "\"text\"",17463 "required": true,17464 "description": ""17465 },17466 {17467 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.content<BetaManagedAgentsSearchResultBlock>.content.text",17468 "type": "string",17469 "required": true,17470 "description": "The text content.",17471 "constraints": {17472 "minLength": "1"17473 }17474 },17475 {17476 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.content<BetaManagedAgentsSearchResultBlock>.source",17477 "type": "string",17478 "required": true,17479 "description": "The URL source of the search result.",17480 "constraints": {17481 "minLength": "1"17482 }17483 },17484 {17485 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.content<BetaManagedAgentsSearchResultBlock>.title",17486 "type": "string",17487 "required": true,17488 "description": "The title of the search result.",17489 "constraints": {17490 "minLength": "1"17491 }17492 },17493 {17494 "name": "events<BetaManagedAgentsUserCustomToolResultEventParams>.is_error",17495 "type": "boolean or null",17496 "required": false,17497 "description": "Whether the tool execution resulted in an error."17498 },17499 {17500 "name": "events<BetaManagedAgentsUserDefineOutcomeEventParams>",17501 "type": "BetaManagedAgentsUserDefineOutcomeEventParams object",17502 "required": false,17503 "description": "Parameters for defining an outcome the agent should work toward. The agent begins work on receipt."17504 },17505 {17506 "name": "events<BetaManagedAgentsUserDefineOutcomeEventParams>.type",17507 "type": "\"user.define_outcome\"",17508 "required": true,17509 "description": ""17510 },17511 {17512 "name": "events<BetaManagedAgentsUserDefineOutcomeEventParams>.description",17513 "type": "string",17514 "required": true,17515 "description": "What the agent should produce. This is the task specification."17516 },17517 {17518 "name": "events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric",17519 "type": "BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams",17520 "required": true,17521 "description": "Rubric for grading the quality of an outcome."17522 },17523 {17524 "name": "events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsFileRubricParams>",17525 "type": "BetaManagedAgentsFileRubricParams object",17526 "required": false,17527 "description": "Rubric referenced by a file uploaded via the Files API."17528 },17529 {17530 "name": "events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsFileRubricParams>.type",17531 "type": "\"file\"",17532 "required": true,17533 "description": ""17534 },17535 {17536 "name": "events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsFileRubricParams>.file_id",17537 "type": "string",17538 "required": true,17539 "description": "ID of the rubric file."17540 },17541 {17542 "name": "events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsTextRubricParams>",17543 "type": "BetaManagedAgentsTextRubricParams object",17544 "required": false,17545 "description": "Rubric content provided inline as text."17546 },17547 {17548 "name": "events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsTextRubricParams>.type",17549 "type": "\"text\"",17550 "required": true,17551 "description": ""17552 },17553 {17554 "name": "events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsTextRubricParams>.content",17555 "type": "string",17556 "required": true,17557 "description": "Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.",17558 "constraints": {17559 "maxLength": "262144"17560 }17561 },17562 {17563 "name": "events<BetaManagedAgentsUserDefineOutcomeEventParams>.max_iterations",17564 "type": "number or null",17565 "required": false,17566 "description": "Eval→revision cycles before giving up. Default 3, max 20.",17567 "constraints": {17568 "format": "int32"17569 }17570 },17571 {17572 "name": "events<BetaManagedAgentsUserToolResultEventParams>",17573 "type": "BetaManagedAgentsUserToolResultEventParams object",17574 "required": false,17575 "description": "Parameters for providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server."17576 },17577 {17578 "name": "events<BetaManagedAgentsUserToolResultEventParams>.type",17579 "type": "\"user.tool_result\"",17580 "required": true,17581 "description": ""17582 },17583 {17584 "name": "events<BetaManagedAgentsUserToolResultEventParams>.tool_use_id",17585 "type": "string",17586 "required": true,17587 "description": "The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.",17588 "constraints": {17589 "minLength": "1",17590 "maxLength": "128"17591 }17592 },17593 {17594 "name": "events<BetaManagedAgentsUserToolResultEventParams>.content",17595 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock",17596 "required": false,17597 "description": "The result content returned by the tool."17598 },17599 {17600 "name": "events<BetaManagedAgentsUserToolResultEventParams>.content<BetaManagedAgentsTextBlock>",17601 "type": "BetaManagedAgentsTextBlock object",17602 "required": false,17603 "description": "Regular text content."17604 },17605 {17606 "name": "events<BetaManagedAgentsUserToolResultEventParams>.content<BetaManagedAgentsImageBlock>",17607 "type": "BetaManagedAgentsImageBlock object",17608 "required": false,17609 "description": "Image content specified directly as base64 data or as a reference via a URL."17610 },17611 {17612 "name": "events<BetaManagedAgentsUserToolResultEventParams>.content<BetaManagedAgentsDocumentBlock>",17613 "type": "BetaManagedAgentsDocumentBlock object",17614 "required": false,17615 "description": "Document content, either specified directly as base64 data, as text, or as a reference via a URL."17616 },17617 {17618 "name": "events<BetaManagedAgentsUserToolResultEventParams>.content<BetaManagedAgentsSearchResultBlock>",17619 "type": "BetaManagedAgentsSearchResultBlock object",17620 "required": false,17621 "description": "A block containing a web search result."17622 },17623 {17624 "name": "events<BetaManagedAgentsUserToolResultEventParams>.is_error",17625 "type": "boolean or null",17626 "required": false,17627 "description": "Whether the tool execution resulted in an error."17628 },17629 {17630 "name": "events<BetaManagedAgentsSystemMessageEventParams>",17631 "type": "BetaManagedAgentsSystemMessageEventParams object",17632 "required": false,17633 "description": "Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: \"system\"` turn rather than replacing the top-level system prompt. At most one per request: it must be the final event and immediately follow the `user.message`, `user.tool_result`, or `user.custom_tool_result` it accompanies. Only supported on models that accept mid-conversation system messages."17634 },17635 {17636 "name": "events<BetaManagedAgentsSystemMessageEventParams>.type",17637 "type": "\"system.message\"",17638 "required": true,17639 "description": ""17640 },17641 {17642 "name": "events<BetaManagedAgentsSystemMessageEventParams>.content",17643 "type": "array of BetaManagedAgentsSystemContentBlock",17644 "required": true,17645 "description": "System content blocks to append. Text-only."17646 },17647 {17648 "name": "events<BetaManagedAgentsSystemMessageEventParams>.content.type",17649 "type": "\"text\"",17650 "required": true,17651 "description": ""17652 },17653 {17654 "name": "events<BetaManagedAgentsSystemMessageEventParams>.content.text",17655 "type": "string",17656 "required": true,17657 "description": "The text content.",17658 "constraints": {17659 "minLength": "1"17660 }17661 }17662 ],17663 "status": [17664 "DOCUMENTED",17665 "BETA"17666 ],17667 "sources": [17668 {17669 "url": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",17670 "retrieved_at": "2026-09-18"17671 },17672 {17673 "url": "https://platform.claude.com/docs/en/managed-agents/events-and-streaming",17674 "retrieved_at": "2026-09-18"17675 }17676 ],17677 "beta_header": "managed-agents-2026-04-01"17678 },17679 {17680 "provider": "anthropic",17681 "api_family": "managed-agents",17682 "name": "Environment",17683 "official_type_name": "BetaEnvironment",17684 "description": "Unified Environment resource for both cloud and self-hosted environments.",17685 "fields": [17686 {17687 "name": "type",17688 "type": "\"environment\"",17689 "required": true,17690 "description": "The type of object (always 'environment')",17691 "constraints": {17692 "default": "environment"17693 }17694 },17695 {17696 "name": "id",17697 "type": "string",17698 "required": true,17699 "description": "Environment identifier (e.g., 'env_...')"17700 },17701 {17702 "name": "archived_at",17703 "type": "string or null",17704 "required": true,17705 "description": "RFC 3339 timestamp when environment was archived, or null if not archived"17706 },17707 {17708 "name": "config",17709 "type": "BetaCloudConfig or BetaSelfHostedConfig",17710 "required": true,17711 "description": "Environment configuration (either Anthropic Cloud or self-hosted)"17712 },17713 {17714 "name": "config<BetaCloudConfig>",17715 "type": "BetaCloudConfig object",17716 "required": false,17717 "description": "`cloud` environment configuration."17718 },17719 {17720 "name": "config<BetaCloudConfig>.type",17721 "type": "\"cloud\"",17722 "required": true,17723 "description": "Environment type"17724 },17725 {17726 "name": "config<BetaCloudConfig>.networking",17727 "type": "BetaUnrestrictedNetwork or BetaLimitedNetwork",17728 "required": true,17729 "description": "Network configuration policy."17730 },17731 {17732 "name": "config<BetaCloudConfig>.networking<BetaUnrestrictedNetwork>",17733 "type": "BetaUnrestrictedNetwork object",17734 "required": false,17735 "description": "Unrestricted network access."17736 },17737 {17738 "name": "config<BetaCloudConfig>.networking<BetaUnrestrictedNetwork>.type",17739 "type": "\"unrestricted\"",17740 "required": true,17741 "description": "Network policy type"17742 },17743 {17744 "name": "config<BetaCloudConfig>.networking<BetaLimitedNetwork>",17745 "type": "BetaLimitedNetwork object",17746 "required": false,17747 "description": "Limited network access."17748 },17749 {17750 "name": "config<BetaCloudConfig>.networking<BetaLimitedNetwork>.type",17751 "type": "\"limited\"",17752 "required": true,17753 "description": "Network policy type"17754 },17755 {17756 "name": "config<BetaCloudConfig>.networking<BetaLimitedNetwork>.allow_mcp_servers",17757 "type": "boolean",17758 "required": true,17759 "description": "Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array."17760 },17761 {17762 "name": "config<BetaCloudConfig>.networking<BetaLimitedNetwork>.allow_package_managers",17763 "type": "boolean",17764 "required": true,17765 "description": "Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array."17766 },17767 {17768 "name": "config<BetaCloudConfig>.networking<BetaLimitedNetwork>.allowed_hosts",17769 "type": "array of string",17770 "required": true,17771 "description": "Specifies domains the container can reach."17772 },17773 {17774 "name": "config<BetaCloudConfig>.packages",17775 "type": "BetaPackages",17776 "required": true,17777 "description": "Package manager configuration."17778 },17779 {17780 "name": "config<BetaCloudConfig>.packages.type",17781 "type": "\"packages\"",17782 "required": false,17783 "description": "Package configuration type",17784 "constraints": {17785 "default": "packages"17786 }17787 },17788 {17789 "name": "config<BetaCloudConfig>.packages.apt",17790 "type": "array of string",17791 "required": true,17792 "description": "Ubuntu/Debian packages to install"17793 },17794 {17795 "name": "config<BetaCloudConfig>.packages.cargo",17796 "type": "array of string",17797 "required": true,17798 "description": "Rust packages to install"17799 },17800 {17801 "name": "config<BetaCloudConfig>.packages.gem",17802 "type": "array of string",17803 "required": true,17804 "description": "Ruby packages to install"17805 },17806 {17807 "name": "config<BetaCloudConfig>.packages.go",17808 "type": "array of string",17809 "required": true,17810 "description": "Go packages to install"17811 },17812 {17813 "name": "config<BetaCloudConfig>.packages.npm",17814 "type": "array of string",17815 "required": true,17816 "description": "Node.js packages to install"17817 },17818 {17819 "name": "config<BetaCloudConfig>.packages.pip",17820 "type": "array of string",17821 "required": true,17822 "description": "Python packages to install"17823 },17824 {17825 "name": "config<BetaSelfHostedConfig>",17826 "type": "BetaSelfHostedConfig object",17827 "required": false,17828 "description": "Configuration for self-hosted environments."17829 },17830 {17831 "name": "config<BetaSelfHostedConfig>.type",17832 "type": "\"self_hosted\"",17833 "required": true,17834 "description": "Environment type"17835 },17836 {17837 "name": "created_at",17838 "type": "string",17839 "required": true,17840 "description": "RFC 3339 timestamp when environment was created"17841 },17842 {17843 "name": "description",17844 "type": "string or null",17845 "required": true,17846 "description": "User-provided description for the environment; null when unset"17847 },17848 {17849 "name": "metadata",17850 "type": "map[string]",17851 "required": true,17852 "description": "User-provided metadata key-value pairs"17853 },17854 {17855 "name": "name",17856 "type": "string",17857 "required": true,17858 "description": "Human-readable name for the environment"17859 },17860 {17861 "name": "updated_at",17862 "type": "string",17863 "required": true,17864 "description": "RFC 3339 timestamp when environment was last updated"17865 },17866 {17867 "name": "scope",17868 "type": "\"organization\" or \"account\"",17869 "required": false,17870 "description": "The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account.",17871 "enum": [17872 "organization",17873 "account"17874 ]17875 }17876 ],17877 "status": [17878 "DOCUMENTED",17879 "BETA"17880 ],17881 "sources": [17882 {17883 "url": "https://platform.claude.com/docs/en/api/beta/environments/create",17884 "retrieved_at": "2026-09-18"17885 },17886 {17887 "url": "https://platform.claude.com/docs/en/managed-agents/environments",17888 "retrieved_at": "2026-09-18"17889 },17890 {17891 "url": "https://platform.claude.com/docs/en/managed-agents/self-hosted-sandboxes",17892 "retrieved_at": "2026-09-18"17893 }17894 ],17895 "beta_header": "managed-agents-2026-04-01"17896 },17897 {17898 "provider": "anthropic",17899 "api_family": "managed-agents",17900 "name": "EnvironmentCreateParams (request body: cloud | self_hosted config)",17901 "official_type_name": "BetaEnvironmentCreateParams",17902 "description": "Create a new environment with the specified configuration.",17903 "fields": [17904 {17905 "name": "name",17906 "type": "string",17907 "required": true,17908 "description": "Human-readable name for the environment",17909 "constraints": {17910 "maxLength": "256",17911 "minLength": "1"17912 }17913 },17914 {17915 "name": "config",17916 "type": "BetaCloudConfigParams or BetaSelfHostedConfigParams or null",17917 "required": false,17918 "description": "Environment configuration"17919 },17920 {17921 "name": "config<BetaCloudConfigParams>",17922 "type": "BetaCloudConfigParams object",17923 "required": false,17924 "description": "Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value."17925 },17926 {17927 "name": "config<BetaCloudConfigParams>.type",17928 "type": "\"cloud\"",17929 "required": true,17930 "description": "Environment type"17931 },17932 {17933 "name": "config<BetaCloudConfigParams>.networking",17934 "type": "BetaUnrestrictedNetwork or BetaLimitedNetworkParams or null",17935 "required": false,17936 "description": "Network configuration policy. Omit on update to preserve the existing value."17937 },17938 {17939 "name": "config<BetaCloudConfigParams>.networking<BetaUnrestrictedNetwork>",17940 "type": "BetaUnrestrictedNetwork object",17941 "required": false,17942 "description": "Unrestricted network access."17943 },17944 {17945 "name": "config<BetaCloudConfigParams>.networking<BetaUnrestrictedNetwork>.type",17946 "type": "\"unrestricted\"",17947 "required": true,17948 "description": "Network policy type"17949 },17950 {17951 "name": "config<BetaCloudConfigParams>.networking<BetaLimitedNetworkParams>",17952 "type": "BetaLimitedNetworkParams object",17953 "required": false,17954 "description": "Limited network request params. Fields default to null; on update, omitted fields preserve the existing value."17955 },17956 {17957 "name": "config<BetaCloudConfigParams>.networking<BetaLimitedNetworkParams>.type",17958 "type": "\"limited\"",17959 "required": true,17960 "description": "Network policy type"17961 },17962 {17963 "name": "config<BetaCloudConfigParams>.networking<BetaLimitedNetworkParams>.allow_mcp_servers",17964 "type": "boolean or null",17965 "required": false,17966 "description": "Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`."17967 },17968 {17969 "name": "config<BetaCloudConfigParams>.networking<BetaLimitedNetworkParams>.allow_package_managers",17970 "type": "boolean or null",17971 "required": false,17972 "description": "Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified."17973 },17974 {17975 "name": "config<BetaCloudConfigParams>.networking<BetaLimitedNetworkParams>.allowed_hosts",17976 "type": "array of string or null",17977 "required": false,17978 "description": "Specifies domains the container can reach."17979 },17980 {17981 "name": "config<BetaCloudConfigParams>.packages",17982 "type": "BetaPackagesParams or null",17983 "required": false,17984 "description": "Specify packages (and optionally their versions) available in this environment. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. Under `limited` networking, requires `networking.allow_package_managers` to be `true`."17985 },17986 {17987 "name": "config<BetaCloudConfigParams>.packages.type",17988 "type": "\"packages\"",17989 "required": false,17990 "description": "Package configuration type",17991 "constraints": {17992 "default": "packages"17993 }17994 },17995 {17996 "name": "config<BetaCloudConfigParams>.packages.apt",17997 "type": "array of string or null",17998 "required": false,17999 "description": "Ubuntu/Debian packages to install"18000 },18001 {18002 "name": "config<BetaCloudConfigParams>.packages.cargo",18003 "type": "array of string or null",18004 "required": false,18005 "description": "Rust packages to install"18006 },18007 {18008 "name": "config<BetaCloudConfigParams>.packages.gem",18009 "type": "array of string or null",18010 "required": false,18011 "description": "Ruby packages to install"18012 },18013 {18014 "name": "config<BetaCloudConfigParams>.packages.go",18015 "type": "array of string or null",18016 "required": false,18017 "description": "Go packages to install"18018 },18019 {18020 "name": "config<BetaCloudConfigParams>.packages.npm",18021 "type": "array of string or null",18022 "required": false,18023 "description": "Node.js packages to install"18024 },18025 {18026 "name": "config<BetaCloudConfigParams>.packages.pip",18027 "type": "array of string or null",18028 "required": false,18029 "description": "Python packages to install"18030 },18031 {18032 "name": "config<BetaSelfHostedConfigParams>",18033 "type": "BetaSelfHostedConfigParams object",18034 "required": false,18035 "description": "Request params for `self_hosted` environment configuration."18036 },18037 {18038 "name": "config<BetaSelfHostedConfigParams>.type",18039 "type": "\"self_hosted\"",18040 "required": true,18041 "description": "Environment type"18042 },18043 {18044 "name": "description",18045 "type": "string or null",18046 "required": false,18047 "description": "Optional description of the environment",18048 "constraints": {18049 "maxLength": "1024"18050 }18051 },18052 {18053 "name": "metadata",18054 "type": "map[string]",18055 "required": false,18056 "description": "User-provided metadata key-value pairs"18057 },18058 {18059 "name": "scope",18060 "type": "\"organization\" or \"account\" or null",18061 "required": false,18062 "description": "The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. API organizations support only 'organization'; 'account' is rejected. If not specified, defaults based on organization type.",18063 "enum": [18064 "organization",18065 "account"18066 ]18067 }18068 ],18069 "status": [18070 "DOCUMENTED",18071 "BETA"18072 ],18073 "sources": [18074 {18075 "url": "https://platform.claude.com/docs/en/api/beta/environments/create",18076 "retrieved_at": "2026-09-18"18077 },18078 {18079 "url": "https://platform.claude.com/docs/en/managed-agents/environments",18080 "retrieved_at": "2026-09-18"18081 },18082 {18083 "url": "https://platform.claude.com/docs/en/managed-agents/self-hosted-sandboxes",18084 "retrieved_at": "2026-09-18"18085 }18086 ],18087 "beta_header": "managed-agents-2026-04-01"18088 },18089 {18090 "provider": "anthropic",18091 "api_family": "managed-agents",18092 "name": "WorkItem (self-hosted work queue)",18093 "official_type_name": "BetaSelfHostedWork",18094 "description": "Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox.",18095 "fields": [18096 {18097 "name": "type",18098 "type": "\"work\"",18099 "required": true,18100 "description": "The type of object (always 'work')",18101 "constraints": {18102 "default": "work"18103 }18104 },18105 {18106 "name": "id",18107 "type": "string",18108 "required": true,18109 "description": "Work identifier (e.g., 'work_...')"18110 },18111 {18112 "name": "acknowledged_at",18113 "type": "string or null",18114 "required": true,18115 "description": "RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox"18116 },18117 {18118 "name": "created_at",18119 "type": "string",18120 "required": true,18121 "description": "RFC 3339 timestamp when work was created"18122 },18123 {18124 "name": "data",18125 "type": "BetaSessionWorkData",18126 "required": true,18127 "description": "The actual work to be performed"18128 },18129 {18130 "name": "data.type",18131 "type": "\"session\"",18132 "required": true,18133 "description": "Type of work data"18134 },18135 {18136 "name": "data.id",18137 "type": "string",18138 "required": true,18139 "description": "Session identifier (e.g., 'session_...')"18140 },18141 {18142 "name": "environment_id",18143 "type": "string",18144 "required": true,18145 "description": "Environment identifier this work belongs to (e.g., `env_...`)"18146 },18147 {18148 "name": "latest_heartbeat_at",18149 "type": "string or null",18150 "required": true,18151 "description": "RFC 3339 timestamp of the most recent heartbeat"18152 },18153 {18154 "name": "metadata",18155 "type": "map[string]",18156 "required": true,18157 "description": "User-provided metadata key-value pairs associated with this work item"18158 },18159 {18160 "name": "secret",18161 "type": "string or null",18162 "required": true,18163 "description": "Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths."18164 },18165 {18166 "name": "started_at",18167 "type": "string or null",18168 "required": true,18169 "description": "RFC 3339 timestamp when work execution started"18170 },18171 {18172 "name": "state",18173 "type": "\"queued\" or \"starting\" or \"active\" or 2 more",18174 "required": true,18175 "description": "Current state of the work item",18176 "enum": [18177 "queued",18178 "starting",18179 "active",18180 "stopping",18181 "stopped"18182 ]18183 },18184 {18185 "name": "stop_requested_at",18186 "type": "string or null",18187 "required": true,18188 "description": "RFC 3339 timestamp when stop was requested"18189 },18190 {18191 "name": "stopped_at",18192 "type": "string or null",18193 "required": true,18194 "description": "RFC 3339 timestamp when work execution stopped"18195 }18196 ],18197 "status": [18198 "DOCUMENTED",18199 "BETA"18200 ],18201 "sources": [18202 {18203 "url": "https://platform.claude.com/docs/en/api/beta/environments/work/poll",18204 "retrieved_at": "2026-09-18"18205 },18206 {18207 "url": "https://platform.claude.com/docs/en/managed-agents/self-hosted-sandboxes",18208 "retrieved_at": "2026-09-18"18209 }18210 ],18211 "beta_header": "managed-agents-2026-04-01"18212 },18213 {18214 "provider": "anthropic",18215 "api_family": "managed-agents",18216 "name": "WorkQueueStats",18217 "official_type_name": "BetaSelfHostedWorkQueueStats",18218 "description": "Statistics about the work queue for an environment. Uses Redis Stream consumer group metrics for O(1) queries.",18219 "fields": [18220 {18221 "name": "type",18222 "type": "\"work_queue_stats\"",18223 "required": true,18224 "description": "The type of object",18225 "constraints": {18226 "default": "work_queue_stats"18227 }18228 },18229 {18230 "name": "depth",18231 "type": "number",18232 "required": true,18233 "description": "Number of work items waiting to be picked up (lag from consumer group)"18234 },18235 {18236 "name": "oldest_queued_at",18237 "type": "string or null",18238 "required": true,18239 "description": "RFC 3339 timestamp of oldest item in the work stream (includes both queued and pending items), null if stream empty"18240 },18241 {18242 "name": "pending",18243 "type": "number",18244 "required": true,18245 "description": "Number of work items being processed (polled but not acknowledged)",18246 "constraints": {18247 "default": "0"18248 }18249 },18250 {18251 "name": "workers_polling",18252 "type": "number or null",18253 "required": true,18254 "description": "Number of workers that have polled for work in the last 30 seconds. Requires worker_id to be sent with poll requests."18255 }18256 ],18257 "status": [18258 "DOCUMENTED",18259 "BETA"18260 ],18261 "sources": [18262 {18263 "url": "https://platform.claude.com/docs/en/api/beta/environments/work/stats",18264 "retrieved_at": "2026-09-18"18265 },18266 {18267 "url": "https://platform.claude.com/docs/en/managed-agents/self-hosted-sandboxes",18268 "retrieved_at": "2026-09-18"18269 }18270 ],18271 "beta_header": "managed-agents-2026-04-01"18272 },18273 {18274 "provider": "anthropic",18275 "api_family": "managed-agents",18276 "name": "WorkHeartbeatResponse",18277 "official_type_name": "BetaSelfHostedWorkHeartbeatResponse",18278 "description": "Response after recording a heartbeat for a work item.",18279 "fields": [18280 {18281 "name": "type",18282 "type": "\"work_heartbeat\"",18283 "required": true,18284 "description": "The type of response",18285 "constraints": {18286 "default": "work_heartbeat"18287 }18288 },18289 {18290 "name": "last_heartbeat",18291 "type": "string",18292 "required": true,18293 "description": "RFC 3339 timestamp of the actual heartbeat from DB"18294 },18295 {18296 "name": "lease_extended",18297 "type": "boolean",18298 "required": true,18299 "description": "Whether the heartbeat succeeded in extending the lease"18300 },18301 {18302 "name": "state",18303 "type": "\"queued\" or \"starting\" or \"active\" or 2 more",18304 "required": true,18305 "description": "Current state of the work item (active/stopping/stopped)",18306 "enum": [18307 "queued",18308 "starting",18309 "active",18310 "stopping",18311 "stopped"18312 ]18313 },18314 {18315 "name": "ttl_seconds",18316 "type": "number",18317 "required": true,18318 "description": "Effective TTL applied to the lease"18319 }18320 ],18321 "status": [18322 "DOCUMENTED",18323 "BETA"18324 ],18325 "sources": [18326 {18327 "url": "https://platform.claude.com/docs/en/api/beta/environments/work/heartbeat",18328 "retrieved_at": "2026-09-18"18329 }18330 ],18331 "beta_header": "managed-agents-2026-04-01"18332 },18333 {18334 "provider": "anthropic",18335 "api_family": "managed-agents",18336 "name": "Deployment",18337 "official_type_name": "BetaManagedAgentsDeployment",18338 "description": "A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule.",18339 "fields": [18340 {18341 "name": "type",18342 "type": "\"deployment\"",18343 "required": true,18344 "description": ""18345 },18346 {18347 "name": "id",18348 "type": "string",18349 "required": true,18350 "description": "Unique identifier for this deployment."18351 },18352 {18353 "name": "agent",18354 "type": "BetaManagedAgentsAgentReference",18355 "required": true,18356 "description": "A resolved agent reference with a concrete version."18357 },18358 {18359 "name": "agent.type",18360 "type": "\"agent\"",18361 "required": true,18362 "description": ""18363 },18364 {18365 "name": "agent.id",18366 "type": "string",18367 "required": true,18368 "description": ""18369 },18370 {18371 "name": "agent.version",18372 "type": "number",18373 "required": true,18374 "description": "",18375 "constraints": {18376 "format": "int32"18377 }18378 },18379 {18380 "name": "archived_at",18381 "type": "string or null",18382 "required": true,18383 "description": "A timestamp in RFC 3339 format",18384 "constraints": {18385 "format": "date-time"18386 }18387 },18388 {18389 "name": "created_at",18390 "type": "string",18391 "required": true,18392 "description": "A timestamp in RFC 3339 format",18393 "constraints": {18394 "format": "date-time"18395 }18396 },18397 {18398 "name": "description",18399 "type": "string or null",18400 "required": true,18401 "description": "Description of what the deployment does."18402 },18403 {18404 "name": "environment_id",18405 "type": "string",18406 "required": true,18407 "description": "ID of the `environment` where sessions run."18408 },18409 {18410 "name": "initial_events",18411 "type": "array of BetaManagedAgentsDeploymentInitialEvent",18412 "required": true,18413 "description": "Events sent to each session immediately after creation."18414 },18415 {18416 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>",18417 "type": "BetaManagedAgentsDeploymentUserMessageEvent object",18418 "required": false,18419 "description": "A user message sent to the session."18420 },18421 {18422 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.type",18423 "type": "\"user.message\"",18424 "required": true,18425 "description": ""18426 },18427 {18428 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content",18429 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock",18430 "required": true,18431 "description": "Array of content blocks for the user message."18432 },18433 {18434 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsTextBlock>",18435 "type": "BetaManagedAgentsTextBlock object",18436 "required": false,18437 "description": "Regular text content."18438 },18439 {18440 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsTextBlock>.type",18441 "type": "\"text\"",18442 "required": true,18443 "description": ""18444 },18445 {18446 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsTextBlock>.text",18447 "type": "string",18448 "required": true,18449 "description": "The text content.",18450 "constraints": {18451 "minLength": "1"18452 }18453 },18454 {18455 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsImageBlock>",18456 "type": "BetaManagedAgentsImageBlock object",18457 "required": false,18458 "description": "Image content specified directly as base64 data or as a reference via a URL."18459 },18460 {18461 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsImageBlock>.type",18462 "type": "\"image\"",18463 "required": true,18464 "description": ""18465 },18466 {18467 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsImageBlock>.source",18468 "type": "BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource",18469 "required": true,18470 "description": "Union type for image source variants."18471 },18472 {18473 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsBase64ImageSource>",18474 "type": "BetaManagedAgentsBase64ImageSource object",18475 "required": false,18476 "description": "Base64-encoded image data."18477 },18478 {18479 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsURLImageSource>",18480 "type": "BetaManagedAgentsURLImageSource object",18481 "required": false,18482 "description": "Image referenced by URL."18483 },18484 {18485 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsFileImageSource>",18486 "type": "BetaManagedAgentsFileImageSource object",18487 "required": false,18488 "description": "Image referenced by file ID."18489 },18490 {18491 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsDocumentBlock>",18492 "type": "BetaManagedAgentsDocumentBlock object",18493 "required": false,18494 "description": "Document content, either specified directly as base64 data, as text, or as a reference via a URL."18495 },18496 {18497 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsDocumentBlock>.type",18498 "type": "\"document\"",18499 "required": true,18500 "description": ""18501 },18502 {18503 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsDocumentBlock>.source",18504 "type": "BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource",18505 "required": true,18506 "description": "Union type for document source variants."18507 },18508 {18509 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsBase64DocumentSource>",18510 "type": "BetaManagedAgentsBase64DocumentSource object",18511 "required": false,18512 "description": "Base64-encoded document data."18513 },18514 {18515 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsPlainTextDocumentSource>",18516 "type": "BetaManagedAgentsPlainTextDocumentSource object",18517 "required": false,18518 "description": "Plain text document content."18519 },18520 {18521 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsURLDocumentSource>",18522 "type": "BetaManagedAgentsURLDocumentSource object",18523 "required": false,18524 "description": "Document referenced by URL."18525 },18526 {18527 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsFileDocumentSource>",18528 "type": "BetaManagedAgentsFileDocumentSource object",18529 "required": false,18530 "description": "Document referenced by file ID."18531 },18532 {18533 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsDocumentBlock>.context",18534 "type": "string or null",18535 "required": false,18536 "description": "Additional context about the document for the model."18537 },18538 {18539 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsDocumentBlock>.title",18540 "type": "string or null",18541 "required": false,18542 "description": "The title of the document."18543 },18544 {18545 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsRedactedBlock>",18546 "type": "BetaManagedAgentsRedactedBlock object",18547 "required": false,18548 "description": "Placeholder for content withheld by Anthropic model policy."18549 },18550 {18551 "name": "initial_events<BetaManagedAgentsDeploymentUserMessageEvent>.content<BetaManagedAgentsRedactedBlock>.type",18552 "type": "\"redacted\"",18553 "required": true,18554 "description": ""18555 },18556 {18557 "name": "initial_events<BetaManagedAgentsDeploymentUserDefineOutcomeEvent>",18558 "type": "BetaManagedAgentsDeploymentUserDefineOutcomeEvent object",18559 "required": false,18560 "description": "An outcome the agent should work toward. The agent begins work on receipt."18561 },18562 {18563 "name": "initial_events<BetaManagedAgentsDeploymentUserDefineOutcomeEvent>.type",18564 "type": "\"user.define_outcome\"",18565 "required": true,18566 "description": ""18567 },18568 {18569 "name": "initial_events<BetaManagedAgentsDeploymentUserDefineOutcomeEvent>.description",18570 "type": "string",18571 "required": true,18572 "description": "What the agent should produce. This is the task specification."18573 },18574 {18575 "name": "initial_events<BetaManagedAgentsDeploymentUserDefineOutcomeEvent>.rubric",18576 "type": "BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric",18577 "required": true,18578 "description": "Rubric for grading the quality of an outcome."18579 },18580 {18581 "name": "initial_events<BetaManagedAgentsDeploymentUserDefineOutcomeEvent>.rubric<BetaManagedAgentsFileRubric>",18582 "type": "BetaManagedAgentsFileRubric object",18583 "required": false,18584 "description": "Rubric referenced by a file uploaded via the Files API."18585 },18586 {18587 "name": "initial_events<BetaManagedAgentsDeploymentUserDefineOutcomeEvent>.rubric<BetaManagedAgentsFileRubric>.type",18588 "type": "\"file\"",18589 "required": true,18590 "description": ""18591 },18592 {18593 "name": "initial_events<BetaManagedAgentsDeploymentUserDefineOutcomeEvent>.rubric<BetaManagedAgentsFileRubric>.file_id",18594 "type": "string",18595 "required": true,18596 "description": "ID of the rubric file."18597 },18598 {18599 "name": "initial_events<BetaManagedAgentsDeploymentUserDefineOutcomeEvent>.rubric<BetaManagedAgentsTextRubric>",18600 "type": "BetaManagedAgentsTextRubric object",18601 "required": false,18602 "description": "Rubric content provided inline as text."18603 },18604 {18605 "name": "initial_events<BetaManagedAgentsDeploymentUserDefineOutcomeEvent>.rubric<BetaManagedAgentsTextRubric>.type",18606 "type": "\"text\"",18607 "required": true,18608 "description": ""18609 },18610 {18611 "name": "initial_events<BetaManagedAgentsDeploymentUserDefineOutcomeEvent>.rubric<BetaManagedAgentsTextRubric>.content",18612 "type": "string",18613 "required": true,18614 "description": "Rubric content. Plain text or markdown — the grader treats it as freeform text."18615 },18616 {18617 "name": "initial_events<BetaManagedAgentsDeploymentUserDefineOutcomeEvent>.max_iterations",18618 "type": "number or null",18619 "required": false,18620 "description": "Eval→revision cycles before giving up. Default 3, max 20.",18621 "constraints": {18622 "format": "int32"18623 }18624 },18625 {18626 "name": "initial_events<BetaManagedAgentsDeploymentSystemMessageEvent>",18627 "type": "BetaManagedAgentsDeploymentSystemMessageEvent object",18628 "required": false,18629 "description": "Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: \"system\"` turn rather than replacing the top-level system prompt."18630 },18631 {18632 "name": "initial_events<BetaManagedAgentsDeploymentSystemMessageEvent>.type",18633 "type": "\"system.message\"",18634 "required": true,18635 "description": ""18636 },18637 {18638 "name": "initial_events<BetaManagedAgentsDeploymentSystemMessageEvent>.content",18639 "type": "array of BetaManagedAgentsSystemContentBlock",18640 "required": true,18641 "description": "System content blocks to append. Text-only."18642 },18643 {18644 "name": "initial_events<BetaManagedAgentsDeploymentSystemMessageEvent>.content.type",18645 "type": "\"text\"",18646 "required": true,18647 "description": ""18648 },18649 {18650 "name": "initial_events<BetaManagedAgentsDeploymentSystemMessageEvent>.content.text",18651 "type": "string",18652 "required": true,18653 "description": "The text content.",18654 "constraints": {18655 "minLength": "1"18656 }18657 },18658 {18659 "name": "metadata",18660 "type": "map[string]",18661 "required": true,18662 "description": "Arbitrary key-value metadata. Maximum 16 pairs."18663 },18664 {18665 "name": "name",18666 "type": "string",18667 "required": true,18668 "description": "Human-readable name."18669 },18670 {18671 "name": "paused_reason",18672 "type": "BetaManagedAgentsDeploymentPausedReason or null",18673 "required": true,18674 "description": "Why a deployment is paused. Non-null exactly when `status` is `paused`."18675 },18676 {18677 "name": "paused_reason<BetaManagedAgentsManualDeploymentPausedReason>",18678 "type": "BetaManagedAgentsManualDeploymentPausedReason object",18679 "required": false,18680 "description": "The caller invoked the pause endpoint on the deployment."18681 },18682 {18683 "name": "paused_reason<BetaManagedAgentsManualDeploymentPausedReason>.type",18684 "type": "\"manual\"",18685 "required": true,18686 "description": ""18687 },18688 {18689 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>",18690 "type": "BetaManagedAgentsErrorDeploymentPausedReason object",18691 "required": false,18692 "description": "A scheduled fire recorded a failed run whose error auto-pauses the deployment."18693 },18694 {18695 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.type",18696 "type": "\"error\"",18697 "required": true,18698 "description": ""18699 },18700 {18701 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error",18702 "type": "BetaManagedAgentsDeploymentPausedReasonError",18703 "required": true,18704 "description": "The error that triggered an auto-pause. Matches the failed run's `error.type`."18705 },18706 {18707 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError>",18708 "type": "BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object",18709 "required": false,18710 "description": "The deployment's environment was archived."18711 },18712 {18713 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError>.type",18714 "type": "\"environment_archived_error\"",18715 "required": true,18716 "description": ""18717 },18718 {18719 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsAgentArchivedDeploymentPausedReasonError>",18720 "type": "BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object",18721 "required": false,18722 "description": "The deployment's agent was archived."18723 },18724 {18725 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsAgentArchivedDeploymentPausedReasonError>.type",18726 "type": "\"agent_archived_error\"",18727 "required": true,18728 "description": ""18729 },18730 {18731 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError>",18732 "type": "BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object",18733 "required": false,18734 "description": "The deployment's environment no longer exists."18735 },18736 {18737 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError>.type",18738 "type": "\"environment_not_found_error\"",18739 "required": true,18740 "description": ""18741 },18742 {18743 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError>",18744 "type": "BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object",18745 "required": false,18746 "description": "A vault referenced by the deployment no longer exists."18747 },18748 {18749 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError>.type",18750 "type": "\"vault_not_found_error\"",18751 "required": true,18752 "description": ""18753 },18754 {18755 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsFileNotFoundDeploymentPausedReasonError>",18756 "type": "BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object",18757 "required": false,18758 "description": "A file resource referenced by the deployment no longer exists."18759 },18760 {18761 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsFileNotFoundDeploymentPausedReasonError>.type",18762 "type": "\"file_not_found_error\"",18763 "required": true,18764 "description": ""18765 },18766 {18767 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError>",18768 "type": "BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object",18769 "required": false,18770 "description": "A referenced resource no longer exists and its kind was not reported."18771 },18772 {18773 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError>.type",18774 "type": "\"session_resource_not_found_error\"",18775 "required": true,18776 "description": ""18777 },18778 {18779 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError>",18780 "type": "BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object",18781 "required": false,18782 "description": "The deployment's workspace was archived."18783 },18784 {18785 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError>.type",18786 "type": "\"workspace_archived_error\"",18787 "required": true,18788 "description": ""18789 },18790 {18791 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError>",18792 "type": "BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object",18793 "required": false,18794 "description": "The deployment's organization is disabled."18795 },18796 {18797 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError>.type",18798 "type": "\"organization_disabled_error\"",18799 "required": true,18800 "description": ""18801 },18802 {18803 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError>",18804 "type": "BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object",18805 "required": false,18806 "description": "A memory store referenced by the deployment is archived."18807 },18808 {18809 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError>.type",18810 "type": "\"memory_store_archived_error\"",18811 "required": true,18812 "description": ""18813 },18814 {18815 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError>",18816 "type": "BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object",18817 "required": false,18818 "description": "A skill referenced by the deployment's agent no longer exists."18819 },18820 {18821 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError>.type",18822 "type": "\"skill_not_found_error\"",18823 "required": true,18824 "description": ""18825 },18826 {18827 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsVaultArchivedDeploymentPausedReasonError>",18828 "type": "BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object",18829 "required": false,18830 "description": "A vault referenced by the deployment is archived."18831 },18832 {18833 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsVaultArchivedDeploymentPausedReasonError>.type",18834 "type": "\"vault_archived_error\"",18835 "required": true,18836 "description": ""18837 },18838 {18839 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsUnknownDeploymentPausedReasonError>",18840 "type": "BetaManagedAgentsUnknownDeploymentPausedReasonError object",18841 "required": false,18842 "description": "An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`."18843 },18844 {18845 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsUnknownDeploymentPausedReasonError>.type",18846 "type": "\"unknown_error\"",18847 "required": true,18848 "description": ""18849 },18850 {18851 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError>",18852 "type": "BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object",18853 "required": false,18854 "description": "The deployment configures resources, but its environment is self-hosted and cannot mount them."18855 },18856 {18857 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError>.type",18858 "type": "\"self_hosted_resources_unsupported_error\"",18859 "required": true,18860 "description": ""18861 },18862 {18863 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError>",18864 "type": "BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object",18865 "required": false,18866 "description": "An MCP server host used by the deployment's agent is blocked by the environment's network policy."18867 },18868 {18869 "name": "paused_reason<BetaManagedAgentsErrorDeploymentPausedReason>.error<BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError>.type",18870 "type": "\"mcp_egress_blocked_error\"",18871 "required": true,18872 "description": ""18873 },18874 {18875 "name": "resources",18876 "type": "array of BetaManagedAgentsSessionResourceConfig",18877 "required": true,18878 "description": "Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials."18879 },18880 {18881 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceConfig>",18882 "type": "BetaManagedAgentsGitHubRepositoryResourceConfig object",18883 "required": false,18884 "description": "A GitHub repository mounted into each session's container. The authorization token is write-only and never returned."18885 },18886 {18887 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceConfig>.type",18888 "type": "\"github_repository\"",18889 "required": true,18890 "description": ""18891 },18892 {18893 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceConfig>.url",18894 "type": "string",18895 "required": true,18896 "description": "Github URL of the repository"18897 },18898 {18899 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceConfig>.checkout",18900 "type": "BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null",18901 "required": false,18902 "description": "Branch or commit to check out. Defaults to the repository's default branch."18903 },18904 {18905 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceConfig>.checkout<BetaManagedAgentsBranchCheckout>",18906 "type": "BetaManagedAgentsBranchCheckout object",18907 "required": false,18908 "description": ""18909 },18910 {18911 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceConfig>.checkout<BetaManagedAgentsBranchCheckout>.type",18912 "type": "\"branch\"",18913 "required": true,18914 "description": ""18915 },18916 {18917 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceConfig>.checkout<BetaManagedAgentsBranchCheckout>.name",18918 "type": "string",18919 "required": true,18920 "description": "Branch name to check out.",18921 "constraints": {18922 "minLength": "1",18923 "maxLength": "255"18924 }18925 },18926 {18927 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceConfig>.checkout<BetaManagedAgentsCommitCheckout>",18928 "type": "BetaManagedAgentsCommitCheckout object",18929 "required": false,18930 "description": ""18931 },18932 {18933 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceConfig>.checkout<BetaManagedAgentsCommitCheckout>.type",18934 "type": "\"commit\"",18935 "required": true,18936 "description": ""18937 },18938 {18939 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceConfig>.checkout<BetaManagedAgentsCommitCheckout>.sha",18940 "type": "string",18941 "required": true,18942 "description": "Full commit SHA to check out.",18943 "constraints": {18944 "minLength": "7",18945 "maxLength": "64"18946 }18947 },18948 {18949 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceConfig>.mount_path",18950 "type": "string or null",18951 "required": false,18952 "description": "Mount path in the container. Defaults to `/workspace/<repo-name>`."18953 },18954 {18955 "name": "resources<BetaManagedAgentsFileResourceConfig>",18956 "type": "BetaManagedAgentsFileResourceConfig object",18957 "required": false,18958 "description": "A file mounted into each session's container."18959 },18960 {18961 "name": "resources<BetaManagedAgentsFileResourceConfig>.type",18962 "type": "\"file\"",18963 "required": true,18964 "description": ""18965 },18966 {18967 "name": "resources<BetaManagedAgentsFileResourceConfig>.file_id",18968 "type": "string",18969 "required": true,18970 "description": "ID of a previously uploaded file."18971 },18972 {18973 "name": "resources<BetaManagedAgentsFileResourceConfig>.mount_path",18974 "type": "string or null",18975 "required": false,18976 "description": "Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`."18977 },18978 {18979 "name": "resources<BetaManagedAgentsMemoryStoreResourceConfig>",18980 "type": "BetaManagedAgentsMemoryStoreResourceConfig object",18981 "required": false,18982 "description": "A memory store attached to each session created from this deployment."18983 },18984 {18985 "name": "resources<BetaManagedAgentsMemoryStoreResourceConfig>.type",18986 "type": "\"memory_store\"",18987 "required": true,18988 "description": ""18989 },18990 {18991 "name": "resources<BetaManagedAgentsMemoryStoreResourceConfig>.memory_store_id",18992 "type": "string",18993 "required": true,18994 "description": "The memory store ID (memstore_...). Must belong to the caller's organization and workspace."18995 },18996 {18997 "name": "resources<BetaManagedAgentsMemoryStoreResourceConfig>.access",18998 "type": "\"read_write\" or \"read_only\" or null",18999 "required": false,19000 "description": "Access mode for an attached memory store.",19001 "enum": [19002 "read_write",19003 "read_only"19004 ]19005 },19006 {19007 "name": "resources<BetaManagedAgentsMemoryStoreResourceConfig>.instructions",19008 "type": "string or null",19009 "required": false,19010 "description": "Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars."19011 },19012 {19013 "name": "schedule",19014 "type": "BetaManagedAgentsSchedule or null",19015 "required": true,19016 "description": "5-field POSIX cron schedule with computed runtime timestamps."19017 },19018 {19019 "name": "schedule.type",19020 "type": "\"cron\"",19021 "required": true,19022 "description": ""19023 },19024 {19025 "name": "schedule.expression",19026 "type": "string",19027 "required": true,19028 "description": "5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., \"0 9 * * 1-5\" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily).",19029 "constraints": {19030 "minLength": "1",19031 "maxLength": "256"19032 }19033 },19034 {19035 "name": "schedule.timezone",19036 "type": "string",19037 "required": true,19038 "description": "IANA timezone identifier (e.g., \"America/Los_Angeles\", \"UTC\").",19039 "constraints": {19040 "minLength": "1"19041 }19042 },19043 {19044 "name": "schedule.last_run_at",19045 "type": "string or null",19046 "required": false,19047 "description": "A timestamp in RFC 3339 format",19048 "constraints": {19049 "format": "date-time"19050 }19051 },19052 {19053 "name": "schedule.upcoming_runs_at",19054 "type": "array of string",19055 "required": false,19056 "description": "Up to 5 timestamps of upcoming cron occurrences. Non-empty for active and paused deployments (reflects what the schedule would do if unpaused); empty once the deployment is archived (`archived_at` set). Each fire is offset by a small per-schedule jitter, so a run will actually start at or shortly after its listed time."19057 },19058 {19059 "name": "status",19060 "type": "BetaManagedAgentsDeploymentStatus",19061 "required": true,19062 "description": "Lifecycle status of a deployment.",19063 "enum": [19064 "active",19065 "paused"19066 ]19067 },19068 {19069 "name": "updated_at",19070 "type": "string",19071 "required": true,19072 "description": "A timestamp in RFC 3339 format",19073 "constraints": {19074 "format": "date-time"19075 }19076 },19077 {19078 "name": "vault_ids",19079 "type": "array of string",19080 "required": true,19081 "description": "Vault IDs supplying stored credentials for sessions created from this deployment."19082 },19083 {19084 "name": "budget",19085 "type": "BetaManagedAgentsBudgetLimit or null",19086 "required": false,19087 "description": "A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`."19088 },19089 {19090 "name": "budget.type",19091 "type": "\"limit\"",19092 "required": true,19093 "description": ""19094 },19095 {19096 "name": "budget.max_list_cost",19097 "type": "BetaMonetaryAmount",19098 "required": true,19099 "description": "A monetary amount in a specific currency."19100 },19101 {19102 "name": "budget.max_list_cost.amount",19103 "type": "string",19104 "required": true,19105 "description": "Amount in minor units of the currency, as an integer decimal string with no leading zeros: \"2500\" is $25.00 and \"50\" is fifty cents. A string rather than a number so no float rounding is ever applied."19106 },19107 {19108 "name": "budget.max_list_cost.currency",19109 "type": "BetaCurrency",19110 "required": true,19111 "description": "Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced."19112 }19113 ],19114 "status": [19115 "DOCUMENTED",19116 "BETA"19117 ],19118 "sources": [19119 {19120 "url": "https://platform.claude.com/docs/en/api/beta/deployments/create",19121 "retrieved_at": "2026-09-18"19122 },19123 {19124 "url": "https://platform.claude.com/docs/en/managed-agents/scheduled-deployments",19125 "retrieved_at": "2026-09-18"19126 }19127 ],19128 "beta_header": "managed-agents-2026-04-01"19129 },19130 {19131 "provider": "anthropic",19132 "api_family": "managed-agents",19133 "name": "DeploymentCreateParams (request body)",19134 "official_type_name": "BetaManagedAgentsDeploymentCreateParams",19135 "description": "Create Deployment",19136 "fields": [19137 {19138 "name": "agent",19139 "type": "string or BetaManagedAgentsAgentParams",19140 "required": true,19141 "description": "Agent to deploy. Accepts the `agent` ID string, which pins the latest version, or an `agent` object with both id and version specified. The agent must exist and not be archived."19142 },19143 {19144 "name": "agent<string>",19145 "type": "string",19146 "required": false,19147 "description": ""19148 },19149 {19150 "name": "agent<BetaManagedAgentsAgentParams>",19151 "type": "BetaManagedAgentsAgentParams object",19152 "required": false,19153 "description": "Specification for an Agent. Provide a specific `version` or use the short-form `agent=\"agent_id\"` for the most recent version"19154 },19155 {19156 "name": "agent<BetaManagedAgentsAgentParams>.type",19157 "type": "\"agent\"",19158 "required": true,19159 "description": ""19160 },19161 {19162 "name": "agent<BetaManagedAgentsAgentParams>.id",19163 "type": "string",19164 "required": true,19165 "description": "The `agent` ID.",19166 "constraints": {19167 "minLength": "1",19168 "maxLength": "128"19169 }19170 },19171 {19172 "name": "agent<BetaManagedAgentsAgentParams>.version",19173 "type": "number",19174 "required": false,19175 "description": "The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.",19176 "constraints": {19177 "format": "int32"19178 }19179 },19180 {19181 "name": "environment_id",19182 "type": "string",19183 "required": true,19184 "description": "ID of the `environment` defining the container configuration for sessions created from this deployment.",19185 "constraints": {19186 "minLength": "1",19187 "maxLength": "128"19188 }19189 },19190 {19191 "name": "initial_events",19192 "type": "array of BetaManagedAgentsDeploymentInitialEventParams",19193 "required": true,19194 "description": "Events to send to each session immediately after creation. At least 1, maximum 50."19195 },19196 {19197 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>",19198 "type": "BetaManagedAgentsUserMessageEventParams object",19199 "required": false,19200 "description": "Parameters for sending a user message to the session."19201 },19202 {19203 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.type",19204 "type": "\"user.message\"",19205 "required": true,19206 "description": ""19207 },19208 {19209 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content",19210 "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock",19211 "required": true,19212 "description": "Array of content blocks for the user message."19213 },19214 {19215 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsTextBlock>",19216 "type": "BetaManagedAgentsTextBlock object",19217 "required": false,19218 "description": "Regular text content."19219 },19220 {19221 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsTextBlock>.type",19222 "type": "\"text\"",19223 "required": true,19224 "description": ""19225 },19226 {19227 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsTextBlock>.text",19228 "type": "string",19229 "required": true,19230 "description": "The text content.",19231 "constraints": {19232 "minLength": "1"19233 }19234 },19235 {19236 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>",19237 "type": "BetaManagedAgentsImageBlock object",19238 "required": false,19239 "description": "Image content specified directly as base64 data or as a reference via a URL."19240 },19241 {19242 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.type",19243 "type": "\"image\"",19244 "required": true,19245 "description": ""19246 },19247 {19248 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source",19249 "type": "BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource",19250 "required": true,19251 "description": "Union type for image source variants."19252 },19253 {19254 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsBase64ImageSource>",19255 "type": "BetaManagedAgentsBase64ImageSource object",19256 "required": false,19257 "description": "Base64-encoded image data."19258 },19259 {19260 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsURLImageSource>",19261 "type": "BetaManagedAgentsURLImageSource object",19262 "required": false,19263 "description": "Image referenced by URL."19264 },19265 {19266 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsImageBlock>.source<BetaManagedAgentsFileImageSource>",19267 "type": "BetaManagedAgentsFileImageSource object",19268 "required": false,19269 "description": "Image referenced by file ID."19270 },19271 {19272 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>",19273 "type": "BetaManagedAgentsDocumentBlock object",19274 "required": false,19275 "description": "Document content, either specified directly as base64 data, as text, or as a reference via a URL."19276 },19277 {19278 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.type",19279 "type": "\"document\"",19280 "required": true,19281 "description": ""19282 },19283 {19284 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source",19285 "type": "BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource",19286 "required": true,19287 "description": "Union type for document source variants."19288 },19289 {19290 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsBase64DocumentSource>",19291 "type": "BetaManagedAgentsBase64DocumentSource object",19292 "required": false,19293 "description": "Base64-encoded document data."19294 },19295 {19296 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsPlainTextDocumentSource>",19297 "type": "BetaManagedAgentsPlainTextDocumentSource object",19298 "required": false,19299 "description": "Plain text document content."19300 },19301 {19302 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsURLDocumentSource>",19303 "type": "BetaManagedAgentsURLDocumentSource object",19304 "required": false,19305 "description": "Document referenced by URL."19306 },19307 {19308 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.source<BetaManagedAgentsFileDocumentSource>",19309 "type": "BetaManagedAgentsFileDocumentSource object",19310 "required": false,19311 "description": "Document referenced by file ID."19312 },19313 {19314 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.context",19315 "type": "string or null",19316 "required": false,19317 "description": "Additional context about the document for the model."19318 },19319 {19320 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsDocumentBlock>.title",19321 "type": "string or null",19322 "required": false,19323 "description": "The title of the document."19324 },19325 {19326 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsRedactedBlock>",19327 "type": "BetaManagedAgentsRedactedBlock object",19328 "required": false,19329 "description": "Placeholder for content withheld by Anthropic model policy."19330 },19331 {19332 "name": "initial_events<BetaManagedAgentsUserMessageEventParams>.content<BetaManagedAgentsRedactedBlock>.type",19333 "type": "\"redacted\"",19334 "required": true,19335 "description": ""19336 },19337 {19338 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>",19339 "type": "BetaManagedAgentsUserDefineOutcomeEventParams object",19340 "required": false,19341 "description": "Parameters for defining an outcome the agent should work toward. The agent begins work on receipt."19342 },19343 {19344 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.type",19345 "type": "\"user.define_outcome\"",19346 "required": true,19347 "description": ""19348 },19349 {19350 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.description",19351 "type": "string",19352 "required": true,19353 "description": "What the agent should produce. This is the task specification."19354 },19355 {19356 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric",19357 "type": "BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams",19358 "required": true,19359 "description": "Rubric for grading the quality of an outcome."19360 },19361 {19362 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsFileRubricParams>",19363 "type": "BetaManagedAgentsFileRubricParams object",19364 "required": false,19365 "description": "Rubric referenced by a file uploaded via the Files API."19366 },19367 {19368 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsFileRubricParams>.type",19369 "type": "\"file\"",19370 "required": true,19371 "description": ""19372 },19373 {19374 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsFileRubricParams>.file_id",19375 "type": "string",19376 "required": true,19377 "description": "ID of the rubric file."19378 },19379 {19380 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsTextRubricParams>",19381 "type": "BetaManagedAgentsTextRubricParams object",19382 "required": false,19383 "description": "Rubric content provided inline as text."19384 },19385 {19386 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsTextRubricParams>.type",19387 "type": "\"text\"",19388 "required": true,19389 "description": ""19390 },19391 {19392 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.rubric<BetaManagedAgentsTextRubricParams>.content",19393 "type": "string",19394 "required": true,19395 "description": "Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.",19396 "constraints": {19397 "maxLength": "262144"19398 }19399 },19400 {19401 "name": "initial_events<BetaManagedAgentsUserDefineOutcomeEventParams>.max_iterations",19402 "type": "number or null",19403 "required": false,19404 "description": "Eval→revision cycles before giving up. Default 3, max 20.",19405 "constraints": {19406 "format": "int32"19407 }19408 },19409 {19410 "name": "initial_events<BetaManagedAgentsSystemMessageEventParams>",19411 "type": "BetaManagedAgentsSystemMessageEventParams object",19412 "required": false,19413 "description": "Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: \"system\"` turn rather than replacing the top-level system prompt. At most one per request: it must be the final event and immediately follow the `user.message`, `user.tool_result`, or `user.custom_tool_result` it accompanies. Only supported on models that accept mid-conversation system messages."19414 },19415 {19416 "name": "initial_events<BetaManagedAgentsSystemMessageEventParams>.type",19417 "type": "\"system.message\"",19418 "required": true,19419 "description": ""19420 },19421 {19422 "name": "initial_events<BetaManagedAgentsSystemMessageEventParams>.content",19423 "type": "array of BetaManagedAgentsSystemContentBlock",19424 "required": true,19425 "description": "System content blocks to append. Text-only."19426 },19427 {19428 "name": "initial_events<BetaManagedAgentsSystemMessageEventParams>.content.type",19429 "type": "\"text\"",19430 "required": true,19431 "description": ""19432 },19433 {19434 "name": "initial_events<BetaManagedAgentsSystemMessageEventParams>.content.text",19435 "type": "string",19436 "required": true,19437 "description": "The text content.",19438 "constraints": {19439 "minLength": "1"19440 }19441 },19442 {19443 "name": "name",19444 "type": "string",19445 "required": true,19446 "description": "Human-readable name for the deployment.",19447 "constraints": {19448 "minLength": "1",19449 "maxLength": "256"19450 }19451 },19452 {19453 "name": "budget",19454 "type": "BetaManagedAgentsBudgetLimit or null",19455 "required": false,19456 "description": "A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`."19457 },19458 {19459 "name": "budget.type",19460 "type": "\"limit\"",19461 "required": true,19462 "description": ""19463 },19464 {19465 "name": "budget.max_list_cost",19466 "type": "BetaMonetaryAmount",19467 "required": true,19468 "description": "A monetary amount in a specific currency."19469 },19470 {19471 "name": "budget.max_list_cost.amount",19472 "type": "string",19473 "required": true,19474 "description": "Amount in minor units of the currency, as an integer decimal string with no leading zeros: \"2500\" is $25.00 and \"50\" is fifty cents. A string rather than a number so no float rounding is ever applied."19475 },19476 {19477 "name": "budget.max_list_cost.currency",19478 "type": "BetaCurrency",19479 "required": true,19480 "description": "Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced."19481 },19482 {19483 "name": "description",19484 "type": "string or null",19485 "required": false,19486 "description": "Description of what the deployment does.",19487 "constraints": {19488 "maxLength": "2048"19489 }19490 },19491 {19492 "name": "metadata",19493 "type": "map[string]",19494 "required": false,19495 "description": "Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars."19496 },19497 {19498 "name": "resources",19499 "type": "array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam",19500 "required": false,19501 "description": "Resources (e.g. repositories, files) to mount into each session's container. Maximum 500."19502 },19503 {19504 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>",19505 "type": "BetaManagedAgentsGitHubRepositoryResourceParams object",19506 "required": false,19507 "description": "Mount a GitHub repository into the session's container."19508 },19509 {19510 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.type",19511 "type": "\"github_repository\"",19512 "required": true,19513 "description": ""19514 },19515 {19516 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.url",19517 "type": "string",19518 "required": true,19519 "description": "Github URL of the repository",19520 "constraints": {19521 "minLength": "1",19522 "maxLength": "2048"19523 }19524 },19525 {19526 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.authorization_token",19527 "type": "string",19528 "required": false,19529 "description": "GitHub authorization token used to clone the repository. Required for private repositories; optional for public ones.",19530 "constraints": {19531 "minLength": "1",19532 "maxLength": "4096"19533 }19534 },19535 {19536 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.checkout",19537 "type": "BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null",19538 "required": false,19539 "description": "Branch or commit to check out. Defaults to the repository's default branch."19540 },19541 {19542 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.checkout<BetaManagedAgentsBranchCheckout>",19543 "type": "BetaManagedAgentsBranchCheckout object",19544 "required": false,19545 "description": ""19546 },19547 {19548 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.checkout<BetaManagedAgentsBranchCheckout>.type",19549 "type": "\"branch\"",19550 "required": true,19551 "description": ""19552 },19553 {19554 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.checkout<BetaManagedAgentsBranchCheckout>.name",19555 "type": "string",19556 "required": true,19557 "description": "Branch name to check out.",19558 "constraints": {19559 "minLength": "1",19560 "maxLength": "255"19561 }19562 },19563 {19564 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.checkout<BetaManagedAgentsCommitCheckout>",19565 "type": "BetaManagedAgentsCommitCheckout object",19566 "required": false,19567 "description": ""19568 },19569 {19570 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.checkout<BetaManagedAgentsCommitCheckout>.type",19571 "type": "\"commit\"",19572 "required": true,19573 "description": ""19574 },19575 {19576 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.checkout<BetaManagedAgentsCommitCheckout>.sha",19577 "type": "string",19578 "required": true,19579 "description": "Full commit SHA to check out.",19580 "constraints": {19581 "minLength": "7",19582 "maxLength": "64"19583 }19584 },19585 {19586 "name": "resources<BetaManagedAgentsGitHubRepositoryResourceParams>.mount_path",19587 "type": "string or null",19588 "required": false,19589 "description": "Mount path in the container. Defaults to `/workspace/<repo-name>`.",19590 "constraints": {19591 "minLength": "1",19592 "maxLength": "4096"19593 }19594 },19595 {19596 "name": "resources<BetaManagedAgentsFileResourceParams>",19597 "type": "BetaManagedAgentsFileResourceParams object",19598 "required": false,19599 "description": "Mount a file uploaded via the Files API into the session."19600 },19601 {19602 "name": "resources<BetaManagedAgentsFileResourceParams>.type",19603 "type": "\"file\"",19604 "required": true,19605 "description": ""19606 },19607 {19608 "name": "resources<BetaManagedAgentsFileResourceParams>.file_id",19609 "type": "string",19610 "required": true,19611 "description": "ID of a previously uploaded file.",19612 "constraints": {19613 "minLength": "1",19614 "maxLength": "128"19615 }19616 },19617 {19618 "name": "resources<BetaManagedAgentsFileResourceParams>.mount_path",19619 "type": "string or null",19620 "required": false,19621 "description": "Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.",19622 "constraints": {19623 "minLength": "1",19624 "maxLength": "4096"19625 }19626 },19627 {19628 "name": "resources<BetaManagedAgentsMemoryStoreResourceParam>",19629 "type": "BetaManagedAgentsMemoryStoreResourceParam object",19630 "required": false,19631 "description": "Parameters for attaching a memory store to an agent session."19632 },19633 {19634 "name": "resources<BetaManagedAgentsMemoryStoreResourceParam>.type",19635 "type": "\"memory_store\"",19636 "required": true,19637 "description": ""19638 },19639 {19640 "name": "resources<BetaManagedAgentsMemoryStoreResourceParam>.memory_store_id",19641 "type": "string",19642 "required": true,19643 "description": "The memory store ID (memstore_...). Must belong to the caller's organization and workspace."19644 },19645 {19646 "name": "resources<BetaManagedAgentsMemoryStoreResourceParam>.access",19647 "type": "\"read_write\" or \"read_only\" or null",19648 "required": false,19649 "description": "Access mode for an attached memory store.",19650 "enum": [19651 "read_write",19652 "read_only"19653 ]19654 },19655 {19656 "name": "resources<BetaManagedAgentsMemoryStoreResourceParam>.instructions",19657 "type": "string or null",19658 "required": false,19659 "description": "Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.",19660 "constraints": {19661 "maxLength": "4096"19662 }19663 },19664 {19665 "name": "schedule",19666 "type": "BetaManagedAgentsScheduleParams or null",19667 "required": false,19668 "description": "5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone."19669 },19670 {19671 "name": "schedule.type",19672 "type": "\"cron\"",19673 "required": true,19674 "description": ""19675 },19676 {19677 "name": "schedule.expression",19678 "type": "string",19679 "required": true,19680 "description": "5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., \"0 9 * * 1-5\" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily).",19681 "constraints": {19682 "minLength": "1",19683 "maxLength": "256"19684 }19685 },19686 {19687 "name": "schedule.timezone",19688 "type": "string",19689 "required": true,19690 "description": "Required. IANA timezone identifier (e.g., \"America/Los_Angeles\", \"UTC\"). Validated against the IANA timezone database.",19691 "constraints": {19692 "minLength": "1"19693 }19694 },19695 {19696 "name": "vault_ids",19697 "type": "array of string",19698 "required": false,19699 "description": "Vault IDs for stored credentials the agent can use during sessions created from this deployment. Maximum 50."19700 }19701 ],19702 "status": [19703 "DOCUMENTED",19704 "BETA"19705 ],19706 "sources": [19707 {19708 "url": "https://platform.claude.com/docs/en/api/beta/deployments/create",19709 "retrieved_at": "2026-09-18"19710 },19711 {19712 "url": "https://platform.claude.com/docs/en/managed-agents/scheduled-deployments",19713 "retrieved_at": "2026-09-18"19714 },19715 {19716 "url": "https://platform.claude.com/docs/en/managed-agents/budgets",19717 "retrieved_at": "2026-09-18"19718 }19719 ],19720 "beta_header": "managed-agents-2026-04-01"19721 },19722 {19723 "provider": "anthropic",19724 "api_family": "managed-agents",19725 "name": "DeploymentRun",19726 "official_type_name": "BetaManagedAgentsDeploymentRun",19727 "description": "A persistent, append-only record of a single deployment execution. Records session creation success or failure — no session lifecycle tracking.",19728 "fields": [19729 {19730 "name": "type",19731 "type": "\"deployment_run\"",19732 "required": true,19733 "description": ""19734 },19735 {19736 "name": "id",19737 "type": "string",19738 "required": true,19739 "description": "Unique identifier for this run (`drun_...`)."19740 },19741 {19742 "name": "agent",19743 "type": "BetaManagedAgentsAgentReference",19744 "required": true,19745 "description": "A resolved agent reference with a concrete version."19746 },19747 {19748 "name": "agent.type",19749 "type": "\"agent\"",19750 "required": true,19751 "description": ""19752 },19753 {19754 "name": "agent.id",19755 "type": "string",19756 "required": true,19757 "description": ""19758 },19759 {19760 "name": "agent.version",19761 "type": "number",19762 "required": true,19763 "description": "",19764 "constraints": {19765 "format": "int32"19766 }19767 },19768 {19769 "name": "created_at",19770 "type": "string",19771 "required": true,19772 "description": "A timestamp in RFC 3339 format",19773 "constraints": {19774 "format": "date-time"19775 }19776 },19777 {19778 "name": "deployment_id",19779 "type": "string",19780 "required": true,19781 "description": "ID of the deployment that produced this run."19782 },19783 {19784 "name": "error",19785 "type": "BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null",19786 "required": true,19787 "description": "Why the run failed to create a session. The type identifies the failure; message is human-readable detail."19788 },19789 {19790 "name": "error<BetaManagedAgentsEnvironmentArchivedRunError>",19791 "type": "BetaManagedAgentsEnvironmentArchivedRunError object",19792 "required": false,19793 "description": "The deployment's environment was archived."19794 },19795 {19796 "name": "error<BetaManagedAgentsEnvironmentArchivedRunError>.type",19797 "type": "\"environment_archived_error\"",19798 "required": true,19799 "description": ""19800 },19801 {19802 "name": "error<BetaManagedAgentsEnvironmentArchivedRunError>.message",19803 "type": "string",19804 "required": true,19805 "description": "Human-readable error description."19806 },19807 {19808 "name": "error<BetaManagedAgentsAgentArchivedRunError>",19809 "type": "BetaManagedAgentsAgentArchivedRunError object",19810 "required": false,19811 "description": "The deployment's agent was archived."19812 },19813 {19814 "name": "error<BetaManagedAgentsAgentArchivedRunError>.type",19815 "type": "\"agent_archived_error\"",19816 "required": true,19817 "description": ""19818 },19819 {19820 "name": "error<BetaManagedAgentsAgentArchivedRunError>.message",19821 "type": "string",19822 "required": true,19823 "description": "Human-readable error description."19824 },19825 {19826 "name": "error<BetaManagedAgentsEnvironmentNotFoundRunError>",19827 "type": "BetaManagedAgentsEnvironmentNotFoundRunError object",19828 "required": false,19829 "description": "The deployment's environment no longer exists."19830 },19831 {19832 "name": "error<BetaManagedAgentsEnvironmentNotFoundRunError>.type",19833 "type": "\"environment_not_found_error\"",19834 "required": true,19835 "description": ""19836 },19837 {19838 "name": "error<BetaManagedAgentsEnvironmentNotFoundRunError>.message",19839 "type": "string",19840 "required": true,19841 "description": "Human-readable error description."19842 },19843 {19844 "name": "error<BetaManagedAgentsVaultNotFoundRunError>",19845 "type": "BetaManagedAgentsVaultNotFoundRunError object",19846 "required": false,19847 "description": "A vault referenced by the deployment no longer exists."19848 },19849 {19850 "name": "error<BetaManagedAgentsVaultNotFoundRunError>.type",19851 "type": "\"vault_not_found_error\"",19852 "required": true,19853 "description": ""19854 },19855 {19856 "name": "error<BetaManagedAgentsVaultNotFoundRunError>.message",19857 "type": "string",19858 "required": true,19859 "description": "Human-readable error description."19860 },19861 {19862 "name": "error<BetaManagedAgentsVaultArchivedRunError>",19863 "type": "BetaManagedAgentsVaultArchivedRunError object",19864 "required": false,19865 "description": "A vault referenced by the deployment is archived."19866 },19867 {19868 "name": "error<BetaManagedAgentsVaultArchivedRunError>.type",19869 "type": "\"vault_archived_error\"",19870 "required": true,19871 "description": ""19872 },19873 {19874 "name": "error<BetaManagedAgentsVaultArchivedRunError>.message",19875 "type": "string",19876 "required": true,19877 "description": "Human-readable error description."19878 },19879 {19880 "name": "error<BetaManagedAgentsFileNotFoundRunError>",19881 "type": "BetaManagedAgentsFileNotFoundRunError object",19882 "required": false,19883 "description": "A file resource referenced by the deployment no longer exists."19884 },19885 {19886 "name": "error<BetaManagedAgentsFileNotFoundRunError>.type",19887 "type": "\"file_not_found_error\"",19888 "required": true,19889 "description": ""19890 },19891 {19892 "name": "error<BetaManagedAgentsFileNotFoundRunError>.message",19893 "type": "string",19894 "required": true,19895 "description": "Human-readable error description."19896 },19897 {19898 "name": "error<BetaManagedAgentsMemoryStoreArchivedRunError>",19899 "type": "BetaManagedAgentsMemoryStoreArchivedRunError object",19900 "required": false,19901 "description": "A memory store referenced by the deployment is archived."19902 },19903 {19904 "name": "error<BetaManagedAgentsMemoryStoreArchivedRunError>.type",19905 "type": "\"memory_store_archived_error\"",19906 "required": true,19907 "description": ""19908 },19909 {19910 "name": "error<BetaManagedAgentsMemoryStoreArchivedRunError>.message",19911 "type": "string",19912 "required": true,19913 "description": "Human-readable error description."19914 },19915 {19916 "name": "error<BetaManagedAgentsSkillNotFoundRunError>",19917 "type": "BetaManagedAgentsSkillNotFoundRunError object",19918 "required": false,19919 "description": "A skill referenced by the deployment's agent no longer exists."19920 },19921 {19922 "name": "error<BetaManagedAgentsSkillNotFoundRunError>.type",19923 "type": "\"skill_not_found_error\"",19924 "required": true,19925 "description": ""19926 },19927 {19928 "name": "error<BetaManagedAgentsSkillNotFoundRunError>.message",19929 "type": "string",19930 "required": true,19931 "description": "Human-readable error description."19932 },19933 {19934 "name": "error<BetaManagedAgentsSessionResourceNotFoundRunError>",19935 "type": "BetaManagedAgentsSessionResourceNotFoundRunError object",19936 "required": false,19937 "description": "A referenced resource no longer exists and its kind was not reported."19938 },19939 {19940 "name": "error<BetaManagedAgentsSessionResourceNotFoundRunError>.type",19941 "type": "\"session_resource_not_found_error\"",19942 "required": true,19943 "description": ""19944 },19945 {19946 "name": "error<BetaManagedAgentsSessionResourceNotFoundRunError>.message",19947 "type": "string",19948 "required": true,19949 "description": "Human-readable error description."19950 },19951 {19952 "name": "error<BetaManagedAgentsWorkspaceArchivedRunError>",19953 "type": "BetaManagedAgentsWorkspaceArchivedRunError object",19954 "required": false,19955 "description": "The deployment's workspace was archived."19956 },19957 {19958 "name": "error<BetaManagedAgentsWorkspaceArchivedRunError>.type",19959 "type": "\"workspace_archived_error\"",19960 "required": true,19961 "description": ""19962 },19963 {19964 "name": "error<BetaManagedAgentsWorkspaceArchivedRunError>.message",19965 "type": "string",19966 "required": true,19967 "description": "Human-readable error description."19968 },19969 {19970 "name": "error<BetaManagedAgentsOrganizationDisabledRunError>",19971 "type": "BetaManagedAgentsOrganizationDisabledRunError object",19972 "required": false,19973 "description": "The deployment's organization is disabled."19974 },19975 {19976 "name": "error<BetaManagedAgentsOrganizationDisabledRunError>.type",19977 "type": "\"organization_disabled_error\"",19978 "required": true,19979 "description": ""19980 },19981 {19982 "name": "error<BetaManagedAgentsOrganizationDisabledRunError>.message",19983 "type": "string",19984 "required": true,19985 "description": "Human-readable error description."19986 },19987 {19988 "name": "error<BetaManagedAgentsSessionRateLimitedRunError>",19989 "type": "BetaManagedAgentsSessionRateLimitedRunError object",19990 "required": false,19991 "description": "Session creation was rejected due to rate limiting. The schedule keeps firing; subsequent runs may succeed."19992 },19993 {19994 "name": "error<BetaManagedAgentsSessionRateLimitedRunError>.type",19995 "type": "\"session_rate_limited_error\"",19996 "required": true,19997 "description": ""19998 },19999 {20000 "name": "error<BetaManagedAgentsSessionRateLimitedRunError>.message",20001 "type": "string",20002 "required": true,20003 "description": "Human-readable error description."20004 },20005 {20006 "name": "error<BetaManagedAgentsSessionCreationRejectedRunError>",20007 "type": "BetaManagedAgentsSessionCreationRejectedRunError object",20008 "required": false,20009 "description": "The session create request was rejected with a non-retryable validation error."20010 },20011 {20012 "name": "error<BetaManagedAgentsSessionCreationRejectedRunError>.type",20013 "type": "\"session_creation_rejected_error\"",20014 "required": true,20015 "description": ""20016 },20017 {20018 "name": "error<BetaManagedAgentsSessionCreationRejectedRunError>.message",20019 "type": "string",20020 "required": true,20021 "description": "Human-readable error description."20022 },20023 {20024 "name": "error<BetaManagedAgentsUnknownRunError>",20025 "type": "BetaManagedAgentsUnknownRunError object",20026 "required": false,20027 "description": "An unknown or unexpected error caused the run to fail. A fallback variant; clients that do not recognize a new error type can match on message alone."20028 },20029 {20030 "name": "error<BetaManagedAgentsUnknownRunError>.type",20031 "type": "\"unknown_error\"",20032 "required": true,20033 "description": ""20034 },20035 {20036 "name": "error<BetaManagedAgentsUnknownRunError>.message",20037 "type": "string",20038 "required": true,20039 "description": "Human-readable error description."20040 },20041 {20042 "name": "error<BetaManagedAgentsSelfHostedResourcesUnsupportedRunError>",20043 "type": "BetaManagedAgentsSelfHostedResourcesUnsupportedRunError object",20044 "required": false,20045 "description": "The deployment configures resources, but its environment is self-hosted and cannot mount them."20046 },20047 {20048 "name": "error<BetaManagedAgentsSelfHostedResourcesUnsupportedRunError>.type",20049 "type": "\"self_hosted_resources_unsupported_error\"",20050 "required": true,20051 "description": ""20052 },20053 {20054 "name": "error<BetaManagedAgentsSelfHostedResourcesUnsupportedRunError>.message",20055 "type": "string",20056 "required": true,20057 "description": "Human-readable error description."20058 },20059 {20060 "name": "error<BetaManagedAgentsMCPEgressBlockedRunError>",20061 "type": "BetaManagedAgentsMCPEgressBlockedRunError object",20062 "required": false,20063 "description": "An MCP server host used by the deployment's agent is blocked by the environment's network policy."20064 },20065 {20066 "name": "error<BetaManagedAgentsMCPEgressBlockedRunError>.type",20067 "type": "\"mcp_egress_blocked_error\"",20068 "required": true,20069 "description": ""20070 },20071 {20072 "name": "error<BetaManagedAgentsMCPEgressBlockedRunError>.message",20073 "type": "string",20074 "required": true,20075 "description": "Human-readable error description."20076 },20077 {20078 "name": "session_id",20079 "type": "string or null",20080 "required": true,20081 "description": "Populated on success. Null on creation failure. Exactly one of `session_id` or `error` is non-null."20082 },20083 {20084 "name": "trigger_context",20085 "type": "BetaManagedAgentsTriggerContext",20086 "required": true,20087 "description": "Describes what triggered a deployment run, with trigger-specific metadata."20088 },20089 {20090 "name": "trigger_context<BetaManagedAgentsScheduleTriggerContext>",20091 "type": "BetaManagedAgentsScheduleTriggerContext object",20092 "required": false,20093 "description": "The run was fired by the deployment's cron schedule."20094 },20095 {20096 "name": "trigger_context<BetaManagedAgentsScheduleTriggerContext>.type",20097 "type": "\"schedule\"",20098 "required": true,20099 "description": ""20100 },20101 {20102 "name": "trigger_context<BetaManagedAgentsScheduleTriggerContext>.scheduled_at",20103 "type": "string",20104 "required": true,20105 "description": "A timestamp in RFC 3339 format",20106 "constraints": {20107 "format": "date-time"20108 }20109 },20110 {20111 "name": "trigger_context<BetaManagedAgentsManualTriggerContext>",20112 "type": "BetaManagedAgentsManualTriggerContext object",20113 "required": false,20114 "description": "The run was started manually by creating a session directly against the deployment."20115 },20116 {20117 "name": "trigger_context<BetaManagedAgentsManualTriggerContext>.type",20118 "type": "\"manual\"",20119 "required": true,20120 "description": ""20121 }20122 ],20123 "status": [20124 "DOCUMENTED",20125 "BETA"20126 ],20127 "sources": [20128 {20129 "url": "https://platform.claude.com/docs/en/api/beta/deployment_runs/retrieve",20130 "retrieved_at": "2026-09-18"20131 },20132 {20133 "url": "https://platform.claude.com/docs/en/managed-agents/scheduled-deployments",20134 "retrieved_at": "2026-09-18"20135 }20136 ],20137 "beta_header": "managed-agents-2026-04-01"20138 },20139 {20140 "provider": "anthropic",20141 "api_family": "managed-agents",20142 "name": "Dream",20143 "official_type_name": "BetaDream",20144 "description": "An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into an output memory store — a new store by default, or an existing store chosen via output_behavior. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.",20145 "fields": [20146 {20147 "name": "type",20148 "type": "\"dream\"",20149 "required": true,20150 "description": ""20151 },20152 {20153 "name": "id",20154 "type": "string",20155 "required": true,20156 "description": ""20157 },20158 {20159 "name": "archived_at",20160 "type": "string or null",20161 "required": true,20162 "description": "A timestamp in RFC 3339 format",20163 "constraints": {20164 "format": "date-time"20165 }20166 },20167 {20168 "name": "created_at",20169 "type": "string",20170 "required": true,20171 "description": "A timestamp in RFC 3339 format",20172 "constraints": {20173 "format": "date-time"20174 }20175 },20176 {20177 "name": "ended_at",20178 "type": "string or null",20179 "required": true,20180 "description": "A timestamp in RFC 3339 format",20181 "constraints": {20182 "format": "date-time"20183 }20184 },20185 {20186 "name": "error",20187 "type": "BetaDreamError or null",20188 "required": true,20189 "description": "Failure detail for a Dream whose `status` is `failed`."20190 },20191 {20192 "name": "error.type",20193 "type": "string",20194 "required": true,20195 "description": ""20196 },20197 {20198 "name": "error.message",20199 "type": "string",20200 "required": true,20201 "description": ""20202 },20203 {20204 "name": "inputs",20205 "type": "array of BetaDreamInput",20206 "required": true,20207 "description": ""20208 },20209 {20210 "name": "inputs<BetaDreamMemoryStoreInput>",20211 "type": "BetaDreamMemoryStoreInput object",20212 "required": false,20213 "description": "An input memory store the dream reads from. The dream never mutates this store unless it is also the destination: with output_behavior {type: \"update_existing\"} the job consolidates this store in place."20214 },20215 {20216 "name": "inputs<BetaDreamMemoryStoreInput>.type",20217 "type": "\"memory_store\"",20218 "required": true,20219 "description": ""20220 },20221 {20222 "name": "inputs<BetaDreamMemoryStoreInput>.memory_store_id",20223 "type": "string",20224 "required": true,20225 "description": "",20226 "constraints": {20227 "minLength": "1"20228 }20229 },20230 {20231 "name": "inputs<BetaDreamSessionsInput>",20232 "type": "BetaDreamSessionsInput object",20233 "required": false,20234 "description": "Input session transcripts the dream reads."20235 },20236 {20237 "name": "inputs<BetaDreamSessionsInput>.type",20238 "type": "\"sessions\"",20239 "required": true,20240 "description": ""20241 },20242 {20243 "name": "inputs<BetaDreamSessionsInput>.session_ids",20244 "type": "array of string",20245 "required": true,20246 "description": ""20247 },20248 {20249 "name": "instructions",20250 "type": "string or null",20251 "required": true,20252 "description": ""20253 },20254 {20255 "name": "model",20256 "type": "BetaDreamModelConfig",20257 "required": true,20258 "description": "Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig."20259 },20260 {20261 "name": "model.id",20262 "type": "string",20263 "required": true,20264 "description": "Model identifier, e.g. \"claude-opus-5\". 1-256 characters.",20265 "constraints": {20266 "minLength": "1",20267 "maxLength": "256"20268 }20269 },20270 {20271 "name": "model.speed",20272 "type": "\"standard\" or \"fast\"",20273 "required": false,20274 "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",20275 "enum": [20276 "standard",20277 "fast"20278 ]20279 },20280 {20281 "name": "output_behavior",20282 "type": "BetaOutputBehavior",20283 "required": true,20284 "description": ""20285 },20286 {20287 "name": "output_behavior<BetaOutputBehaviorCreateNew>",20288 "type": "BetaOutputBehaviorCreateNew object",20289 "required": false,20290 "description": "The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated."20291 },20292 {20293 "name": "output_behavior<BetaOutputBehaviorCreateNew>.type",20294 "type": "\"create_new\"",20295 "required": true,20296 "description": ""20297 },20298 {20299 "name": "output_behavior<BetaOutputBehaviorUpdateExisting>",20300 "type": "BetaOutputBehaviorUpdateExisting object",20301 "required": false,20302 "description": "The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place."20303 },20304 {20305 "name": "output_behavior<BetaOutputBehaviorUpdateExisting>.type",20306 "type": "\"update_existing\"",20307 "required": true,20308 "description": ""20309 },20310 {20311 "name": "output_behavior<BetaOutputBehaviorUpdateExisting>.memory_store_id",20312 "type": "string",20313 "required": true,20314 "description": "",20315 "constraints": {20316 "minLength": "1"20317 }20318 },20319 {20320 "name": "outputs",20321 "type": "array of BetaDreamOutput",20322 "required": true,20323 "description": ""20324 },20325 {20326 "name": "outputs.type",20327 "type": "\"memory_store\"",20328 "required": true,20329 "description": ""20330 },20331 {20332 "name": "outputs.memory_store_id",20333 "type": "string",20334 "required": true,20335 "description": ""20336 },20337 {20338 "name": "session_id",20339 "type": "string or null",20340 "required": true,20341 "description": ""20342 },20343 {20344 "name": "status",20345 "type": "BetaDreamStatus",20346 "required": true,20347 "description": "Lifecycle status of a Dream.",20348 "enum": [20349 "pending",20350 "running",20351 "completed",20352 "failed",20353 "canceled"20354 ]20355 },20356 {20357 "name": "usage",20358 "type": "BetaDreamUsage",20359 "required": true,20360 "description": "Cumulative token usage for the dream across every pipeline stage."20361 },20362 {20363 "name": "usage.cache_creation_input_tokens",20364 "type": "number",20365 "required": true,20366 "description": "Total tokens used to create prompt-cache entries (sum of all TTL tiers).",20367 "constraints": {20368 "format": "int32"20369 }20370 },20371 {20372 "name": "usage.cache_read_input_tokens",20373 "type": "number",20374 "required": true,20375 "description": "Total tokens read from prompt cache.",20376 "constraints": {20377 "format": "int32"20378 }20379 },20380 {20381 "name": "usage.input_tokens",20382 "type": "number",20383 "required": true,20384 "description": "Total uncached input tokens consumed across every pipeline stage.",20385 "constraints": {20386 "format": "int32"20387 }20388 },20389 {20390 "name": "usage.output_tokens",20391 "type": "number",20392 "required": true,20393 "description": "Total output tokens generated across every pipeline stage.",20394 "constraints": {20395 "format": "int32"20396 }20397 }20398 ],20399 "status": [20400 "DOCUMENTED",20401 "BETA",20402 "PREVIEW"20403 ],20404 "sources": [20405 {20406 "url": "https://platform.claude.com/docs/en/api/beta/dreams/create",20407 "retrieved_at": "2026-09-18"20408 },20409 {20410 "url": "https://platform.claude.com/docs/en/managed-agents/dreams",20411 "retrieved_at": "2026-09-18"20412 }20413 ],20414 "beta_header": "managed-agents-2026-04-01,dreaming-2026-04-21"20415 },20416 {20417 "provider": "anthropic",20418 "api_family": "managed-agents",20419 "name": "DreamCreateParams (request body)",20420 "official_type_name": "BetaDreamCreateParams",20421 "description": "Create a Dream",20422 "fields": [20423 {20424 "name": "inputs",20425 "type": "array of BetaDreamInput",20426 "required": true,20427 "description": ""20428 },20429 {20430 "name": "inputs<BetaDreamMemoryStoreInput>",20431 "type": "BetaDreamMemoryStoreInput object",20432 "required": false,20433 "description": "An input memory store the dream reads from. The dream never mutates this store unless it is also the destination: with output_behavior {type: \"update_existing\"} the job consolidates this store in place."20434 },20435 {20436 "name": "inputs<BetaDreamMemoryStoreInput>.type",20437 "type": "\"memory_store\"",20438 "required": true,20439 "description": ""20440 },20441 {20442 "name": "inputs<BetaDreamMemoryStoreInput>.memory_store_id",20443 "type": "string",20444 "required": true,20445 "description": "",20446 "constraints": {20447 "minLength": "1"20448 }20449 },20450 {20451 "name": "inputs<BetaDreamSessionsInput>",20452 "type": "BetaDreamSessionsInput object",20453 "required": false,20454 "description": "Input session transcripts the dream reads."20455 },20456 {20457 "name": "inputs<BetaDreamSessionsInput>.type",20458 "type": "\"sessions\"",20459 "required": true,20460 "description": ""20461 },20462 {20463 "name": "inputs<BetaDreamSessionsInput>.session_ids",20464 "type": "array of string",20465 "required": true,20466 "description": ""20467 },20468 {20469 "name": "model",20470 "type": "string or BetaDreamModelConfigParam",20471 "required": true,20472 "description": ""20473 },20474 {20475 "name": "model<string>",20476 "type": "string",20477 "required": false,20478 "description": ""20479 },20480 {20481 "name": "model<BetaDreamModelConfigParam>",20482 "type": "BetaDreamModelConfigParam object",20483 "required": false,20484 "description": "Model identifier and configuration applied to every pipeline stage."20485 },20486 {20487 "name": "model<BetaDreamModelConfigParam>.id",20488 "type": "string",20489 "required": true,20490 "description": "Model identifier, e.g. \"claude-opus-5\". 1-256 characters.",20491 "constraints": {20492 "minLength": "1",20493 "maxLength": "256"20494 }20495 },20496 {20497 "name": "model<BetaDreamModelConfigParam>.speed",20498 "type": "\"standard\" or \"fast\" or null",20499 "required": false,20500 "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",20501 "enum": [20502 "standard",20503 "fast"20504 ]20505 },20506 {20507 "name": "instructions",20508 "type": "string or null",20509 "required": false,20510 "description": "",20511 "constraints": {20512 "minLength": "1",20513 "maxLength": "4096"20514 }20515 },20516 {20517 "name": "output_behavior",20518 "type": "BetaOutputBehavior",20519 "required": false,20520 "description": ""20521 },20522 {20523 "name": "output_behavior<BetaOutputBehaviorCreateNew>",20524 "type": "BetaOutputBehaviorCreateNew object",20525 "required": false,20526 "description": "The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated."20527 },20528 {20529 "name": "output_behavior<BetaOutputBehaviorCreateNew>.type",20530 "type": "\"create_new\"",20531 "required": true,20532 "description": ""20533 },20534 {20535 "name": "output_behavior<BetaOutputBehaviorUpdateExisting>",20536 "type": "BetaOutputBehaviorUpdateExisting object",20537 "required": false,20538 "description": "The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place."20539 },20540 {20541 "name": "output_behavior<BetaOutputBehaviorUpdateExisting>.type",20542 "type": "\"update_existing\"",20543 "required": true,20544 "description": ""20545 },20546 {20547 "name": "output_behavior<BetaOutputBehaviorUpdateExisting>.memory_store_id",20548 "type": "string",20549 "required": true,20550 "description": "",20551 "constraints": {20552 "minLength": "1"20553 }20554 }20555 ],20556 "status": [20557 "DOCUMENTED",20558 "BETA",20559 "PREVIEW"20560 ],20561 "sources": [20562 {20563 "url": "https://platform.claude.com/docs/en/api/beta/dreams/create",20564 "retrieved_at": "2026-09-18"20565 },20566 {20567 "url": "https://platform.claude.com/docs/en/managed-agents/dreams",20568 "retrieved_at": "2026-09-18"20569 }20570 ],20571 "beta_header": "managed-agents-2026-04-01,dreaming-2026-04-21"20572 },20573 {20574 "provider": "anthropic",20575 "api_family": "managed-agents",20576 "name": "MemoryStore",20577 "official_type_name": "BetaManagedAgentsMemoryStore",20578 "description": "A `memory_store`: a named container for agent memories, scoped to a workspace. Attach a store to a session via `resources[]` to mount it as a directory the agent can read and write.",20579 "fields": [20580 {20581 "name": "type",20582 "type": "\"memory_store\"",20583 "required": true,20584 "description": ""20585 },20586 {20587 "name": "id",20588 "type": "string",20589 "required": true,20590 "description": "Unique identifier for the memory store (a `memstore_...` tagged ID). Use this when attaching the store to a session, or in the `{memory_store_id}` path parameter of subsequent calls."20591 },20592 {20593 "name": "created_at",20594 "type": "string",20595 "required": true,20596 "description": "A timestamp in RFC 3339 format",20597 "constraints": {20598 "format": "date-time"20599 }20600 },20601 {20602 "name": "name",20603 "type": "string",20604 "required": true,20605 "description": "Human-readable name for the store. 1–255 characters. The store's mount-path slug under `/mnt/memory/` is derived from this name."20606 },20607 {20608 "name": "updated_at",20609 "type": "string",20610 "required": true,20611 "description": "A timestamp in RFC 3339 format",20612 "constraints": {20613 "format": "date-time"20614 }20615 },20616 {20617 "name": "archived_at",20618 "type": "string or null",20619 "required": false,20620 "description": "A timestamp in RFC 3339 format",20621 "constraints": {20622 "format": "date-time"20623 }20624 },20625 {20626 "name": "description",20627 "type": "string",20628 "required": false,20629 "description": "Free-text description of what the store contains, up to 1024 characters. Included in the agent's system prompt when the store is attached, so word it to be useful to the agent. Empty string when unset."20630 },20631 {20632 "name": "metadata",20633 "type": "map[string]",20634 "required": false,20635 "description": "Arbitrary key-value tags for your own bookkeeping (such as the end user a store belongs to). Up to 16 pairs; keys 1–64 characters; values up to 512 characters. Returned on retrieve/list but not filterable."20636 }20637 ],20638 "status": [20639 "DOCUMENTED",20640 "BETA"20641 ],20642 "sources": [20643 {20644 "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/create",20645 "retrieved_at": "2026-09-18"20646 },20647 {20648 "url": "https://platform.claude.com/docs/en/managed-agents/memory",20649 "retrieved_at": "2026-09-18"20650 }20651 ],20652 "beta_header": "agent-memory-2026-07-22 (do not combine with managed-agents-2026-04-01 on memory store calls)"20653 },20654 {20655 "provider": "anthropic",20656 "api_family": "managed-agents",20657 "name": "Memory",20658 "official_type_name": "BetaManagedAgentsMemory",20659 "description": "A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update.",20660 "fields": [20661 {20662 "name": "type",20663 "type": "\"memory\"",20664 "required": true,20665 "description": ""20666 },20667 {20668 "name": "id",20669 "type": "string",20670 "required": true,20671 "description": "Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory."20672 },20673 {20674 "name": "content_sha256",20675 "type": "string",20676 "required": true,20677 "description": "Lowercase hex SHA-256 digest of the UTF-8 `content` bytes (64 characters). The server applies no normalization, so clients can compute the same hash locally for staleness checks and as the value for a `content_sha256` precondition on update. Always populated, regardless of `view`."20678 },20679 {20680 "name": "content_size_bytes",20681 "type": "number",20682 "required": true,20683 "description": "Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`.",20684 "constraints": {20685 "format": "int32"20686 }20687 },20688 {20689 "name": "created_at",20690 "type": "string",20691 "required": true,20692 "description": "A timestamp in RFC 3339 format",20693 "constraints": {20694 "format": "date-time"20695 }20696 },20697 {20698 "name": "memory_store_id",20699 "type": "string",20700 "required": true,20701 "description": "ID of the memory store this memory belongs to (a `memstore_...` value)."20702 },20703 {20704 "name": "memory_version_id",20705 "type": "string",20706 "required": true,20707 "description": "ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list)."20708 },20709 {20710 "name": "path",20711 "type": "string",20712 "required": true,20713 "description": "Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes."20714 },20715 {20716 "name": "updated_at",20717 "type": "string",20718 "required": true,20719 "description": "A timestamp in RFC 3339 format",20720 "constraints": {20721 "format": "date-time"20722 }20723 },20724 {20725 "name": "content",20726 "type": "string or null",20727 "required": false,20728 "description": "The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes)."20729 }20730 ],20731 "status": [20732 "DOCUMENTED",20733 "BETA"20734 ],20735 "sources": [20736 {20737 "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/retrieve",20738 "retrieved_at": "2026-09-18"20739 },20740 {20741 "url": "https://platform.claude.com/docs/en/managed-agents/memory",20742 "retrieved_at": "2026-09-18"20743 }20744 ],20745 "beta_header": "agent-memory-2026-07-22 (do not combine with managed-agents-2026-04-01 on memory store calls)"20746 },20747 {20748 "provider": "anthropic",20749 "api_family": "managed-agents",20750 "name": "MemoryListItem",20751 "official_type_name": "BetaManagedAgentsMemoryListItem",20752 "description": "One page of results. Each item is either a `memory` object or, when `depth` was set, a `memory_prefix` rollup marker. Items are returned in a stable, server-defined order.",20753 "fields": [20754 {20755 "name": "<BetaManagedAgentsMemory>",20756 "type": "BetaManagedAgentsMemory object",20757 "required": false,20758 "description": "A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update."20759 },20760 {20761 "name": "<BetaManagedAgentsMemory>.type",20762 "type": "\"memory\"",20763 "required": true,20764 "description": ""20765 },20766 {20767 "name": "<BetaManagedAgentsMemory>.id",20768 "type": "string",20769 "required": true,20770 "description": "Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory."20771 },20772 {20773 "name": "<BetaManagedAgentsMemory>.content_sha256",20774 "type": "string",20775 "required": true,20776 "description": "Lowercase hex SHA-256 digest of the UTF-8 `content` bytes (64 characters). The server applies no normalization, so clients can compute the same hash locally for staleness checks and as the value for a `content_sha256` precondition on update. Always populated, regardless of `view`."20777 },20778 {20779 "name": "<BetaManagedAgentsMemory>.content_size_bytes",20780 "type": "number",20781 "required": true,20782 "description": "Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`.",20783 "constraints": {20784 "format": "int32"20785 }20786 },20787 {20788 "name": "<BetaManagedAgentsMemory>.created_at",20789 "type": "string",20790 "required": true,20791 "description": "A timestamp in RFC 3339 format",20792 "constraints": {20793 "format": "date-time"20794 }20795 },20796 {20797 "name": "<BetaManagedAgentsMemory>.memory_store_id",20798 "type": "string",20799 "required": true,20800 "description": "ID of the memory store this memory belongs to (a `memstore_...` value)."20801 },20802 {20803 "name": "<BetaManagedAgentsMemory>.memory_version_id",20804 "type": "string",20805 "required": true,20806 "description": "ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list)."20807 },20808 {20809 "name": "<BetaManagedAgentsMemory>.path",20810 "type": "string",20811 "required": true,20812 "description": "Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes."20813 },20814 {20815 "name": "<BetaManagedAgentsMemory>.updated_at",20816 "type": "string",20817 "required": true,20818 "description": "A timestamp in RFC 3339 format",20819 "constraints": {20820 "format": "date-time"20821 }20822 },20823 {20824 "name": "<BetaManagedAgentsMemory>.content",20825 "type": "string or null",20826 "required": false,20827 "description": "The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes)."20828 },20829 {20830 "name": "<BetaManagedAgentsMemoryPrefix>",20831 "type": "BetaManagedAgentsMemoryPrefix object",20832 "required": false,20833 "description": "A rolled-up directory marker returned by [List memories](/docs/en/api/beta/memory_stores/memories/list) when `depth` is set. Indicates that one or more memories exist deeper than the requested depth under this prefix. This is a list-time rollup, not a stored resource; it has no ID and no lifecycle. Each prefix counts toward the page `limit` and interleaves with `memory` items in path order."20834 },20835 {20836 "name": "<BetaManagedAgentsMemoryPrefix>.type",20837 "type": "\"memory_prefix\"",20838 "required": true,20839 "description": ""20840 },20841 {20842 "name": "<BetaManagedAgentsMemoryPrefix>.path",20843 "type": "string",20844 "required": true,20845 "description": "The rolled-up path prefix, including a trailing `/` (e.g. `/projects/foo/`). Pass this value as `path_prefix` on a subsequent list call to drill into the directory."20846 }20847 ],20848 "status": [20849 "DOCUMENTED",20850 "BETA"20851 ],20852 "sources": [20853 {20854 "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/list",20855 "retrieved_at": "2026-09-18"20856 },20857 {20858 "url": "https://platform.claude.com/docs/en/managed-agents/memory",20859 "retrieved_at": "2026-09-18"20860 }20861 ],20862 "beta_header": "agent-memory-2026-07-22 (do not combine with managed-agents-2026-04-01 on memory store calls)"20863 },20864 {20865 "provider": "anthropic",20866 "api_family": "managed-agents",20867 "name": "MemoryVersion",20868 "official_type_name": "BetaManagedAgentsMemoryVersion",20869 "description": "A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status.",20870 "fields": [20871 {20872 "name": "type",20873 "type": "\"memory_version\"",20874 "required": true,20875 "description": ""20876 },20877 {20878 "name": "id",20879 "type": "string",20880 "required": true,20881 "description": "Unique identifier for this version (a `memver_...` value)."20882 },20883 {20884 "name": "created_at",20885 "type": "string",20886 "required": true,20887 "description": "A timestamp in RFC 3339 format",20888 "constraints": {20889 "format": "date-time"20890 }20891 },20892 {20893 "name": "memory_id",20894 "type": "string",20895 "required": true,20896 "description": "ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained."20897 },20898 {20899 "name": "memory_store_id",20900 "type": "string",20901 "required": true,20902 "description": "ID of the memory store this version belongs to (a `memstore_...` value)."20903 },20904 {20905 "name": "operation",20906 "type": "BetaManagedAgentsMemoryVersionOperation",20907 "required": true,20908 "description": "The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values.",20909 "enum": [20910 "created",20911 "modified",20912 "deleted"20913 ]20914 },20915 {20916 "name": "content",20917 "type": "string or null",20918 "required": false,20919 "description": "The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set."20920 },20921 {20922 "name": "content_sha256",20923 "type": "string or null",20924 "required": false,20925 "description": "Lowercase hex SHA-256 digest of `content` as of this version (64 characters). `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise."20926 },20927 {20928 "name": "content_size_bytes",20929 "type": "number or null",20930 "required": false,20931 "description": "Size of `content` in bytes as of this version. `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise.",20932 "constraints": {20933 "format": "int32"20934 }20935 },20936 {20937 "name": "created_by",20938 "type": "BetaManagedAgentsActor",20939 "required": false,20940 "description": "Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/beta/sessions/retrieve)."20941 },20942 {20943 "name": "created_by<BetaManagedAgentsSessionActor>",20944 "type": "BetaManagedAgentsSessionActor object",20945 "required": false,20946 "description": "Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`."20947 },20948 {20949 "name": "created_by<BetaManagedAgentsSessionActor>.type",20950 "type": "\"session_actor\"",20951 "required": true,20952 "description": ""20953 },20954 {20955 "name": "created_by<BetaManagedAgentsSessionActor>.session_id",20956 "type": "string",20957 "required": true,20958 "description": "ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/docs/en/api/beta/sessions/retrieve) for further provenance.",20959 "constraints": {20960 "minLength": "1"20961 }20962 },20963 {20964 "name": "created_by<BetaManagedAgentsAPIActor>",20965 "type": "BetaManagedAgentsAPIActor object",20966 "required": false,20967 "description": "Attribution for a write made directly via the public API (outside of any session)."20968 },20969 {20970 "name": "created_by<BetaManagedAgentsAPIActor>.type",20971 "type": "\"api_actor\"",20972 "required": true,20973 "description": ""20974 },20975 {20976 "name": "created_by<BetaManagedAgentsAPIActor>.api_key_id",20977 "type": "string",20978 "required": true,20979 "description": "ID of the API key that performed the write. This identifies the key, not the secret.",20980 "constraints": {20981 "minLength": "1"20982 }20983 },20984 {20985 "name": "created_by<BetaManagedAgentsUserActor>",20986 "type": "BetaManagedAgentsUserActor object",20987 "required": false,20988 "description": "Attribution for a write made by a human user through the Anthropic Console."20989 },20990 {20991 "name": "created_by<BetaManagedAgentsUserActor>.type",20992 "type": "\"user_actor\"",20993 "required": true,20994 "description": ""20995 },20996 {20997 "name": "created_by<BetaManagedAgentsUserActor>.user_id",20998 "type": "string",20999 "required": true,21000 "description": "ID of the user who performed the write (a `user_...` value).",21001 "constraints": {21002 "minLength": "1"21003 }21004 },21005 {21006 "name": "created_by<BetaManagedAgentsServiceAccountActor>",21007 "type": "BetaManagedAgentsServiceAccountActor object",21008 "required": false,21009 "description": "Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation."21010 },21011 {21012 "name": "created_by<BetaManagedAgentsServiceAccountActor>.type",21013 "type": "\"service_account_actor\"",21014 "required": true,21015 "description": ""21016 },21017 {21018 "name": "created_by<BetaManagedAgentsServiceAccountActor>.service_account_id",21019 "type": "string",21020 "required": true,21021 "description": "ID of the service account that performed the write (a `svac_...` value).",21022 "constraints": {21023 "minLength": "1"21024 }21025 },21026 {21027 "name": "path",21028 "type": "string or null",21029 "required": false,21030 "description": "The memory's path at the time of this write. `null` if and only if `redacted_at` is set."21031 },21032 {21033 "name": "redacted_at",21034 "type": "string or null",21035 "required": false,21036 "description": "A timestamp in RFC 3339 format",21037 "constraints": {21038 "format": "date-time"21039 }21040 },21041 {21042 "name": "redacted_by",21043 "type": "BetaManagedAgentsActor",21044 "required": false,21045 "description": "Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/beta/sessions/retrieve)."21046 }21047 ],21048 "status": [21049 "DOCUMENTED",21050 "BETA"21051 ],21052 "sources": [21053 {21054 "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/retrieve",21055 "retrieved_at": "2026-09-18"21056 },21057 {21058 "url": "https://platform.claude.com/docs/en/managed-agents/memory",21059 "retrieved_at": "2026-09-18"21060 }21061 ],21062 "beta_header": "agent-memory-2026-07-22 (do not combine with managed-agents-2026-04-01 on memory store calls)"21063 },21064 {21065 "provider": "anthropic",21066 "api_family": "managed-agents",21067 "name": "MemoryUpdateParams (request body, precondition)",21068 "official_type_name": "BetaManagedAgentsMemoryUpdateParams",21069 "description": "Update a memory",21070 "fields": [21071 {21072 "name": "content",21073 "type": "string or null",21074 "required": false,21075 "description": "New UTF-8 text content for the memory. Maximum 100 kB (102,400 bytes). Omit to leave the content unchanged (e.g., for a rename-only update)."21076 },21077 {21078 "name": "path",21079 "type": "string or null",21080 "required": false,21081 "description": "New path for the memory (a rename). Must start with `/`, contain at least one non-empty segment, and be at most 1,024 bytes. Must not contain empty segments, `.` or `..` segments, control or format characters, or the Unicode line and paragraph separators (U+2028, U+2029), and must be NFC-normalized. Paths are case-sensitive. The memory's `id` is preserved across renames. Omit to leave the path unchanged.",21082 "constraints": {21083 "minLength": "2",21084 "maxLength": "1024"21085 }21086 },21087 {21088 "name": "precondition",21089 "type": "BetaManagedAgentsPrecondition",21090 "required": false,21091 "description": "Optimistic-concurrency precondition: the update applies only if the memory's stored `content_sha256` equals the supplied value. On mismatch, the request returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and retry against the fresh state. If the precondition fails but the stored state already exactly matches the requested `content` and `path`, the server returns 200 instead of 409."21092 },21093 {21094 "name": "precondition.type",21095 "type": "\"content_sha256\"",21096 "required": true,21097 "description": ""21098 },21099 {21100 "name": "precondition.content_sha256",21101 "type": "string",21102 "required": false,21103 "description": "Expected `content_sha256` of the stored memory (64 lowercase hexadecimal characters). Typically the `content_sha256` returned by a prior read or list call. Because the server applies no content normalization, clients can also compute this locally as the SHA-256 of the UTF-8 content bytes."21104 }21105 ],21106 "status": [21107 "DOCUMENTED",21108 "BETA"21109 ],21110 "sources": [21111 {21112 "url": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/update",21113 "retrieved_at": "2026-09-18"21114 },21115 {21116 "url": "https://platform.claude.com/docs/en/managed-agents/memory",21117 "retrieved_at": "2026-09-18"21118 }21119 ],21120 "beta_header": "agent-memory-2026-07-22 (do not combine with managed-agents-2026-04-01 on memory store calls)"21121 },21122 {21123 "provider": "anthropic",21124 "api_family": "managed-agents",21125 "name": "Vault",21126 "official_type_name": "BetaManagedAgentsVault",21127 "description": "A vault that stores credentials for use by agents during sessions.",21128 "fields": [21129 {21130 "name": "type",21131 "type": "\"vault\"",21132 "required": true,21133 "description": ""21134 },21135 {21136 "name": "id",21137 "type": "string",21138 "required": true,21139 "description": "Unique identifier for the vault."21140 },21141 {21142 "name": "archived_at",21143 "type": "string or null",21144 "required": true,21145 "description": "A timestamp in RFC 3339 format",21146 "constraints": {21147 "format": "date-time"21148 }21149 },21150 {21151 "name": "created_at",21152 "type": "string",21153 "required": true,21154 "description": "A timestamp in RFC 3339 format",21155 "constraints": {21156 "format": "date-time"21157 }21158 },21159 {21160 "name": "display_name",21161 "type": "string",21162 "required": true,21163 "description": "Human-readable name for the vault."21164 },21165 {21166 "name": "metadata",21167 "type": "map[string]",21168 "required": true,21169 "description": "Arbitrary key-value metadata attached to the vault."21170 },21171 {21172 "name": "updated_at",21173 "type": "string",21174 "required": true,21175 "description": "A timestamp in RFC 3339 format",21176 "constraints": {21177 "format": "date-time"21178 }21179 }21180 ],21181 "status": [21182 "DOCUMENTED",21183 "BETA"21184 ],21185 "sources": [21186 {21187 "url": "https://platform.claude.com/docs/en/api/beta/vaults/create",21188 "retrieved_at": "2026-09-18"21189 },21190 {21191 "url": "https://platform.claude.com/docs/en/managed-agents/vaults",21192 "retrieved_at": "2026-09-18"21193 }21194 ],21195 "beta_header": "managed-agents-2026-04-01"21196 },21197 {21198 "provider": "anthropic",21199 "api_family": "managed-agents",21200 "name": "Credential (auth union: mcp_oauth | static_bearer | environment_variable)",21201 "official_type_name": "BetaManagedAgentsCredential",21202 "description": "A credential stored in a vault. Sensitive fields are never returned in responses.",21203 "fields": [21204 {21205 "name": "type",21206 "type": "\"vault_credential\"",21207 "required": true,21208 "description": ""21209 },21210 {21211 "name": "id",21212 "type": "string",21213 "required": true,21214 "description": "Unique identifier for the credential."21215 },21216 {21217 "name": "archived_at",21218 "type": "string or null",21219 "required": true,21220 "description": "A timestamp in RFC 3339 format",21221 "constraints": {21222 "format": "date-time"21223 }21224 },21225 {21226 "name": "auth",21227 "type": "BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse or BetaManagedAgentsEnvironmentVariableAuthResponse",21228 "required": true,21229 "description": "Authentication details for a credential."21230 },21231 {21232 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>",21233 "type": "BetaManagedAgentsMCPOAuthAuthResponse object",21234 "required": false,21235 "description": "OAuth credential details for an MCP server."21236 },21237 {21238 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.type",21239 "type": "\"mcp_oauth\"",21240 "required": true,21241 "description": ""21242 },21243 {21244 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.mcp_server_url",21245 "type": "string",21246 "required": true,21247 "description": "URL of the MCP server this credential authenticates against."21248 },21249 {21250 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.expires_at",21251 "type": "string or null",21252 "required": false,21253 "description": "A timestamp in RFC 3339 format",21254 "constraints": {21255 "format": "date-time"21256 }21257 },21258 {21259 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.refresh",21260 "type": "BetaManagedAgentsMCPOAuthRefreshResponse or null",21261 "required": false,21262 "description": "OAuth refresh token configuration returned in credential responses."21263 },21264 {21265 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.refresh.client_id",21266 "type": "string",21267 "required": true,21268 "description": "OAuth client ID."21269 },21270 {21271 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.refresh.token_endpoint",21272 "type": "string",21273 "required": true,21274 "description": "Token endpoint URL used to refresh the access token."21275 },21276 {21277 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.refresh.token_endpoint_auth",21278 "type": "BetaManagedAgentsTokenEndpointAuthNoneResponse or BetaManagedAgentsTokenEndpointAuthBasicResponse or BetaManagedAgentsTokenEndpointAuthPostResponse",21279 "required": true,21280 "description": ""21281 },21282 {21283 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.refresh.token_endpoint_auth<BetaManagedAgentsTokenEndpointAuthNoneResponse>",21284 "type": "BetaManagedAgentsTokenEndpointAuthNoneResponse object",21285 "required": false,21286 "description": "Token endpoint requires no client authentication."21287 },21288 {21289 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.refresh.token_endpoint_auth<BetaManagedAgentsTokenEndpointAuthNoneResponse>.type",21290 "type": "\"none\"",21291 "required": true,21292 "description": ""21293 },21294 {21295 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.refresh.token_endpoint_auth<BetaManagedAgentsTokenEndpointAuthBasicResponse>",21296 "type": "BetaManagedAgentsTokenEndpointAuthBasicResponse object",21297 "required": false,21298 "description": "Token endpoint uses HTTP Basic authentication with client credentials."21299 },21300 {21301 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.refresh.token_endpoint_auth<BetaManagedAgentsTokenEndpointAuthBasicResponse>.type",21302 "type": "\"client_secret_basic\"",21303 "required": true,21304 "description": ""21305 },21306 {21307 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.refresh.token_endpoint_auth<BetaManagedAgentsTokenEndpointAuthPostResponse>",21308 "type": "BetaManagedAgentsTokenEndpointAuthPostResponse object",21309 "required": false,21310 "description": "Token endpoint uses POST body authentication with client credentials."21311 },21312 {21313 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.refresh.token_endpoint_auth<BetaManagedAgentsTokenEndpointAuthPostResponse>.type",21314 "type": "\"client_secret_post\"",21315 "required": true,21316 "description": ""21317 },21318 {21319 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.refresh.resource",21320 "type": "string or null",21321 "required": false,21322 "description": "OAuth resource indicator."21323 },21324 {21325 "name": "auth<BetaManagedAgentsMCPOAuthAuthResponse>.refresh.scope",21326 "type": "string or null",21327 "required": false,21328 "description": "OAuth scope for the refresh request."21329 },21330 {21331 "name": "auth<BetaManagedAgentsStaticBearerAuthResponse>",21332 "type": "BetaManagedAgentsStaticBearerAuthResponse object",21333 "required": false,21334 "description": "Static bearer token credential details for an MCP server."21335 },21336 {21337 "name": "auth<BetaManagedAgentsStaticBearerAuthResponse>.type",21338 "type": "\"static_bearer\"",21339 "required": true,21340 "description": ""21341 },21342 {21343 "name": "auth<BetaManagedAgentsStaticBearerAuthResponse>.mcp_server_url",21344 "type": "string",21345 "required": true,21346 "description": "URL of the MCP server this credential authenticates against."21347 },21348 {21349 "name": "auth<BetaManagedAgentsEnvironmentVariableAuthResponse>",21350 "type": "BetaManagedAgentsEnvironmentVariableAuthResponse object",21351 "required": false,21352 "description": "Environment variable credential details. The secret value is never returned."21353 },21354 {21355 "name": "auth<BetaManagedAgentsEnvironmentVariableAuthResponse>.type",21356 "type": "\"environment_variable\"",21357 "required": true,21358 "description": ""21359 },21360 {21361 "name": "auth<BetaManagedAgentsEnvironmentVariableAuthResponse>.injection_location",21362 "type": "BetaManagedAgentsInjectionLocationResponse",21363 "required": true,21364 "description": "Where in the outbound request the secret value is substituted."21365 },21366 {21367 "name": "auth<BetaManagedAgentsEnvironmentVariableAuthResponse>.injection_location.body",21368 "type": "boolean",21369 "required": true,21370 "description": "Whether the placeholder is substituted in the request body."21371 },21372 {21373 "name": "auth<BetaManagedAgentsEnvironmentVariableAuthResponse>.injection_location.header",21374 "type": "boolean",21375 "required": true,21376 "description": "Whether the placeholder is substituted in request header values."21377 },21378 {21379 "name": "auth<BetaManagedAgentsEnvironmentVariableAuthResponse>.networking",21380 "type": "BetaManagedAgentsUnrestrictedCredentialNetworkingResponse or BetaManagedAgentsLimitedCredentialNetworkingResponse",21381 "required": true,21382 "description": "Outbound hosts the secret value is substituted on."21383 },21384 {21385 "name": "auth<BetaManagedAgentsEnvironmentVariableAuthResponse>.networking<BetaManagedAgentsUnrestrictedCredentialNetworkingResponse>",21386 "type": "BetaManagedAgentsUnrestrictedCredentialNetworkingResponse object",21387 "required": false,21388 "description": "The secret is substituted on any host the session's Environment network policy permits egress to."21389 },21390 {21391 "name": "auth<BetaManagedAgentsEnvironmentVariableAuthResponse>.networking<BetaManagedAgentsUnrestrictedCredentialNetworkingResponse>.type",21392 "type": "\"unrestricted\"",21393 "required": true,21394 "description": ""21395 },21396 {21397 "name": "auth<BetaManagedAgentsEnvironmentVariableAuthResponse>.networking<BetaManagedAgentsLimitedCredentialNetworkingResponse>",21398 "type": "BetaManagedAgentsLimitedCredentialNetworkingResponse object",21399 "required": false,21400 "description": "The secret is substituted only on requests to the listed hosts."21401 },21402 {21403 "name": "auth<BetaManagedAgentsEnvironmentVariableAuthResponse>.networking<BetaManagedAgentsLimitedCredentialNetworkingResponse>.type",21404 "type": "\"limited\"",21405 "required": true,21406 "description": ""21407 },21408 {21409 "name": "auth<BetaManagedAgentsEnvironmentVariableAuthResponse>.networking<BetaManagedAgentsLimitedCredentialNetworkingResponse>.allowed_hosts",21410 "type": "array of string",21411 "required": true,21412 "description": "Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself."21413 },21414 {21415 "name": "auth<BetaManagedAgentsEnvironmentVariableAuthResponse>.secret_name",21416 "type": "string",21417 "required": true,21418 "description": "Name of the environment variable."21419 },21420 {21421 "name": "created_at",21422 "type": "string",21423 "required": true,21424 "description": "A timestamp in RFC 3339 format",21425 "constraints": {21426 "format": "date-time"21427 }21428 },21429 {21430 "name": "metadata",21431 "type": "map[string]",21432 "required": true,21433 "description": "Arbitrary key-value metadata attached to the credential."21434 },21435 {21436 "name": "updated_at",21437 "type": "string",21438 "required": true,21439 "description": "A timestamp in RFC 3339 format",21440 "constraints": {21441 "format": "date-time"21442 }21443 },21444 {21445 "name": "vault_id",21446 "type": "string",21447 "required": true,21448 "description": "Identifier of the vault this credential belongs to."21449 },21450 {21451 "name": "display_name",21452 "type": "string or null",21453 "required": false,21454 "description": "Human-readable name for the credential."21455 }21456 ],21457 "status": [21458 "DOCUMENTED",21459 "BETA"21460 ],21461 "sources": [21462 {21463 "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",21464 "retrieved_at": "2026-09-18"21465 },21466 {21467 "url": "https://platform.claude.com/docs/en/managed-agents/vaults",21468 "retrieved_at": "2026-09-18"21469 }21470 ],21471 "beta_header": "managed-agents-2026-04-01"21472 },21473 {21474 "provider": "anthropic",21475 "api_family": "managed-agents",21476 "name": "CredentialCreateParams (request body; secret fields write-only)",21477 "official_type_name": "BetaManagedAgentsCredentialCreateParams",21478 "description": "Create Credential",21479 "fields": [21480 {21481 "name": "auth",21482 "type": "BetaManagedAgentsMCPOAuthCreateParams or BetaManagedAgentsStaticBearerCreateParams or BetaManagedAgentsEnvironmentVariableCreateParams",21483 "required": true,21484 "description": "Authentication details for creating a credential."21485 },21486 {21487 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>",21488 "type": "BetaManagedAgentsMCPOAuthCreateParams object",21489 "required": false,21490 "description": "Parameters for creating an MCP OAuth credential."21491 },21492 {21493 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.type",21494 "type": "\"mcp_oauth\"",21495 "required": true,21496 "description": ""21497 },21498 {21499 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.access_token",21500 "type": "string",21501 "required": true,21502 "description": "OAuth access token.",21503 "constraints": {21504 "minLength": "1",21505 "maxLength": "8192"21506 }21507 },21508 {21509 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.mcp_server_url",21510 "type": "string",21511 "required": true,21512 "description": "URL of the MCP server this credential authenticates against.",21513 "constraints": {21514 "minLength": "1",21515 "maxLength": "2047"21516 }21517 },21518 {21519 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.expires_at",21520 "type": "string or null",21521 "required": false,21522 "description": "A timestamp in RFC 3339 format",21523 "constraints": {21524 "format": "date-time"21525 }21526 },21527 {21528 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh",21529 "type": "BetaManagedAgentsMCPOAuthRefreshParams or null",21530 "required": false,21531 "description": "OAuth refresh token parameters for creating a credential with refresh support."21532 },21533 {21534 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh.client_id",21535 "type": "string",21536 "required": true,21537 "description": "OAuth client ID.",21538 "constraints": {21539 "minLength": "1",21540 "maxLength": "1024"21541 }21542 },21543 {21544 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh.refresh_token",21545 "type": "string",21546 "required": true,21547 "description": "OAuth refresh token.",21548 "constraints": {21549 "minLength": "1",21550 "maxLength": "8192"21551 }21552 },21553 {21554 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh.token_endpoint",21555 "type": "string",21556 "required": true,21557 "description": "Token endpoint URL used to refresh the access token.",21558 "constraints": {21559 "minLength": "1",21560 "maxLength": "2047"21561 }21562 },21563 {21564 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh.token_endpoint_auth",21565 "type": "BetaManagedAgentsTokenEndpointAuthNoneParam or BetaManagedAgentsTokenEndpointAuthBasicParam or BetaManagedAgentsTokenEndpointAuthPostParam",21566 "required": true,21567 "description": ""21568 },21569 {21570 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh.token_endpoint_auth<BetaManagedAgentsTokenEndpointAuthNoneParam>",21571 "type": "BetaManagedAgentsTokenEndpointAuthNoneParam object",21572 "required": false,21573 "description": "Token endpoint requires no client authentication."21574 },21575 {21576 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh.token_endpoint_auth<BetaManagedAgentsTokenEndpointAuthNoneParam>.type",21577 "type": "\"none\"",21578 "required": true,21579 "description": ""21580 },21581 {21582 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh.token_endpoint_auth<BetaManagedAgentsTokenEndpointAuthBasicParam>",21583 "type": "BetaManagedAgentsTokenEndpointAuthBasicParam object",21584 "required": false,21585 "description": "Token endpoint uses HTTP Basic authentication with client credentials."21586 },21587 {21588 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh.token_endpoint_auth<BetaManagedAgentsTokenEndpointAuthBasicParam>.type",21589 "type": "\"client_secret_basic\"",21590 "required": true,21591 "description": ""21592 },21593 {21594 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh.token_endpoint_auth<BetaManagedAgentsTokenEndpointAuthBasicParam>.client_secret",21595 "type": "string",21596 "required": true,21597 "description": "OAuth client secret.",21598 "constraints": {21599 "minLength": "1",21600 "maxLength": "512"21601 }21602 },21603 {21604 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh.token_endpoint_auth<BetaManagedAgentsTokenEndpointAuthPostParam>",21605 "type": "BetaManagedAgentsTokenEndpointAuthPostParam object",21606 "required": false,21607 "description": "Token endpoint uses POST body authentication with client credentials."21608 },21609 {21610 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh.token_endpoint_auth<BetaManagedAgentsTokenEndpointAuthPostParam>.type",21611 "type": "\"client_secret_post\"",21612 "required": true,21613 "description": ""21614 },21615 {21616 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh.token_endpoint_auth<BetaManagedAgentsTokenEndpointAuthPostParam>.client_secret",21617 "type": "string",21618 "required": true,21619 "description": "OAuth client secret.",21620 "constraints": {21621 "minLength": "1",21622 "maxLength": "512"21623 }21624 },21625 {21626 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh.resource",21627 "type": "string or null",21628 "required": false,21629 "description": "OAuth resource indicator.",21630 "constraints": {21631 "minLength": "1",21632 "maxLength": "2047"21633 }21634 },21635 {21636 "name": "auth<BetaManagedAgentsMCPOAuthCreateParams>.refresh.scope",21637 "type": "string or null",21638 "required": false,21639 "description": "OAuth scope for the refresh request.",21640 "constraints": {21641 "minLength": "1",21642 "maxLength": "8192"21643 }21644 },21645 {21646 "name": "auth<BetaManagedAgentsStaticBearerCreateParams>",21647 "type": "BetaManagedAgentsStaticBearerCreateParams object",21648 "required": false,21649 "description": "Parameters for creating a static bearer token credential."21650 },21651 {21652 "name": "auth<BetaManagedAgentsStaticBearerCreateParams>.type",21653 "type": "\"static_bearer\"",21654 "required": true,21655 "description": ""21656 },21657 {21658 "name": "auth<BetaManagedAgentsStaticBearerCreateParams>.token",21659 "type": "string",21660 "required": true,21661 "description": "Static bearer token value.",21662 "constraints": {21663 "minLength": "1",21664 "maxLength": "8192"21665 }21666 },21667 {21668 "name": "auth<BetaManagedAgentsStaticBearerCreateParams>.mcp_server_url",21669 "type": "string",21670 "required": true,21671 "description": "URL of the MCP server this credential authenticates against.",21672 "constraints": {21673 "minLength": "1",21674 "maxLength": "2047"21675 }21676 },21677 {21678 "name": "auth<BetaManagedAgentsEnvironmentVariableCreateParams>",21679 "type": "BetaManagedAgentsEnvironmentVariableCreateParams object",21680 "required": false,21681 "description": "Parameters for creating an environment variable credential."21682 },21683 {21684 "name": "auth<BetaManagedAgentsEnvironmentVariableCreateParams>.type",21685 "type": "\"environment_variable\"",21686 "required": true,21687 "description": ""21688 },21689 {21690 "name": "auth<BetaManagedAgentsEnvironmentVariableCreateParams>.networking",21691 "type": "BetaManagedAgentsCredentialNetworkingParams",21692 "required": true,21693 "description": "Outbound hosts the secret value is substituted on."21694 },21695 {21696 "name": "auth<BetaManagedAgentsEnvironmentVariableCreateParams>.networking<BetaManagedAgentsUnrestrictedCredentialNetworkingParams>",21697 "type": "BetaManagedAgentsUnrestrictedCredentialNetworkingParams object",21698 "required": false,21699 "description": "Substitute the secret on any host the session's Environment network policy permits egress to. The Environment's network policy is the only boundary on where the secret can reach."21700 },21701 {21702 "name": "auth<BetaManagedAgentsEnvironmentVariableCreateParams>.networking<BetaManagedAgentsUnrestrictedCredentialNetworkingParams>.type",21703 "type": "\"unrestricted\"",21704 "required": true,21705 "description": ""21706 },21707 {21708 "name": "auth<BetaManagedAgentsEnvironmentVariableCreateParams>.networking<BetaManagedAgentsLimitedCredentialNetworkingParams>",21709 "type": "BetaManagedAgentsLimitedCredentialNetworkingParams object",21710 "required": false,21711 "description": "Substitute the secret only on requests to the listed hosts."21712 },21713 {21714 "name": "auth<BetaManagedAgentsEnvironmentVariableCreateParams>.networking<BetaManagedAgentsLimitedCredentialNetworkingParams>.type",21715 "type": "\"limited\"",21716 "required": true,21717 "description": ""21718 },21719 {21720 "name": "auth<BetaManagedAgentsEnvironmentVariableCreateParams>.networking<BetaManagedAgentsLimitedCredentialNetworkingParams>.allowed_hosts",21721 "type": "array of string",21722 "required": true,21723 "description": "Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries."21724 },21725 {21726 "name": "auth<BetaManagedAgentsEnvironmentVariableCreateParams>.secret_name",21727 "type": "string",21728 "required": true,21729 "description": "Name of the environment variable. Immutable after create.",21730 "constraints": {21731 "minLength": "1",21732 "maxLength": "255"21733 }21734 },21735 {21736 "name": "auth<BetaManagedAgentsEnvironmentVariableCreateParams>.secret_value",21737 "type": "string",21738 "required": true,21739 "description": "Secret value. Write-only; never returned in responses.",21740 "constraints": {21741 "minLength": "1",21742 "maxLength": "4096"21743 }21744 },21745 {21746 "name": "auth<BetaManagedAgentsEnvironmentVariableCreateParams>.injection_location",21747 "type": "BetaManagedAgentsInjectionLocationParams",21748 "required": false,21749 "description": "Where in the outbound request the secret value may be substituted."21750 },21751 {21752 "name": "auth<BetaManagedAgentsEnvironmentVariableCreateParams>.injection_location.body",21753 "type": "boolean",21754 "required": false,21755 "description": "Substitute when the placeholder appears in the request body."21756 },21757 {21758 "name": "auth<BetaManagedAgentsEnvironmentVariableCreateParams>.injection_location.header",21759 "type": "boolean",21760 "required": false,21761 "description": "Substitute when the placeholder appears in a request header value."21762 },21763 {21764 "name": "display_name",21765 "type": "string or null",21766 "required": false,21767 "description": "Human-readable name for the credential. Up to 255 characters.",21768 "constraints": {21769 "maxLength": "255"21770 }21771 },21772 {21773 "name": "metadata",21774 "type": "map[string]",21775 "required": false,21776 "description": "Arbitrary key-value metadata to attach to the credential. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars."21777 }21778 ],21779 "status": [21780 "DOCUMENTED",21781 "BETA"21782 ],21783 "sources": [21784 {21785 "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",21786 "retrieved_at": "2026-09-18"21787 },21788 {21789 "url": "https://platform.claude.com/docs/en/managed-agents/vaults",21790 "retrieved_at": "2026-09-18"21791 }21792 ],21793 "beta_header": "managed-agents-2026-04-01"21794 },21795 {21796 "provider": "anthropic",21797 "api_family": "managed-agents",21798 "name": "CredentialValidation",21799 "official_type_name": "BetaManagedAgentsCredentialValidation",21800 "description": "Result of live-probing a credential against its configured MCP server.",21801 "fields": [21802 {21803 "name": "type",21804 "type": "\"vault_credential_validation\"",21805 "required": true,21806 "description": ""21807 },21808 {21809 "name": "credential_id",21810 "type": "string",21811 "required": true,21812 "description": "Unique identifier of the credential that was validated."21813 },21814 {21815 "name": "has_refresh_token",21816 "type": "boolean",21817 "required": true,21818 "description": "Whether the credential has a refresh token configured."21819 },21820 {21821 "name": "mcp_probe",21822 "type": "BetaManagedAgentsMCPProbe or null",21823 "required": true,21824 "description": "The failing step of an MCP validation probe."21825 },21826 {21827 "name": "mcp_probe.http_response",21828 "type": "BetaManagedAgentsRefreshHTTPResponse or null",21829 "required": true,21830 "description": "An HTTP response captured during a credential validation probe."21831 },21832 {21833 "name": "mcp_probe.http_response.body",21834 "type": "string",21835 "required": true,21836 "description": "Response body. May be truncated and has sensitive values scrubbed."21837 },21838 {21839 "name": "mcp_probe.http_response.body_truncated",21840 "type": "boolean",21841 "required": true,21842 "description": "Whether `body` was truncated."21843 },21844 {21845 "name": "mcp_probe.http_response.content_type",21846 "type": "string",21847 "required": true,21848 "description": "Value of the `Content-Type` response header."21849 },21850 {21851 "name": "mcp_probe.http_response.status_code",21852 "type": "number",21853 "required": true,21854 "description": "HTTP status code.",21855 "constraints": {21856 "format": "int32"21857 }21858 },21859 {21860 "name": "mcp_probe.method",21861 "type": "string",21862 "required": true,21863 "description": "The MCP method that failed (for example `initialize` or `tools/list`)."21864 },21865 {21866 "name": "refresh",21867 "type": "BetaManagedAgentsRefreshObject or null",21868 "required": true,21869 "description": "Outcome of a refresh-token exchange attempted during credential validation."21870 },21871 {21872 "name": "refresh.http_response",21873 "type": "BetaManagedAgentsRefreshHTTPResponse or null",21874 "required": true,21875 "description": "An HTTP response captured during a credential validation probe."21876 },21877 {21878 "name": "refresh.status",21879 "type": "\"succeeded\" or \"failed\" or \"connect_error\" or \"no_refresh_token\"",21880 "required": true,21881 "description": "Outcome of a refresh-token exchange attempted during credential validation.",21882 "enum": [21883 "succeeded",21884 "failed",21885 "connect_error",21886 "no_refresh_token"21887 ]21888 },21889 {21890 "name": "status",21891 "type": "BetaManagedAgentsCredentialValidationStatus",21892 "required": true,21893 "description": "Overall verdict of a credential validation probe.",21894 "enum": [21895 "valid",21896 "invalid",21897 "unknown"21898 ]21899 },21900 {21901 "name": "validated_at",21902 "type": "string",21903 "required": true,21904 "description": "A timestamp in RFC 3339 format",21905 "constraints": {21906 "format": "date-time"21907 }21908 },21909 {21910 "name": "vault_id",21911 "type": "string",21912 "required": true,21913 "description": "Identifier of the vault containing the credential."21914 }21915 ],21916 "status": [21917 "DOCUMENTED",21918 "BETA"21919 ],21920 "sources": [21921 {21922 "url": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/mcp_oauth_validate",21923 "retrieved_at": "2026-09-18"21924 },21925 {21926 "url": "https://platform.claude.com/docs/en/managed-agents/vaults",21927 "retrieved_at": "2026-09-18"21928 }21929 ],21930 "beta_header": "managed-agents-2026-04-01"21931 },21932 {21933 "provider": "anthropic",21934 "api_family": "managed-agents",21935 "name": "Tunnel (workspace Tunnels API, beta mcp-tunnels-2026-06-22)",21936 "official_type_name": "BetaTunnel",21937 "description": "An MCP tunnel.",21938 "fields": [21939 {21940 "name": "type",21941 "type": "\"tunnel\"",21942 "required": true,21943 "description": ""21944 },21945 {21946 "name": "id",21947 "type": "string",21948 "required": true,21949 "description": "Unique identifier for the tunnel, prefixed with `tnl_`."21950 },21951 {21952 "name": "archived_at",21953 "type": "string or null",21954 "required": true,21955 "description": "A timestamp in RFC 3339 format",21956 "constraints": {21957 "format": "date-time"21958 }21959 },21960 {21961 "name": "created_at",21962 "type": "string",21963 "required": true,21964 "description": "A timestamp in RFC 3339 format",21965 "constraints": {21966 "format": "date-time"21967 }21968 },21969 {21970 "name": "display_name",21971 "type": "string or null",21972 "required": true,21973 "description": "Human-readable name for the tunnel (1-255 characters). Null if unset."21974 },21975 {21976 "name": "domain",21977 "type": "string",21978 "required": true,21979 "description": "Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived."21980 }21981 ],21982 "status": [21983 "DOCUMENTED",21984 "BETA",21985 "PREVIEW"21986 ],21987 "sources": [21988 {21989 "url": "https://platform.claude.com/docs/en/api/beta/tunnels/create",21990 "retrieved_at": "2026-09-18"21991 },21992 {21993 "url": "https://platform.claude.com/docs/en/agents-and-tools/mcp-tunnels/reference",21994 "retrieved_at": "2026-09-18"21995 }21996 ],21997 "beta_header": "mcp-tunnels-2026-06-22"21998 },21999 {22000 "provider": "anthropic",22001 "api_family": "managed-agents",22002 "name": "TunnelCertificate",22003 "official_type_name": "BetaTunnelCertificate",22004 "description": "A CA certificate attached to a tunnel.",22005 "fields": [22006 {22007 "name": "type",22008 "type": "\"tunnel_certificate\"",22009 "required": true,22010 "description": ""22011 },22012 {22013 "name": "id",22014 "type": "string",22015 "required": true,22016 "description": "Unique identifier for the certificate, prefixed with `tcrt_`."22017 },22018 {22019 "name": "archived_at",22020 "type": "string or null",22021 "required": true,22022 "description": "A timestamp in RFC 3339 format",22023 "constraints": {22024 "format": "date-time"22025 }22026 },22027 {22028 "name": "created_at",22029 "type": "string",22030 "required": true,22031 "description": "A timestamp in RFC 3339 format",22032 "constraints": {22033 "format": "date-time"22034 }22035 },22036 {22037 "name": "expires_at",22038 "type": "string or null",22039 "required": true,22040 "description": "A timestamp in RFC 3339 format",22041 "constraints": {22042 "format": "date-time"22043 }22044 },22045 {22046 "name": "fingerprint",22047 "type": "string",22048 "required": true,22049 "description": "Lowercase hex SHA-256 fingerprint of the certificate's DER encoding."22050 },22051 {22052 "name": "tunnel_id",22053 "type": "string",22054 "required": true,22055 "description": "ID of the tunnel the certificate is registered against."22056 }22057 ],22058 "status": [22059 "DOCUMENTED",22060 "BETA",22061 "PREVIEW"22062 ],22063 "sources": [22064 {22065 "url": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/create",22066 "retrieved_at": "2026-09-18"22067 },22068 {22069 "url": "https://platform.claude.com/docs/en/agents-and-tools/mcp-tunnels/reference",22070 "retrieved_at": "2026-09-18"22071 }22072 ],22073 "beta_header": "mcp-tunnels-2026-06-22"22074 },22075 {22076 "provider": "anthropic",22077 "api_family": "managed-agents",22078 "name": "TunnelToken",22079 "official_type_name": "BetaTunnelToken",22080 "description": "A tunnel's connector token.",22081 "fields": [22082 {22083 "name": "type",22084 "type": "\"tunnel_token\"",22085 "required": true,22086 "description": ""22087 },22088 {22089 "name": "id",22090 "type": "string",22091 "required": true,22092 "description": "Stable identifier for the current token value. Changes when the token is rotated."22093 },22094 {22095 "name": "tunnel_token",22096 "type": "string",22097 "required": true,22098 "description": "The connector token used to run the tunnel. Treat as a credential."22099 }22100 ],22101 "status": [22102 "DOCUMENTED",22103 "BETA",22104 "PREVIEW"22105 ],22106 "sources": [22107 {22108 "url": "https://platform.claude.com/docs/en/api/beta/tunnels/reveal_token",22109 "retrieved_at": "2026-09-18"22110 }22111 ],22112 "beta_header": "mcp-tunnels-2026-06-22"22113 },22114 {22115 "provider": "anthropic",22116 "api_family": "managed-agents",22117 "name": "UserProfile (separate beta user-profiles-*; not a Managed Agents resource)",22118 "official_type_name": "BetaUserProfile",22119 "description": "Create User Profile",22120 "fields": [22121 {22122 "name": "type",22123 "type": "\"user_profile\"",22124 "required": true,22125 "description": "Object type. Always `user_profile`."22126 },22127 {22128 "name": "id",22129 "type": "string",22130 "required": true,22131 "description": "Unique identifier for this user profile, prefixed `uprof_`."22132 },22133 {22134 "name": "created_at",22135 "type": "string",22136 "required": true,22137 "description": "A timestamp in RFC 3339 format",22138 "constraints": {22139 "format": "date-time"22140 }22141 },22142 {22143 "name": "metadata",22144 "type": "map[string]",22145 "required": true,22146 "description": "Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars."22147 },22148 {22149 "name": "trust_grants",22150 "type": "map[BetaUserProfileTrustGrant]",22151 "required": true,22152 "description": "Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight."22153 },22154 {22155 "name": "trust_grants.status",22156 "type": "\"active\" or \"pending\" or \"rejected\"",22157 "required": true,22158 "description": "Status of the trust grant.",22159 "enum": [22160 "active",22161 "pending",22162 "rejected"22163 ]22164 },22165 {22166 "name": "updated_at",22167 "type": "string",22168 "required": true,22169 "description": "A timestamp in RFC 3339 format",22170 "constraints": {22171 "format": "date-time"22172 }22173 },22174 {22175 "name": "access_type",22176 "type": "\"application\" or \"passthrough\"",22177 "required": false,22178 "description": "How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company.",22179 "enum": [22180 "application",22181 "passthrough"22182 ]22183 },22184 {22185 "name": "external_id",22186 "type": "string or null",22187 "required": false,22188 "description": "Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`."22189 },22190 {22191 "name": "external_user_details",22192 "type": "BetaUserProfileExternalUserDetails",22193 "required": false,22194 "description": "Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value."22195 },22196 {22197 "name": "external_user_details.account_status",22198 "type": "\"active\" or \"suspended\" or \"blocked\" or null",22199 "required": true,22200 "description": "The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.",22201 "enum": [22202 "active",22203 "suspended",22204 "blocked"22205 ]22206 },22207 {22208 "name": "external_user_details.country",22209 "type": "string or null",22210 "required": true,22211 "description": "The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one."22212 },22213 {22214 "name": "external_user_details.email_hash",22215 "type": "string or null",22216 "required": true,22217 "description": "The platform-computed hash of the entity's email address. `null` until the platform supplies one."22218 },22219 {22220 "name": "external_user_details.entity_type",22221 "type": "\"individual\" or \"business\" or \"non_profit\" or \"government\" or null",22222 "required": true,22223 "description": "What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.",22224 "enum": [22225 "individual",22226 "business",22227 "non_profit",22228 "government"22229 ]22230 },22231 {22232 "name": "external_user_details.name_hash",22233 "type": "string or null",22234 "required": true,22235 "description": "The platform-computed hash of the entity's name. `null` until the platform supplies one."22236 },22237 {22238 "name": "external_user_details.onboarded_at",22239 "type": "string or null",22240 "required": true,22241 "description": "A timestamp in RFC 3339 format",22242 "constraints": {22243 "format": "date-time"22244 }22245 },22246 {22247 "name": "external_user_details.reference_id",22248 "type": "string or null",22249 "required": true,22250 "description": "The platform's own reference for the entity. `null` until the platform supplies one."22251 },22252 {22253 "name": "external_user_onboarded_at",22254 "type": "string or null",22255 "required": false,22256 "description": "A timestamp in RFC 3339 format",22257 "constraints": {22258 "format": "date-time"22259 }22260 },22261 {22262 "name": "name",22263 "type": "string or null",22264 "required": false,22265 "description": "Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name."22266 }22267 ],22268 "status": [22269 "DOCUMENTED",22270 "BETA"22271 ],22272 "sources": [22273 {22274 "url": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",22275 "retrieved_at": "2026-09-18"22276 }22277 ],22278 "beta_header": "user-profiles-2026-09-04"22279 },22280 {22281 "provider": "anthropic",22282 "api_family": "managed-agents",22283 "name": "UserProfileEnrollmentURL",22284 "official_type_name": "BetaUserProfileEnrollmentURL",22285 "description": "Create Enrollment URL",22286 "fields": [22287 {22288 "name": "type",22289 "type": "\"enrollment_url\"",22290 "required": true,22291 "description": "Object type. Always `enrollment_url`."22292 },22293 {22294 "name": "expires_at",22295 "type": "string",22296 "required": true,22297 "description": "A timestamp in RFC 3339 format",22298 "constraints": {22299 "format": "date-time"22300 }22301 },22302 {22303 "name": "url",22304 "type": "string",22305 "required": true,22306 "description": "Enrollment URL to send to the end user. Valid until `expires_at`."22307 }22308 ],22309 "status": [22310 "DOCUMENTED",22311 "BETA"22312 ],22313 "sources": [22314 {22315 "url": "https://platform.claude.com/docs/en/api/beta/user_profiles/create_enrollment_url",22316 "retrieved_at": "2026-09-18"22317 }22318 ],22319 "beta_header": "user-profiles-2026-09-04"22320 },22321 {22322 "provider": "anthropic",22323 "api_family": "managed-agents",22324 "name": "WebhookEvent (envelope)",22325 "official_type_name": "BetaWebhookEvent",22326 "description": "Envelope delivered to a registered webhook endpoint. `data.type` is the event type; `data.id` is the affected resource ID (fetch it with GET). Thread events add `session_thread_id`; credential events add `vault_id`.",22327 "fields": [22328 {22329 "name": "type",22330 "type": "\"event\"",22331 "required": true,22332 "description": ""22333 },22334 {22335 "name": "id",22336 "type": "string",22337 "required": true,22338 "description": "Unique per event (not per delivery); equals the webhook-id header. Deduplicate on it."22339 },22340 {22341 "name": "created_at",22342 "type": "string",22343 "required": true,22344 "description": "RFC 3339 time the event occurred."22345 },22346 {22347 "name": "data",22348 "type": "BetaWebhookEventData (union of 44 *EventData variants)",22349 "required": true,22350 "description": ""22351 },22352 {22353 "name": "data.type",22354 "type": "string",22355 "required": true,22356 "description": "Event type string, e.g. session.status_idled."22357 },22358 {22359 "name": "data.id",22360 "type": "string",22361 "required": true,22362 "description": "ID of the resource that triggered the event."22363 },22364 {22365 "name": "data.organization_id",22366 "type": "string",22367 "required": true,22368 "description": ""22369 },22370 {22371 "name": "data.workspace_id",22372 "type": "string",22373 "required": true,22374 "description": ""22375 },22376 {22377 "name": "data.session_thread_id",22378 "type": "string",22379 "required": false,22380 "description": "Only on session.thread_created / session.thread_idled / session.thread_terminated."22381 },22382 {22383 "name": "data.vault_id",22384 "type": "string",22385 "required": false,22386 "description": "Only on vault_credential.* events."22387 }22388 ],22389 "status": [22390 "DOCUMENTED",22391 "BETA"22392 ],22393 "sources": [22394 {22395 "url": "https://platform.claude.com/docs/en/api/beta/webhooks",22396 "retrieved_at": "2026-09-18"22397 },22398 {22399 "url": "https://platform.claude.com/docs/en/managed-agents/webhooks",22400 "retrieved_at": "2026-09-18"22401 }22402 ],22403 "beta_header": "managed-agents-2026-04-01"22404 },22405 {22406 "provider": "anthropic",22407 "api_family": "compliance",22408 "name": "Activity",22409 "official_type_name": "Activity (discriminated union on `type`)",22410 "description": "One Activity Feed event. Common fields id/created_at/organization_id/organization_uuid/actor/type; each `type` adds type-specific fields (e.g. claude_chat_id, filename).",22411 "fields": [22412 {22413 "name": "type",22414 "type": "\"abuse_decision_received\"",22415 "required": false,22416 "constraints": {22417 "default": "abuse_decision_received"22418 }22419 },22420 {22421 "name": "actor",22422 "type": "APIActor or UserActor or UnauthenticatedUserActor or 8 more",22423 "required": true,22424 "children": [22425 {22426 "variant": "APIActor object",22427 "fields": [22428 {22429 "name": "type",22430 "type": "\"api_actor\"",22431 "required": false,22432 "constraints": {22433 "default": "api_actor"22434 }22435 },22436 {22437 "name": "api_key_id",22438 "type": "string",22439 "required": true22440 },22441 {22442 "name": "ip_address",22443 "type": "string",22444 "required": true22445 },22446 {22447 "name": "user_agent",22448 "type": "string",22449 "required": true22450 }22451 ]22452 },22453 {22454 "variant": "UserActor object",22455 "fields": [22456 {22457 "name": "type",22458 "type": "\"user_actor\"",22459 "required": false,22460 "constraints": {22461 "default": "user_actor"22462 }22463 },22464 {22465 "name": "email_address",22466 "type": "string",22467 "required": true,22468 "constraints": {22469 "format": "email"22470 }22471 },22472 {22473 "name": "ip_address",22474 "type": "string",22475 "required": true22476 },22477 {22478 "name": "user_agent",22479 "type": "string",22480 "required": true22481 },22482 {22483 "name": "user_id",22484 "type": "string",22485 "required": true22486 }22487 ]22488 },22489 {22490 "variant": "UnauthenticatedUserActor object",22491 "fields": [22492 {22493 "name": "type",22494 "type": "\"unauthenticated_user_actor\"",22495 "required": false,22496 "constraints": {22497 "default": "unauthenticated_user_actor"22498 }22499 },22500 {22501 "name": "ip_address",22502 "type": "string",22503 "required": true22504 },22505 {22506 "name": "user_agent",22507 "type": "string",22508 "required": true22509 },22510 {22511 "name": "unauthenticated_email_address",22512 "type": "string or null",22513 "required": false,22514 "constraints": {22515 "format": "email"22516 }22517 }22518 ]22519 },22520 {22521 "variant": "AnthropicActor object",22522 "fields": [22523 {22524 "name": "type",22525 "type": "\"anthropic_actor\"",22526 "required": false,22527 "constraints": {22528 "default": "anthropic_actor"22529 }22530 },22531 {22532 "name": "email_address",22533 "type": "string or null",22534 "required": false,22535 "constraints": {22536 "format": "email"22537 }22538 }22539 ]22540 },22541 {22542 "variant": "SystemActor object",22543 "fields": [22544 {22545 "name": "type",22546 "type": "\"system_actor\"",22547 "required": false,22548 "constraints": {22549 "default": "system_actor"22550 }22551 },22552 {22553 "name": "service",22554 "type": "string or null",22555 "required": false,22556 "description": "Name of the automated process that performed the action, when known."22557 }22558 ]22559 },22560 {22561 "variant": "AdminAPIKeyActor object",22562 "fields": [22563 {22564 "name": "type",22565 "type": "\"admin_api_key_actor\"",22566 "required": false,22567 "constraints": {22568 "default": "admin_api_key_actor"22569 }22570 },22571 {22572 "name": "admin_api_key_id",22573 "type": "string",22574 "required": true22575 },22576 {22577 "name": "ip_address",22578 "type": "string",22579 "required": true22580 },22581 {22582 "name": "user_agent",22583 "type": "string",22584 "required": true22585 }22586 ]22587 },22588 {22589 "variant": "ServiceAccountActor object",22590 "fields": [22591 {22592 "name": "type",22593 "type": "\"service_account_actor\"",22594 "required": false,22595 "constraints": {22596 "default": "service_account_actor"22597 }22598 },22599 {22600 "name": "ip_address",22601 "type": "string",22602 "required": true22603 },22604 {22605 "name": "service_account_id",22606 "type": "string",22607 "required": true22608 },22609 {22610 "name": "user_agent",22611 "type": "string",22612 "required": true22613 }22614 ]22615 },22616 {22617 "variant": "ScimDirectorySyncActor object",22618 "fields": [22619 {22620 "name": "type",22621 "type": "\"scim_directory_sync_actor\"",22622 "required": false,22623 "constraints": {22624 "default": "scim_directory_sync_actor"22625 }22626 },22627 {22628 "name": "directory_id",22629 "type": "string",22630 "required": true22631 },22632 {22633 "name": "workos_event_id",22634 "type": "string",22635 "required": true22636 },22637 {22638 "name": "idp_connection_type",22639 "type": "string or null",22640 "required": false22641 }22642 ]22643 },22644 {22645 "variant": "FederatedIdentityActor object",22646 "fields": [22647 {22648 "name": "type",22649 "type": "\"federated_identity_actor\"",22650 "required": false,22651 "constraints": {22652 "default": "federated_identity_actor"22653 }22654 },22655 {22656 "name": "issuer",22657 "type": "string",22658 "required": true22659 },22660 {22661 "name": "subject",22662 "type": "string",22663 "required": true22664 },22665 {22666 "name": "audience",22667 "type": "array of string",22668 "required": false22669 },22670 {22671 "name": "ip_address",22672 "type": "string or null",22673 "required": false22674 },22675 {22676 "name": "user_agent",22677 "type": "string or null",22678 "required": false22679 }22680 ]22681 },22682 {22683 "variant": "FederatedActor object",22684 "fields": [22685 {22686 "name": "type",22687 "type": "\"federated_actor\"",22688 "required": false,22689 "constraints": {22690 "default": "federated_actor"22691 }22692 },22693 {22694 "name": "provider",22695 "type": "FederatedActorAwsProvider or FederatedActorAzureProvider or FederatedActorGcpProvider or FederatedActorOidcProvider",22696 "required": true,22697 "children": [22698 {22699 "variant": "FederatedActorAwsProvider object",22700 "fields": [22701 {22702 "name": "type",22703 "type": "\"aws\"",22704 "required": false,22705 "constraints": {22706 "default": "aws"22707 }22708 },22709 {22710 "name": "account_id",22711 "type": "string",22712 "required": true22713 },22714 {22715 "name": "signed_principal",22716 "type": "string",22717 "required": true,22718 "description": "The AWS-signed ARN of the IAM principal that requested the token."22719 }22720 ]22721 },22722 {22723 "variant": "FederatedActorAzureProvider object",22724 "fields": [22725 {22726 "name": "type",22727 "type": "\"azure\"",22728 "required": false,22729 "constraints": {22730 "default": "azure"22731 }22732 },22733 {22734 "name": "subscription_id",22735 "type": "string",22736 "required": true22737 }22738 ]22739 },22740 {22741 "variant": "FederatedActorGcpProvider object",22742 "fields": [22743 {22744 "name": "type",22745 "type": "\"gcp\"",22746 "required": false,22747 "constraints": {22748 "default": "gcp"22749 }22750 },22751 {22752 "name": "project_number",22753 "type": "string",22754 "required": true22755 }22756 ]22757 },22758 {22759 "variant": "FederatedActorOidcProvider object",22760 "fields": [22761 {22762 "name": "type",22763 "type": "\"oidc\"",22764 "required": false,22765 "constraints": {22766 "default": "oidc"22767 }22768 },22769 {22770 "name": "issuer",22771 "type": "string or null",22772 "required": false,22773 "description": "The federation issuer's URL. Null when the presented credential failed verification."22774 }22775 ]22776 }22777 ]22778 },22779 {22780 "name": "ip_address",22781 "type": "string or null",22782 "required": false22783 },22784 {22785 "name": "subject",22786 "type": "string or null",22787 "required": false,22788 "description": "The provider's verified identifier for the caller; its form depends on the provider."22789 },22790 {22791 "name": "user_agent",22792 "type": "string or null",22793 "required": false22794 }22795 ]22796 },22797 {22798 "variant": "AttestedDeviceActor object",22799 "fields": [22800 {22801 "name": "type",22802 "type": "\"attested_device_actor\"",22803 "required": false,22804 "constraints": {22805 "default": "attested_device_actor"22806 }22807 },22808 {22809 "name": "external_client_id",22810 "type": "string",22811 "required": true22812 },22813 {22814 "name": "kid_hash",22815 "type": "string",22816 "required": true22817 },22818 {22819 "name": "ip_address",22820 "type": "string or null",22821 "required": false22822 },22823 {22824 "name": "user_agent",22825 "type": "string or null",22826 "required": false22827 }22828 ]22829 }22830 ]22831 },22832 {22833 "name": "id",22834 "type": "string",22835 "required": false,22836 "description": "Unique identifier for the activity e.g. 'activity_abcd1234'"22837 },22838 {22839 "name": "created_at",22840 "type": "string",22841 "required": false,22842 "description": "When this activity occurred.",22843 "constraints": {22844 "format": "date-time"22845 }22846 },22847 {22848 "name": "organization_id",22849 "type": "string or null",22850 "required": false,22851 "description": "Organization ID this activity is associated with"22852 },22853 {22854 "name": "organization_uuid",22855 "type": "string or null",22856 "required": false,22857 "description": "Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API)."22858 }22859 ],22860 "status": [22861 "DOCUMENTED",22862 "ACCOUNT_RESTRICTED"22863 ],22864 "sources": [22865 {22866 "url": "https://platform.claude.com/docs/en/api/compliance/activities/list",22867 "retrieved_at": "2026-09-18"22868 }22869 ],22870 "union_variants": [22871 "AbuseDecisionReceived",22872 "AccountDeleted",22873 "AdminAPIKeyCreated",22874 "AdminAPIKeyDeleted",22875 "AdminAPIKeyUpdated",22876 "AdminConnectorRequestResolved",22877 "AdminRequestCreated",22878 "AdminSetupChecklistStepDelegated",22879 "AdminSetupChecklistStepDelegationCancelled",22880 "AgeVerified",22881 "AnonymousMobileLoginAttempted",22882 "APIKeyCreated",22883 "ClaudeArtifactAccessFailed",22884 "ClaudeArtifactCommented",22885 "ClaudeArtifactCommentsViewed",22886 "ClaudeArtifactCreated",22887 "ClaudePublishedArtifactDeleted",22888 "ClaudeArtifactPublished",22889 "ClaudeArtifactSharingUpdated",22890 "ClaudeArtifactViewed",22891 "AuditLogExportAccessed",22892 "AuditLogExportStarted",22893 "BillingEmailsUpdated",22894 "CcrAgentCreated",22895 "CcrAgentDeleted",22896 "CcrAgentProxyAnthropicOidcTokenExchanged",22897 "CcrAgentProxyAnthropicOidcTokenMinted",22898 "CcrAgentProxyCredentialCreated",22899 "CcrAgentProxyCredentialDeleted",22900 "CcrAgentProxyCredentialRotated",22901 "CcrAgentProxyCredentialUpdated",22902 "CcrAgentProxyDestinationDeleted",22903 "CcrAgentProxyNetworkEventsListed",22904 "CcrAgentProxyProfileBound",22905 "CcrAgentProxyProfileCreated",22906 "CcrAgentProxyProfileDeleted",22907 "CcrAgentProxyProfileUnbound",22908 "CcrAgentProxyProfileUpdated",22909 "CcrAgentProxyProvisioningCredentialRejected",22910 "CcrAgentProxyProvisioningLinkEnabled",22911 "CcrAgentProxyProvisioningLinkGenerated",22912 "CcrAgentProxyProvisioningLinkRevoked",22913 "CcrAgentProxyProvisioningLinkSubmitted",22914 "CcrAgentProxyRuleCreated",22915 "CcrAgentProxyRuleDeleted",22916 "CcrAgentProxyRuleUpdated",22917 "CcrAgentSlackAccessScopeCreated",22918 "CcrAgentSlackAccessScopeDeleted",22919 "CcrAgentSlackBindingCreated",22920 "CcrAgentSlackBindingDeleted",22921 "CcrAgentUpdated",22922 "CcrChannelManagerAdded",22923 "CcrChannelManagerRemoved",22924 "CcrRoleChannelAssignmentDeleted",22925 "CcrRoleChannelAssignmentUpdated",22926 "CcrSessionCreated",22927 "CcrSessionDeleted",22928 "CcrSessionUpdated",22929 "CcrSlackChannelJoined",22930 "ClaudeChatSettingsUpdated",22931 "ClaudeChatSnapshotCreated",22932 "ClaudeChatSnapshotDeleted",22933 "ClaudeChatSnapshotViewed",22934 "ClaudeArtifactDuplicated",22935 "ClaudeArtifactExternalSharingPermissionUpdated",22936 "ClaudeChatAccessFailed",22937 "ClaudeChatCreated",22938 "ClaudeChatDeleted",22939 "ClaudeChatDeletionFailed",22940 "ClaudeChatSyncSourceCreated",22941 "ClaudeChatSyncSourceDeleted",22942 "ClaudeChatSyncSourceUpdated",22943 "ClaudeChatUpdated",22944 "ClaudeChatViewed",22945 "ClaudeCodeCredentialRevoked",22946 "ClaudeCodeReviewConfigUpdated",22947 "ClaudeCodeReviewRepositoryAdded",22948 "ClaudeCodeReviewRepositoryRemoved",22949 "ClaudeCodeReviewRepositoryUpdated",22950 "ClaudeCodeRunnerDeleted",22951 "ClaudeCodeRunnerPoolCreated",22952 "ClaudeCodeRunnerPoolDeleted",22953 "ClaudeCodeRunnerPoolSecretMinted",22954 "ClaudeCodeRunnerPoolSessionQueueUpdated",22955 "ClaudeCodeRunnerPoolUpdated",22956 "ClaudeCodeSecurityCenterConfigUpdated",22957 "ClaudeCodeSecurityScanCancelled",22958 "ClaudeCodeSecurityScanCreated",22959 "ClaudeCodeSecurityScanProjectMemberUpdated",22960 "ClaudeCodeSecurityScanProjectUpdated",22961 "ClaudeCodeSecurityScanProjectVisibilityUpdated",22962 "ClaudeCodeSecurityScanRunUpdated",22963 "ClaudeCodeSecurityScanScheduleDeleted",22964 "ClaudeCodeSecurityScanScheduleUpdated",22965 "ClaudeCodeSecurityVulnerabilityDeleted",22966 "ClaudeCodeSecurityVulnerabilityFixSessionCreated",22967 "ClaudeCodeSecurityVulnerabilityUpdated",22968 "ClaudeCodeSecurityWebhookCreated",22969 "ClaudeCodeSecurityWebhookDeleted",22970 "ClaudeCodeSecurityWebhookSecretUpdated",22971 "ClaudeCodeSecurityWebhookUpdated",22972 "ClaudeCodeTeamMemoryACLUpdated",22973 "ClaudeCodeTeamMemoryUpdated",22974 "ClaudeCodeTeamOnboardingGuideUpdated",22975 "ClaudeCodeUserMarketplacesUpdated",22976 "ClaudeCodeUserMemoryUpdated",22977 "ClaudeCodeUserPluginsUpdated",22978 "ClaudeCodeUserSettingsUpdated",22979 "ClaudeEnterpriseUpgradeCreditUpdated",22980 "ClaudeFileAccessFailed",22981 "ClaudeFileExported",22982 "ClaudeFileViewed",22983 "ClaudeProjectSyncSourceCreated",22984 "ClaudeProjectSyncSourceDeleted",22985 "ClaudeProjectSyncSourceUpdated",22986 "ClaudeUserSeatTierUpdated",22987 "CliPluginExecPolicyUpdated",22988 "ClaudeCommandCreated",22989 "ClaudeCommandDeleted",22990 "ClaudeCommandReplaced",22991 "ComplianceAPIAccessed",22992 "CoworkSessionUpdated",22993 "DesignProjectArtifactPublished",22994 "DesignProjectCreated",22995 "DesignProjectDeleted",22996 "DesignProjectMemberAdded",22997 "DesignProjectMemberRemoved",22998 "DesignProjectMemberRoleUpdated",22999 "DesignProjectPublished",23000 "DesignProjectSharingUpdated",23001 "DesignProjectUnpublished",23002 "DesignProjectUpdated",23003 "DesignProjectVersionRestored",23004 "DesignProjectViewed",23005 "DesktopExtensionAllowlisted",23006 "DesktopExtensionBlocklisted",23007 "DesktopExtensionDeleted",23008 "DesktopExtensionRemovedFromAllowlist",23009 "DesktopExtensionUnblocked",23010 "DesktopExtensionUploaded",23011 "DesktopExtensionVersionUploaded",23012 "InferenceHooksConfigDeleted",23013 "InferenceHooksConfigUpdated",23014 "InferenceHooksSigningSecretGenerated",23015 "DomainClaimInitiated",23016 "EndUserInviteRequested",23017 "ExtraUsageBillingEnabled",23018 "ExtraUsageCreditGranted",23019 "ExtraUsageSpendLimitCreated",23020 "ExtraUsageSpendLimitDeleted",23021 "ExtraUsageSpendLimitIncreaseRequestApproved",23022 "ExtraUsageSpendLimitIncreaseRequestDenied",23023 "ExtraUsageSpendLimitUpdated",23024 "ClaudeFileDeleted",23025 "ClaudeFileUploaded",23026 "GheConfigurationCreated",23027 "GheConfigurationDeleted",23028 "GheConfigurationUpdated",23029 "GheUserConnected",23030 "GheUserDisconnected",23031 "GheWebhookSignatureInvalid",23032 "ClaudeGitHubIntegrationCreated",23033 "ClaudeGitHubIntegrationDeleted",23034 "ClaudeGitHubIntegrationUpdated",23035 "GitHubAppInstallationLinked",23036 "GitHubAppInstallationUnlinked",23037 "GitHubTokenImport",23038 "ClaudeGdriveIntegrationCreated",23039 "ClaudeGdriveIntegrationDeleted",23040 "ClaudeGdriveIntegrationUpdated",23041 "GroupCreated",23042 "GroupDeleted",23043 "GroupListViewed",23044 "GroupMemberAdded",23045 "GroupMemberAdditionFailed",23046 "GroupMemberListViewed",23047 "GroupMemberRemovalFailed",23048 "GroupMemberRemoved",23049 "GroupProjectSharesRevoked",23050 "GroupSkillSharesRevoked",23051 "GroupUpdated",23052 "GroupViewed",23053 "GroupVisibilityUpdated",23054 "InferenceHooksCircuitBreakerTripped",23055 "InferenceHooksRequestDenied",23056 "InferenceHooksRequestFailedOpen",23057 "IntegrationUserConnected",23058 "IntegrationUserDisconnected",23059 "InvoiceCollectionMethodUpdated",23060 "UserLoggedOut",23061 "LtiLaunchInitiated",23062 "LtiLaunchSuccess",23063 "LtiPlatformCreated",23064 "LtiPlatformUpdated",23065 "MagicLinkLoginFailed",23066 "MagicLinkLoginInitiated",23067 "MagicLinkLoginSucceeded",23068 "ManagedOrganizationSetupCompleted",23069 "MarketplaceCreated",23070 "MarketplaceDeleted",23071 "MarketplaceUpdated",23072 "MarketplaceWebhookDeleted",23073 "MarketplaceWebhookProvisioned",23074 "McpDirectoryServerPublished",23075 "McpServerCreated",23076 "McpServerDeleted",23077 "McpServerManagedAuthTokenExchanged",23078 "McpServerManagedAuthUpdated",23079 "McpServerUpdated",23080 "McpToolPolicyUpdated",23081 "OrgAnalyticsAPICapabilityUpdated",23082 "OrgBulkDeleteInitiated",23083 "OrgCapabilityGrantAdded",23084 "OrgCapabilityGrantRemoved",23085 "OrgClaudeCodeDataSharingDisabled",23086 "OrgClaudeCodeDataSharingEnabled",23087 "OrgClaudeCodeDesktopDisabled",23088 "OrgClaudeCodeDesktopEnabled",23089 "OrgClaudeCodeZeroDataRetentionDisabled",23090 "OrgComplianceAPISettingsUpdated",23091 "OrgConnectorDomainGuardUpdated",23092 "OrgCoworkActWithoutAskingModeDisabled",23093 "OrgCoworkActWithoutAskingModeEnabled",23094 "OrgCoworkAgentDisabled",23095 "OrgCoworkAgentEnabled",23096 "OrgCoworkAutoModeDisabled",23097 "OrgCoworkAutoModeEnabled",23098 "OrgCoworkBrowserPaneDisabled",23099 "OrgCoworkBrowserPaneEnabled",23100 "OrgCoworkDisabled",23101 "OrgCoworkEnabled",23102 "OrgCoworkMcpAlwaysAllowDisabled",23103 "OrgCoworkMcpAlwaysAllowEnabled",23104 "OrgCoworkOtlpSettingsUpdated",23105 "OrgCoworkRemoteDisabled",23106 "OrgCoworkRemoteEnabled",23107 "OrgCreationBlocked",23108 "OrgDataExportAccessed",23109 "OrgDataExportCompleted",23110 "OrgDataExportStarted",23111 "OrgDataResidencyUpdated",23112 "OrgDeletedViaBulk",23113 "OrgDeletionRequested",23114 "OrgDirectoryResyncCompleted",23115 "OrgDirectoryResyncFailed",23116 "OrgDirectoryResyncStarted",23117 "OrgDirectorySyncActivated",23118 "OrgDirectorySyncAddInitiated",23119 "OrgDirectorySyncDeleted",23120 "OrgDiscoverabilityDisabled",23121 "OrgDiscoverabilityEnabled",23122 "OrgDiscoverabilitySettingsUpdated",23123 "OrgDomainAddInitiated",23124 "OrgDomainRemoved",23125 "OrgDomainVerified",23126 "OrgExternalKeyCreated",23127 "OrgExternalKeyDeleted",23128 "OrgExternalKeyUpdated",23129 "OrgExternalKeyValidated",23130 "OrgHipaaSelfServeEnabled",23131 "OrgIPRestrictionCreated",23132 "OrgIPRestrictionDeleted",23133 "OrgIPRestrictionUpdated",23134 "OrgInviteLinkDisabled",23135 "OrgInviteLinkGenerated",23136 "OrgInviteLinkRegenerated",23137 "OrgInviteViewed",23138 "OrgInvitesListed",23139 "OrgJoinProposalDecided",23140 "OrgJoinRequestApproved",23141 "OrgJoinRequestCreated",23142 "OrgJoinRequestDismissed",23143 "OrgJoinRequestInstantApproved",23144 "OrgJoinRequestsBulkDismissed",23145 "OrgMagicLinkSecondFactorToggled",23146 "OrgMemberInvitesDisabled",23147 "OrgMemberInvitesEnabled",23148 "OrgMembersExported",23149 "OrgModelDefaultUpdated",23150 "OrgParentJoinProposalCreated",23151 "OrgParentSearchPerformed",23152 "OrgSSOAddInitiated",23153 "OrgSSOConnectionActivated",23154 "OrgSSOConnectionDeactivated",23155 "OrgSSOConnectionDeleted",23156 "OrgSSOGroupRoleMappingsUpdated",23157 "OrgSSOProvisioningModeChanged",23158 "OrgSSOScimWelcomeEmailToggled",23159 "OrgSSOSeatTierAssignmentToggled",23160 "OrgSSOSeatTierMappingsUpdated",23161 "OrgSSOToggled",23162 "OrgSyncDeletingSynchronizedFilesStarted",23163 "OrgSyncSynchronizedFilesDeleted",23164 "OrgTaintAdded",23165 "OrgTaintRemoved",23166 "OrgUserDeleted",23167 "OrgUserInviteAccepted",23168 "OrgUserInviteDeleted",23169 "OrgUserInviteReSent",23170 "OrgUserInviteRejected",23171 "OrgUserInviteSent",23172 "OrgUserLeft",23173 "OrgUserSharesRetained",23174 "OrgUserTrustedDevicesRevoked",23175 "OrgUserViewed",23176 "OrgUsersListed",23177 "OrgWorkAcrossAppsDisabled",23178 "OrgWorkAcrossAppsEnabled",23179 "OrganizationAddressUpdated",23180 "OrganizationIconDeleted",23181 "OrganizationIconUpdated",23182 "ClaudeOrganizationSettingsUpdated",23183 "OwnedProjectsAccessRestored",23184 "PaymentMethodUpdated",23185 "PendingShareCreated",23186 "PendingShareRevoked",23187 "PhoneCodeSent",23188 "PhoneCodeVerified",23189 "PlatformAgentArchived",23190 "PlatformAgentCreated",23191 "PlatformAgentDeleted",23192 "PlatformAgentDeploymentArchived",23193 "PlatformAgentDeploymentCreated",23194 "PlatformAgentDeploymentDeleted",23195 "PlatformAgentDeploymentPaused",23196 "PlatformAgentDeploymentRunTriggered",23197 "PlatformAgentDeploymentUnpaused",23198 "PlatformAgentDeploymentUpdated",23199 "PlatformAgentSessionArchived",23200 "PlatformAgentSessionCreated",23201 "PlatformAgentSessionDeleted",23202 "PlatformAgentSessionResourceAdded",23203 "PlatformAgentSessionResourceDeleted",23204 "PlatformAgentSessionResourceUpdated",23205 "PlatformAgentSessionThreadArchived",23206 "PlatformAgentSessionUpdated",23207 "PlatformAgentUpdated",23208 "PlatformAPIKeyCreated",23209 "PlatformAPIKeyUpdated",23210 "PlatformAppAttestAuthentication",23211 "PlatformBillingUpgradedToPrepaid",23212 "PlatformClearanceWorkspaceProgramRequestCleared",23213 "PlatformClearanceWorkspaceProgramRequestSet",23214 "PlatformCostReportViewed",23215 "PlatformDreamArchived",23216 "PlatformDreamCancelled",23217 "PlatformDreamCreated",23218 "PlatformFederatedAuthentication",23219 "PlatformFederationIssuerArchived",23220 "PlatformFederationIssuerCreated",23221 "PlatformFederationIssuerUpdated",23222 "PlatformFederationRuleArchived",23223 "PlatformFederationRuleCreated",23224 "PlatformFederationRuleUpdated",23225 "PlatformFederationRuleWorkspaceAdded",23226 "PlatformFederationRuleWorkspaceRemoved",23227 "PlatformFileContentDownloaded",23228 "PlatformFileDeleted",23229 "PlatformFileUploaded",23230 "PlatformMemoryCreated",23231 "PlatformMemoryDeleted",23232 "PlatformMemoryStoreArchived",23233 "PlatformMemoryStoreCreated",23234 "PlatformMemoryStoreDeleted",23235 "PlatformMemoryStoreUpdated",23236 "PlatformMemoryUpdated",23237 "PlatformMemoryVersionRedacted",23238 "PlatformOAuthAppCreated",23239 "PlatformOAuthAppRevoked",23240 "PlatformOAuthAppUpdated",23241 "PlatformPluginDirectorySubmissionCreated",23242 "PlatformPluginDirectorySubmissionDeleted",23243 "PlatformPluginDirectorySubmissionUpdated",23244 "PlatformServiceAccountArchived",23245 "PlatformServiceAccountCreated",23246 "PlatformServiceAccountUpdated",23247 "PlatformServiceAccountWorkspaceMemberAdded",23248 "PlatformServiceAccountWorkspaceMemberRemoved",23249 "PlatformServiceAccountWorkspaceMemberUpdated",23250 "PlatformSigningKeyCreated",23251 "PlatformSigningKeyDeleted",23252 "PlatformSigningKeyRotated",23253 "PlatformSkillVersionContentDownloaded",23254 "PlatformSkillVersionCreated",23255 "PlatformSkillVersionDeleted",23256 "PlatformSpendLimitAlertEmailsUpdated",23257 "PlatformSpendLimitCreated",23258 "PlatformSpendLimitDeleted",23259 "PlatformSpendLimitUpdated",23260 "PlatformUsageReportClaudeCodeViewed",23261 "PlatformUsageReportMessagesViewed",23262 "PlatformWorkspaceArchived",23263 "PlatformWorkspaceCreated",23264 "PlatformWorkspaceInferenceDataRetentionDisabled",23265 "PlatformWorkspaceInferenceDataRetentionEnabled",23266 "PlatformWorkspaceMemberAdded",23267 "PlatformWorkspaceMemberRemoved",23268 "PlatformWorkspaceMemberUpdated",23269 "PlatformWorkspaceMemberViewed",23270 "PlatformWorkspaceMembersListed",23271 "PlatformWorkspaceRateLimitDeleted",23272 "PlatformWorkspaceRateLimitUpdated",23273 "PlatformWorkspaceUpdated",23274 "ClaudePluginCreated",23275 "ClaudePluginDeleted",23276 "ClaudePluginDisabled",23277 "ClaudePluginEnabled",23278 "PluginInstallationPreferenceUpdated",23279 "ClaudePluginReplaced",23280 "ClaudePluginSecurityScanCompleted",23281 "ClaudePluginUpdated",23282 "PrepaidAutoRechargeDisabled",23283 "PrepaidAutoRechargeUpdated",23284 "PrepaidExtraUsageAutoReloadDisabled",23285 "PrepaidExtraUsageAutoReloadEnabled",23286 "PrepaidExtraUsageAutoReloadSettingsUpdated",23287 "PrimaryOwnerTransferred",23288 "ClaudeProjectArchived",23289 "ClaudeProjectCreated",23290 "ClaudeProjectDeleted",23291 "ClaudeProjectDocumentAccessFailed",23292 "ClaudeProjectDocumentBulkDeletionAuditTruncated",23293 "ClaudeProjectDocumentDeleted",23294 "ClaudeProjectDocumentDeletionFailed",23295 "ClaudeProjectDocumentUpdated",23296 "ClaudeProjectDocumentUploaded",23297 "ClaudeProjectDocumentViewed",23298 "ClaudeProjectFileAccessFailed",23299 "ClaudeProjectFileBulkDeletionAuditTruncated",23300 "ClaudeProjectFileDeleted",23301 "ClaudeProjectFileDeletionFailed",23302 "ClaudeProjectFileUploaded",23303 "ClaudeProjectReported",23304 "ClaudeProjectSharingUpdated",23305 "ClaudeProjectViewed",23306 "ClaudePubsecIdentityConfigured",23307 "RbacRoleAssigned",23308 "RbacRoleCreated",23309 "RbacRoleDeleted",23310 "RbacRoleGrantUpdated",23311 "RbacRolePermissionAdded",23312 "RbacRolePermissionRemoved",23313 "RbacRoleUnassigned",23314 "RbacRoleUpdated",23315 "RoleAssignmentGranted",23316 "RoleAssignmentRevoked",23317 "SSOLoginFailed",23318 "SSOLoginInitiated",23319 "SSOLoginSucceeded",23320 "SSOSecondFactorMagicLink",23321 "ScimUserCreated",23322 "ScimUserDeleted",23323 "ScimUserUpdated",23324 "ScopedAPIKeyDeleted",23325 "ScopedAPIKeyUpdated",23326 "SeatTierChangesCancelled",23327 "SeatTiersPurchased",23328 "ServiceCreated",23329 "ServiceDeleted",23330 "ServiceKeyCreated",23331 "ServiceKeyRevoked",23332 "SessionRevoked",23333 "SessionShareAccessed",23334 "SessionShareCreated",23335 "SessionShareRevoked",23336 "ClaudeSkillCreated",23337 "ClaudeSkillDeleted",23338 "ClaudeSkillDisabled",23339 "ClaudeSkillEnabled",23340 "ClaudeSkillReplaced",23341 "ClaudeSkillSecurityScanCompleted",23342 "SlackWorkspaceClaimRevoked",23343 "SlackWorkspaceClaimed",23344 "SocialLoginSucceeded",23345 "StepUpAuthenticationFailed",23346 "StepUpAuthenticationSucceeded",23347 "StepUpCredentialEnrolled",23348 "SubscriptionCancellationScheduled",23349 "SubscriptionQuantityUpdated",23350 "SubscriptionRenewed",23351 "SubscriptionResumed",23352 "SubscriptionStarted",23353 "SubscriptionUpgraded",23354 "TrustedDeviceCredentialRotated",23355 "TrustedDeviceEnrolled",23356 "TrustedDeviceRevoked",23357 "TunnelArchived",23358 "TunnelCertificateAdded",23359 "TunnelCertificateRevoked",23360 "TunnelCreated",23361 "TunnelTokenMinted",23362 "TunnelTokenRevealed",23363 "TunnelTokenRevoked",23364 "TunnelTokenRotated",23365 "UserConsentRecorded",23366 "UserConsentRevoked",23367 "ClaudeUserRoleUpdated",23368 "ClaudeUserSettingsUpdated",23369 "VerificationEvidenceSubmitted",23370 "VerificationProgramApplicationCreated",23371 "WorkspaceMemberSpendLimitCreated",23372 "WorkspaceMemberSpendLimitDeleted",23373 "WorkspaceMemberSpendLimitUpdated",23374 "WorkspaceSpendLimitAlertEmailsUpdated",23375 "WorkspaceSpendLimitCreated",23376 "WorkspaceSpendLimitDeleted"23377 ]23378 },23379 {23380 "provider": "anthropic",23381 "api_family": "compliance",23382 "name": "Actor",23383 "official_type_name": "APIActor | UserActor | UnauthenticatedUserActor | AnthropicActor | SystemActor | AdminAPIKeyActor | ServiceAccountActor | ScimDirectorySyncActor | FederatedIdentityActor | FederatedActor | AttestedDeviceActor",23384 "description": "Who performed the activity; discriminated union on actor.type.",23385 "fields": [23386 {23387 "name": "actor",23388 "type": "APIActor or UserActor or UnauthenticatedUserActor or 8 more",23389 "required": true,23390 "children": [23391 {23392 "variant": "APIActor object",23393 "fields": [23394 {23395 "name": "type",23396 "type": "\"api_actor\"",23397 "required": false,23398 "constraints": {23399 "default": "api_actor"23400 }23401 },23402 {23403 "name": "api_key_id",23404 "type": "string",23405 "required": true23406 },23407 {23408 "name": "ip_address",23409 "type": "string",23410 "required": true23411 },23412 {23413 "name": "user_agent",23414 "type": "string",23415 "required": true23416 }23417 ]23418 },23419 {23420 "variant": "UserActor object",23421 "fields": [23422 {23423 "name": "type",23424 "type": "\"user_actor\"",23425 "required": false,23426 "constraints": {23427 "default": "user_actor"23428 }23429 },23430 {23431 "name": "email_address",23432 "type": "string",23433 "required": true,23434 "constraints": {23435 "format": "email"23436 }23437 },23438 {23439 "name": "ip_address",23440 "type": "string",23441 "required": true23442 },23443 {23444 "name": "user_agent",23445 "type": "string",23446 "required": true23447 },23448 {23449 "name": "user_id",23450 "type": "string",23451 "required": true23452 }23453 ]23454 },23455 {23456 "variant": "UnauthenticatedUserActor object",23457 "fields": [23458 {23459 "name": "type",23460 "type": "\"unauthenticated_user_actor\"",23461 "required": false,23462 "constraints": {23463 "default": "unauthenticated_user_actor"23464 }23465 },23466 {23467 "name": "ip_address",23468 "type": "string",23469 "required": true23470 },23471 {23472 "name": "user_agent",23473 "type": "string",23474 "required": true23475 },23476 {23477 "name": "unauthenticated_email_address",23478 "type": "string or null",23479 "required": false,23480 "constraints": {23481 "format": "email"23482 }23483 }23484 ]23485 },23486 {23487 "variant": "AnthropicActor object",23488 "fields": [23489 {23490 "name": "type",23491 "type": "\"anthropic_actor\"",23492 "required": false,23493 "constraints": {23494 "default": "anthropic_actor"23495 }23496 },23497 {23498 "name": "email_address",23499 "type": "string or null",23500 "required": false,23501 "constraints": {23502 "format": "email"23503 }23504 }23505 ]23506 },23507 {23508 "variant": "SystemActor object",23509 "fields": [23510 {23511 "name": "type",23512 "type": "\"system_actor\"",23513 "required": false,23514 "constraints": {23515 "default": "system_actor"23516 }23517 },23518 {23519 "name": "service",23520 "type": "string or null",23521 "required": false,23522 "description": "Name of the automated process that performed the action, when known."23523 }23524 ]23525 },23526 {23527 "variant": "AdminAPIKeyActor object",23528 "fields": [23529 {23530 "name": "type",23531 "type": "\"admin_api_key_actor\"",23532 "required": false,23533 "constraints": {23534 "default": "admin_api_key_actor"23535 }23536 },23537 {23538 "name": "admin_api_key_id",23539 "type": "string",23540 "required": true23541 },23542 {23543 "name": "ip_address",23544 "type": "string",23545 "required": true23546 },23547 {23548 "name": "user_agent",23549 "type": "string",23550 "required": true23551 }23552 ]23553 },23554 {23555 "variant": "ServiceAccountActor object",23556 "fields": [23557 {23558 "name": "type",23559 "type": "\"service_account_actor\"",23560 "required": false,23561 "constraints": {23562 "default": "service_account_actor"23563 }23564 },23565 {23566 "name": "ip_address",23567 "type": "string",23568 "required": true23569 },23570 {23571 "name": "service_account_id",23572 "type": "string",23573 "required": true23574 },23575 {23576 "name": "user_agent",23577 "type": "string",23578 "required": true23579 }23580 ]23581 },23582 {23583 "variant": "ScimDirectorySyncActor object",23584 "fields": [23585 {23586 "name": "type",23587 "type": "\"scim_directory_sync_actor\"",23588 "required": false,23589 "constraints": {23590 "default": "scim_directory_sync_actor"23591 }23592 },23593 {23594 "name": "directory_id",23595 "type": "string",23596 "required": true23597 },23598 {23599 "name": "workos_event_id",23600 "type": "string",23601 "required": true23602 },23603 {23604 "name": "idp_connection_type",23605 "type": "string or null",23606 "required": false23607 }23608 ]23609 },23610 {23611 "variant": "FederatedIdentityActor object",23612 "fields": [23613 {23614 "name": "type",23615 "type": "\"federated_identity_actor\"",23616 "required": false,23617 "constraints": {23618 "default": "federated_identity_actor"23619 }23620 },23621 {23622 "name": "issuer",23623 "type": "string",23624 "required": true23625 },23626 {23627 "name": "subject",23628 "type": "string",23629 "required": true23630 },23631 {23632 "name": "audience",23633 "type": "array of string",23634 "required": false23635 },23636 {23637 "name": "ip_address",23638 "type": "string or null",23639 "required": false23640 },23641 {23642 "name": "user_agent",23643 "type": "string or null",23644 "required": false23645 }23646 ]23647 },23648 {23649 "variant": "FederatedActor object",23650 "fields": [23651 {23652 "name": "type",23653 "type": "\"federated_actor\"",23654 "required": false,23655 "constraints": {23656 "default": "federated_actor"23657 }23658 },23659 {23660 "name": "provider",23661 "type": "FederatedActorAwsProvider or FederatedActorAzureProvider or FederatedActorGcpProvider or FederatedActorOidcProvider",23662 "required": true,23663 "children": [23664 {23665 "variant": "FederatedActorAwsProvider object",23666 "fields": [23667 {23668 "name": "type",23669 "type": "\"aws\"",23670 "required": false,23671 "constraints": {23672 "default": "aws"23673 }23674 },23675 {23676 "name": "account_id",23677 "type": "string",23678 "required": true23679 },23680 {23681 "name": "signed_principal",23682 "type": "string",23683 "required": true,23684 "description": "The AWS-signed ARN of the IAM principal that requested the token."23685 }23686 ]23687 },23688 {23689 "variant": "FederatedActorAzureProvider object",23690 "fields": [23691 {23692 "name": "type",23693 "type": "\"azure\"",23694 "required": false,23695 "constraints": {23696 "default": "azure"23697 }23698 },23699 {23700 "name": "subscription_id",23701 "type": "string",23702 "required": true23703 }23704 ]23705 },23706 {23707 "variant": "FederatedActorGcpProvider object",23708 "fields": [23709 {23710 "name": "type",23711 "type": "\"gcp\"",23712 "required": false,23713 "constraints": {23714 "default": "gcp"23715 }23716 },23717 {23718 "name": "project_number",23719 "type": "string",23720 "required": true23721 }23722 ]23723 },23724 {23725 "variant": "FederatedActorOidcProvider object",23726 "fields": [23727 {23728 "name": "type",23729 "type": "\"oidc\"",23730 "required": false,23731 "constraints": {23732 "default": "oidc"23733 }23734 },23735 {23736 "name": "issuer",23737 "type": "string or null",23738 "required": false,23739 "description": "The federation issuer's URL. Null when the presented credential failed verification."23740 }23741 ]23742 }23743 ]23744 },23745 {23746 "name": "ip_address",23747 "type": "string or null",23748 "required": false23749 },23750 {23751 "name": "subject",23752 "type": "string or null",23753 "required": false,23754 "description": "The provider's verified identifier for the caller; its form depends on the provider."23755 },23756 {23757 "name": "user_agent",23758 "type": "string or null",23759 "required": false23760 }23761 ]23762 },23763 {23764 "variant": "AttestedDeviceActor object",23765 "fields": [23766 {23767 "name": "type",23768 "type": "\"attested_device_actor\"",23769 "required": false,23770 "constraints": {23771 "default": "attested_device_actor"23772 }23773 },23774 {23775 "name": "external_client_id",23776 "type": "string",23777 "required": true23778 },23779 {23780 "name": "kid_hash",23781 "type": "string",23782 "required": true23783 },23784 {23785 "name": "ip_address",23786 "type": "string or null",23787 "required": false23788 },23789 {23790 "name": "user_agent",23791 "type": "string or null",23792 "required": false23793 }23794 ]23795 }23796 ]23797 }23798 ],23799 "status": [23800 "DOCUMENTED",23801 "ACCOUNT_RESTRICTED"23802 ],23803 "sources": [23804 {23805 "url": "https://platform.claude.com/docs/en/api/compliance/activities/list",23806 "retrieved_at": "2026-09-18"23807 }23808 ]23809 },23810 {23811 "provider": "anthropic",23812 "api_family": "compliance",23813 "name": "ActivityListResponse",23814 "official_type_name": null,23815 "description": "Envelope: data[] Activity, has_more, first_id, last_id.",23816 "fields": [23817 {23818 "name": "data",23819 "type": "array of AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 503 more",23820 "required": false,23821 "description": "List of activity records. Each element's `type` field identifies which activity it is and which additional fields are present."23822 },23823 {23824 "name": "first_id",23825 "type": "string or null",23826 "required": false23827 },23828 {23829 "name": "has_more",23830 "type": "boolean",23831 "required": false,23832 "constraints": {23833 "default": "false"23834 }23835 },23836 {23837 "name": "last_id",23838 "type": "string or null",23839 "required": false23840 }23841 ],23842 "status": [23843 "DOCUMENTED",23844 "ACCOUNT_RESTRICTED"23845 ],23846 "sources": [23847 {23848 "url": "https://platform.claude.com/docs/en/api/compliance/activities/list",23849 "retrieved_at": "2026-09-18"23850 }23851 ]23852 },23853 {23854 "provider": "anthropic",23855 "api_family": "compliance",23856 "name": "ComplianceArtifactVersionMetadata",23857 "official_type_name": "object",23858 "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.",23859 "fields": [23860 {23861 "name": "id",23862 "type": "string",23863 "required": true,23864 "description": "Artifact ID e.g. 'claude_artifact_abc123'"23865 },23866 {23867 "name": "artifact_type",23868 "type": "string or null",23869 "required": true,23870 "description": "MIME-like artifact type e.g. 'application/vnd.ant.code'"23871 },23872 {23873 "name": "claude_chat_id",23874 "type": "string",23875 "required": true,23876 "description": "The chat this artifact belongs to"23877 },23878 {23879 "name": "created_at",23880 "type": "string",23881 "required": true,23882 "description": "Artifact version creation timestamp",23883 "constraints": {23884 "format": "date-time"23885 }23886 },23887 {23888 "name": "md5",23889 "type": "string",23890 "required": true,23891 "description": "Lowercase hex MD5 of the artifact content (UTF-8 encoded). Matches the `content` field returned by the sibling `/content` endpoint."23892 },23893 {23894 "name": "size_bytes",23895 "type": "number",23896 "required": true,23897 "description": "Size in bytes of the artifact content (UTF-8 encoded)"23898 },23899 {23900 "name": "title",23901 "type": "string or null",23902 "required": true,23903 "description": "Artifact title"23904 },23905 {23906 "name": "version_id",23907 "type": "string",23908 "required": true,23909 "description": "Artifact version ID e.g. 'claude_artifact_version_abc123'"23910 }23911 ],23912 "status": [23913 "DOCUMENTED",23914 "ACCOUNT_RESTRICTED"23915 ],23916 "sources": [23917 {23918 "url": "https://platform.claude.com/docs/en/api/compliance/apps/artifacts/retrieve",23919 "retrieved_at": "2026-09-18"23920 }23921 ]23922 },23923 {23924 "provider": "anthropic",23925 "api_family": "compliance",23926 "name": "ComplianceChat",23927 "official_type_name": "chat list item",23928 "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`",23929 "fields": [23930 {23931 "name": "id",23932 "type": "string",23933 "required": true,23934 "description": "Chat ID"23935 },23936 {23937 "name": "created_at",23938 "type": "string",23939 "required": true,23940 "description": "Creation timestamp",23941 "constraints": {23942 "format": "date-time"23943 }23944 },23945 {23946 "name": "deleted_at",23947 "type": "string or null",23948 "required": true,23949 "description": "Deletion timestamp if deleted",23950 "constraints": {23951 "format": "date-time"23952 }23953 },23954 {23955 "name": "href",23956 "type": "string",23957 "required": true,23958 "description": "URL to view this chat in claude.ai"23959 },23960 {23961 "name": "model",23962 "type": "string or null",23963 "required": true,23964 "description": "Model selected for this chat (e.g. 'claude-opus-5'). May be null for legacy chats that never had a model recorded."23965 },23966 {23967 "name": "name",23968 "type": "string",23969 "required": true,23970 "description": "Chat name/title"23971 },23972 {23973 "name": "organization_uuid",23974 "type": "string",23975 "required": true,23976 "description": "Organization UUID this chat belongs to"23977 },23978 {23979 "name": "project_id",23980 "type": "string or null",23981 "required": true,23982 "description": "Project ID this chat belongs to"23983 },23984 {23985 "name": "updated_at",23986 "type": "string",23987 "required": true,23988 "description": "Last update timestamp",23989 "constraints": {23990 "format": "date-time"23991 }23992 },23993 {23994 "name": "user",23995 "type": "object or null",23996 "required": true,23997 "description": "The user who created the chat. Null when the API key is restricted to one organization and the creator is no longer a member of it (for example, after they were removed from it). A key for the whole parent organization returns the creator's `id` and current `email_address` for every chat; on the lis",23998 "children": [23999 {24000 "name": "id",24001 "type": "string",24002 "required": true,24003 "description": "User identifier"24004 },24005 {24006 "name": "email_address",24007 "type": "string",24008 "required": true,24009 "description": "User's email address"24010 }24011 ]24012 },24013 {24014 "name": "organization_id",24015 "type": "string",24016 "required": true,24017 "description": "**Deprecated** Organization ID this chat belongs to"24018 }24019 ],24020 "status": [24021 "DOCUMENTED",24022 "ACCOUNT_RESTRICTED"24023 ],24024 "sources": [24025 {24026 "url": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",24027 "retrieved_at": "2026-09-18"24028 }24029 ]24030 },24031 {24032 "provider": "anthropic",24033 "api_family": "compliance",24034 "name": "ComplianceChatMessages",24035 "official_type_name": "chat with chat_messages[]",24036 "description": "Retrieves message history and file metadata for a specific chat.",24037 "fields": [24038 {24039 "name": "id",24040 "type": "string",24041 "required": true,24042 "description": "Chat ID"24043 },24044 {24045 "name": "chat_messages",24046 "type": "array of object",24047 "required": true,24048 "description": "Array of chat messages in order of created_at",24049 "children": [24050 {24051 "name": "id",24052 "type": "string",24053 "required": true,24054 "description": "Unique identifier for the message e.g. 'claude_chat_msg_abcd1234'"24055 },24056 {24057 "name": "artifacts",24058 "type": "array of object or null",24059 "required": true,24060 "description": "Versioned documents generated or updated by the assistant in this message. Download via `GET /v1/compliance/apps/artifacts/{artifact_version_id}/content`.",24061 "children": [24062 {24063 "name": "id",24064 "type": "string",24065 "required": true,24066 "description": "Artifact ID e.g. 'claude_artifact_abc123'"24067 },24068 {24069 "name": "artifact_type",24070 "type": "string or null",24071 "required": true,24072 "description": "MIME-like artifact type e.g. 'application/vnd.ant.code'"24073 },24074 {24075 "name": "title",24076 "type": "string or null",24077 "required": true,24078 "description": "Artifact title"24079 },24080 {24081 "name": "version_id",24082 "type": "string",24083 "required": true,24084 "description": "Artifact version ID e.g. 'claude_artifact_version_abc123'"24085 }24086 ]24087 },24088 {24089 "name": "content",24090 "type": "array of Text or ToolUse or ToolResult",24091 "required": true,24092 "description": "Content blocks within the message",24093 "children": [24094 {24095 "variant": "Text object",24096 "fields": [24097 {24098 "name": "type",24099 "type": "\"text\"",24100 "required": true,24101 "constraints": {24102 "default": "text"24103 }24104 },24105 {24106 "name": "text",24107 "type": "string",24108 "required": true,24109 "description": "Text content from human or assistant"24110 },24111 {24112 "name": "thinking_redacted",24113 "type": "boolean",24114 "required": true,24115 "description": "True when content enclosed in the assistant's internal-reasoning tags (or the tag markup itself) was removed from `text` during export. Removal never occurs with this field false. Always false on human messages, whose text is exported verbatim.",24116 "constraints": {24117 "default": "false"24118 }24119 },24120 {24121 "name": "truncated",24122 "type": "boolean",24123 "required": true,24124 "description": "True when `text` was shortened by the server's fixed per-string bound (1 MiB). Always false on chat text blocks.",24125 "constraints": {24126 "default": "false"24127 }24128 }24129 ]24130 },24131 {24132 "variant": "ToolUse object",24133 "fields": [24134 {24135 "name": "type",24136 "type": "\"tool_use\"",24137 "required": true,24138 "constraints": {24139 "default": "tool_use"24140 }24141 },24142 {24143 "name": "id",24144 "type": "string or null",24145 "required": true,24146 "description": "Tool-use ID, e.g. 'toolu_01AbC...'"24147 },24148 {24149 "name": "input",24150 "type": "string",24151 "required": true,24152 "description": "Arguments passed to the tool, as a JSON-encoded string. May be shortened — see the `truncated` field"24153 },24154 {24155 "name": "integration_name",24156 "type": "string or null",24157 "required": true,24158 "description": "Name of the integration that provides this tool, when applicable"24159 },24160 {24161 "name": "mcp_server_url",24162 "type": "string or null",24163 "required": true,24164 "description": "Base URL (scheme, host, and path only) of the MCP server that provides this tool, when applicable"24165 },24166 {24167 "name": "name",24168 "type": "string",24169 "required": true,24170 "description": "Name of the tool invoked"24171 },24172 {24173 "name": "truncated",24174 "type": "boolean",24175 "required": true,24176 "description": "True when `input` was shortened. Pass the endpoint's tool-use input max parameter as -1 to request full content, subject to any server-side maximum the endpoint enforces.",24177 "constraints": {24178 "default": "false"24179 }24180 }24181 ]24182 },24183 {24184 "variant": "ToolResult object",24185 "fields": [24186 {24187 "name": "type",24188 "type": "\"tool_result\"",24189 "required": true,24190 "constraints": {24191 "default": "tool_result"24192 }24193 },24194 {24195 "name": "content",24196 "type": "array of object",24197 "required": true,24198 "description": "Text content returned by the tool. Generated files are surfaced via the message's `generated_files` list; other non-text item types (including images and links) are omitted."24199 },24200 {24201 "name": "integration_name",24202 "type": "string or null",24203 "required": true,24204 "description": "Name of the integration that provides this tool, when applicable"24205 },24206 {24207 "name": "is_error",24208 "type": "boolean",24209 "required": true,24210 "description": "True when the tool reported an error"24211 },24212 {24213 "name": "mcp_server_url",24214 "type": "string or null",24215 "required": true,24216 "description": "Base URL (scheme, host, and path only) of the MCP server that provides this tool, when applicable"24217 },24218 {24219 "name": "name",24220 "type": "string",24221 "required": true,24222 "description": "Name of the tool that produced this result"24223 },24224 {24225 "name": "tool_use_id",24226 "type": "string or null",24227 "required": true,24228 "description": "ID of the tool_use block this result responds to"24229 },24230 {24231 "name": "truncated",24232 "type": "boolean",24233 "required": true,24234 "description": "True when one or more text items in `content` were shortened. Pass the endpoint's tool-result max parameter as -1 to request full content, subject to any server-side maximum the endpoint enforces.",24235 "constraints": {24236 "default": "false"24237 }24238 }24239 ]24240 }24241 ]24242 },24243 {24244 "name": "created_at",24245 "type": "string",24246 "required": true,24247 "description": "Message creation timestamp - For human: when they sent the message, For assistant: when it completed the last content block",24248 "constraints": {24249 "format": "date-time"24250 }24251 },24252 {24253 "name": "files",24254 "type": "array of object or null",24255 "required": true,24256 "description": "Binary file attachments uploaded by the user. Download via `GET /v1/compliance/apps/chats/files/{claude_file_id}/content`.",24257 "children": [24258 {24259 "name": "id",24260 "type": "string",24261 "required": true,24262 "description": "File ID"24263 },24264 {24265 "name": "created_at",24266 "type": "string",24267 "required": true,24268 "description": "File creation timestamp",24269 "constraints": {24270 "format": "date-time"24271 }24272 },24273 {24274 "name": "filename",24275 "type": "string",24276 "required": true,24277 "description": "Display name of the file"24278 },24279 {24280 "name": "md5",24281 "type": "string or null",24282 "required": true,24283 "description": "Lowercase hex MD5 of the file's preferred downloadable variant, as recorded at upload time. Null when no stored hash is available."24284 },24285 {24286 "name": "mime_type",24287 "type": "string or null",24288 "required": true,24289 "description": "MIME type of the file's preferred downloadable variant (e.g. 'application/pdf')"24290 },24291 {24292 "name": "size_bytes",24293 "type": "number or null",24294 "required": true,24295 "description": "Size in bytes of the file's preferred downloadable variant, if known. Null for older files uploaded before size was recorded."24296 }24297 ]24298 },24299 {24300 "name": "generated_files",24301 "type": "array of object or null",24302 "required": true,24303 "description": "Downloadable files the assistant created via tool use (e.g. PDF, spreadsheet, slide deck). Distinct from `files`, which are uploads attached to the message. Download via `GET /v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content`.",24304 "children": [24305 {24306 "name": "id",24307 "type": "string",24308 "required": true,24309 "description": "Opaque generated-file id, e.g. 'claude_gen_file_abc123'. Treat as an opaque string; the encoding may change without notice."24310 },24311 {24312 "name": "filename",24313 "type": "string",24314 "required": true,24315 "description": "Display name of the generated file"24316 },24317 {24318 "name": "md5",24319 "type": "string or null",24320 "required": true,24321 "description": "Lowercase hex MD5 of the generated file, when available. Null when no stored hash is available."24322 },24323 {24324 "name": "mime_type",24325 "type": "string or null",24326 "required": true,24327 "description": "MIME type reported by the tool that produced the file"24328 },24329 {24330 "name": "size_bytes",24331 "type": "number or null",24332 "required": true,24333 "description": "Size in bytes of the generated file, when available. Null when the file has expired or size is not recorded."24334 }24335 ]24336 },24337 {24338 "name": "role",24339 "type": "\"assistant\" or \"user\"",24340 "required": true,24341 "description": "Message sender (user or assistant)",24342 "enum": [24343 "assistant",24344 "user"24345 ]24346 }24347 ]24348 },24349 {24350 "name": "created_at",24351 "type": "string",24352 "required": true,24353 "description": "Creation timestamp",24354 "constraints": {24355 "format": "date-time"24356 }24357 },24358 {24359 "name": "deleted_at",24360 "type": "string or null",24361 "required": true,24362 "description": "Deletion timestamp if deleted",24363 "constraints": {24364 "format": "date-time"24365 }24366 },24367 {24368 "name": "first_id",24369 "type": "string or null",24370 "required": true,24371 "description": "Opaque pagination cursor for the first message in the current result set. Pass as `before_id` on the next request to page backwards. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice."24372 },24373 {24374 "name": "has_more",24375 "type": "boolean",24376 "required": true,24377 "description": "Whether more chat messages exist beyond the current result set. Use `last_id` as `after_id` in a follow-up request to page forward.",24378 "constraints": {24379 "default": "false"24380 }24381 },24382 {24383 "name": "href",24384 "type": "string",24385 "required": true,24386 "description": "URL to view this chat in claude.ai"24387 },24388 {24389 "name": "last_id",24390 "type": "string or null",24391 "required": true,24392 "description": "Opaque pagination cursor for the last message in the current result set. Pass as `after_id` on the next request to page forwards. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice."24393 },24394 {24395 "name": "model",24396 "type": "string or null",24397 "required": true,24398 "description": "Model selected for this chat (e.g. 'claude-opus-5'). May be null for legacy chats that never had a model recorded."24399 },24400 {24401 "name": "name",24402 "type": "string",24403 "required": true,24404 "description": "Chat name"24405 },24406 {24407 "name": "organization_uuid",24408 "type": "string",24409 "required": true,24410 "description": "Organization UUID this chat belongs to"24411 },24412 {24413 "name": "project_id",24414 "type": "string or null",24415 "required": true,24416 "description": "Project ID this chat belongs to"24417 },24418 {24419 "name": "updated_at",24420 "type": "string",24421 "required": true,24422 "description": "Last update timestamp",24423 "constraints": {24424 "format": "date-time"24425 }24426 },24427 {24428 "name": "user",24429 "type": "object or null",24430 "required": true,24431 "description": "The user who created the chat. Null when the API key is restricted to one organization and the creator is no longer a member of it (for example, after they were removed from it). A key for the whole parent organization returns the creator's `id` and current `email_address` for every chat; on the lis",24432 "children": [24433 {24434 "name": "id",24435 "type": "string",24436 "required": true,24437 "description": "User identifier"24438 },24439 {24440 "name": "email_address",24441 "type": "string",24442 "required": true,24443 "description": "User's email address"24444 }24445 ]24446 },24447 {24448 "name": "organization_id",24449 "type": "string",24450 "required": true,24451 "description": "**Deprecated** Organization ID this chat belongs to"24452 }24453 ],24454 "status": [24455 "DOCUMENTED",24456 "ACCOUNT_RESTRICTED"24457 ],24458 "sources": [24459 {24460 "url": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",24461 "retrieved_at": "2026-09-18"24462 }24463 ]24464 },24465 {24466 "provider": "anthropic",24467 "api_family": "compliance",24468 "name": "ComplianceProjectAttachment",24469 "official_type_name": "ComplianceProjectFileReference | ComplianceProjectDocReference",24470 "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.",24471 "fields": [],24472 "status": [24473 "DOCUMENTED",24474 "ACCOUNT_RESTRICTED"24475 ],24476 "sources": [24477 {24478 "url": "https://platform.claude.com/docs/en/api/compliance/apps/projects/attachments/list",24479 "retrieved_at": "2026-09-18"24480 }24481 ],24482 "union_variants": [24483 {24484 "variant": "ComplianceProjectFileReference object",24485 "fields": [24486 {24487 "name": "type",24488 "type": "\"project_file\"",24489 "required": true,24490 "description": "Discriminator marking this as a binary file",24491 "constraints": {24492 "default": "project_file"24493 }24494 },24495 {24496 "name": "id",24497 "type": "string",24498 "required": true,24499 "description": "File identifier (e.g., 'claude_file_abcd')"24500 },24501 {24502 "name": "created_at",24503 "type": "string",24504 "required": true,24505 "description": "Creation timestamp (RFC 3339 format)",24506 "constraints": {24507 "format": "date-time"24508 }24509 },24510 {24511 "name": "filename",24512 "type": "string",24513 "required": true,24514 "description": "Display name of the file (e.g., 'document.pdf')"24515 },24516 {24517 "name": "md5",24518 "type": "string or null",24519 "required": true,24520 "description": "Lowercase hex MD5 of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file `/metadata` endpoint for the authoritative value."24521 },24522 {24523 "name": "mime_type",24524 "type": "string",24525 "required": true,24526 "description": "MIME type of the file's preferred downloadable variant when one is recorded, else 'application/octet-stream'. Use the per-file `/metadata` endpoint for the authoritative value."24527 },24528 {24529 "name": "size_bytes",24530 "type": "number or null",24531 "required": true,24532 "description": "Size in bytes of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file `/metadata` endpoint for the authoritative value."24533 }24534 ]24535 },24536 {24537 "variant": "ComplianceProjectDocReference object",24538 "fields": [24539 {24540 "name": "type",24541 "type": "\"project_doc\"",24542 "required": true,24543 "description": "Discriminator marking this as a plain text document",24544 "constraints": {24545 "default": "project_doc"24546 }24547 },24548 {24549 "name": "id",24550 "type": "string",24551 "required": true,24552 "description": "Project document identifier (e.g., 'claude_proj_doc_abcd')"24553 },24554 {24555 "name": "created_at",24556 "type": "string",24557 "required": true,24558 "description": "Creation timestamp (RFC 3339 format)",24559 "constraints": {24560 "format": "date-time"24561 }24562 },24563 {24564 "name": "filename",24565 "type": "string",24566 "required": true,24567 "description": "Display name of the document (e.g., 'document.txt')"24568 },24569 {24570 "name": "mime_type",24571 "type": "\"text/plain\"",24572 "required": true,24573 "description": "MIME type of the project document, always set to plain text",24574 "constraints": {24575 "default": "text/plain"24576 }24577 },24578 {24579 "name": "updated_at",24580 "type": "string or null",24581 "required": true,24582 "description": "Last-modified timestamp of the document. Reserved for future use — currently always null.",24583 "constraints": {24584 "format": "date-time"24585 }24586 }24587 ]24588 }24589 ]24590 },24591 {24592 "provider": "anthropic",24593 "api_family": "compliance",24594 "name": "ComplianceProjectCollaborator",24595 "official_type_name": "ComplianceProjectUserCollaborator | ComplianceProjectGroupCollaborator | ComplianceProjectOrganizationCollaborator | ComplianceProjectOrganizationRoleCollaborator",24596 "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.",24597 "fields": [],24598 "status": [24599 "DOCUMENTED",24600 "ACCOUNT_RESTRICTED"24601 ],24602 "sources": [24603 {24604 "url": "https://platform.claude.com/docs/en/api/compliance/apps/projects/collaborators/list",24605 "retrieved_at": "2026-09-18"24606 }24607 ],24608 "union_variants": [24609 {24610 "variant": "ComplianceProjectUserCollaborator object",24611 "fields": [24612 {24613 "name": "type",24614 "type": "\"user\"",24615 "required": true,24616 "description": "Discriminator marking this as an individual user collaborator",24617 "constraints": {24618 "default": "user"24619 }24620 },24621 {24622 "name": "granted_at",24623 "type": "string",24624 "required": true,24625 "description": "When this collaborator was granted access (RFC 3339 format)",24626 "constraints": {24627 "format": "date-time"24628 }24629 },24630 {24631 "name": "role",24632 "type": "\"admin\" or \"editor\" or \"owner\" or \"viewer\"",24633 "required": true,24634 "description": "Role granted on the project",24635 "enum": [24636 "admin",24637 "editor",24638 "owner",24639 "viewer"24640 ]24641 },24642 {24643 "name": "user_id",24644 "type": "string or null",24645 "required": true,24646 "description": "Identifier of the user granted access (tagged ID), or null if their account has since been deleted"24647 }24648 ]24649 },24650 {24651 "variant": "ComplianceProjectGroupCollaborator object",24652 "fields": [24653 {24654 "name": "type",24655 "type": "\"group\"",24656 "required": true,24657 "description": "Discriminator marking this as a group collaborator",24658 "constraints": {24659 "default": "group"24660 }24661 },24662 {24663 "name": "granted_at",24664 "type": "string",24665 "required": true,24666 "description": "When this collaborator was granted access (RFC 3339 format)",24667 "constraints": {24668 "format": "date-time"24669 }24670 },24671 {24672 "name": "group_id",24673 "type": "string",24674 "required": true,24675 "description": "Identifier of the group granted access (tagged ID)"24676 },24677 {24678 "name": "role",24679 "type": "\"admin\" or \"editor\" or \"owner\" or \"viewer\"",24680 "required": true,24681 "description": "Role granted on the project",24682 "enum": [24683 "admin",24684 "editor",24685 "owner",24686 "viewer"24687 ]24688 }24689 ]24690 },24691 {24692 "variant": "ComplianceProjectOrganizationCollaborator object",24693 "fields": [24694 {24695 "name": "type",24696 "type": "\"organization\"",24697 "required": true,24698 "description": "Discriminator marking this as an organization-wide grant",24699 "constraints": {24700 "default": "organization"24701 }24702 },24703 {24704 "name": "granted_at",24705 "type": "string",24706 "required": true,24707 "description": "When this collaborator was granted access (RFC 3339 format)",24708 "constraints": {24709 "format": "date-time"24710 }24711 },24712 {24713 "name": "organization_uuid",24714 "type": "string",24715 "required": true,24716 "description": "UUID of the organization granted access"24717 },24718 {24719 "name": "role",24720 "type": "\"admin\" or \"editor\" or \"owner\" or \"viewer\"",24721 "required": true,24722 "description": "Role granted on the project",24723 "enum": [24724 "admin",24725 "editor",24726 "owner",24727 "viewer"24728 ]24729 }24730 ]24731 },24732 {24733 "variant": "ComplianceProjectOrganizationRoleCollaborator object",24734 "fields": [24735 {24736 "name": "type",24737 "type": "\"organization_role\"",24738 "required": true,24739 "description": "Discriminator marking this as a grant to all organization members holding a specific org-level role",24740 "constraints": {24741 "default": "organization_role"24742 }24743 },24744 {24745 "name": "granted_at",24746 "type": "string",24747 "required": true,24748 "description": "When this collaborator was granted access (RFC 3339 format)",24749 "constraints": {24750 "format": "date-time"24751 }24752 },24753 {24754 "name": "organization_role",24755 "type": "string",24756 "required": true,24757 "description": "The organization-level role whose holders are granted access"24758 },24759 {24760 "name": "role",24761 "type": "\"admin\" or \"editor\" or \"owner\" or \"viewer\"",24762 "required": true,24763 "description": "Role granted on the project",24764 "enum": [24765 "admin",24766 "editor",24767 "owner",24768 "viewer"24769 ]24770 }24771 ]24772 }24773 ]24774 },24775 {24776 "provider": "anthropic",24777 "api_family": "compliance",24778 "name": "ComplianceLocalSession",24779 "official_type_name": "compliance_local_session",24780 "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.",24781 "fields": [24782 {24783 "name": "type",24784 "type": "\"compliance_local_session\"",24785 "required": true,24786 "constraints": {24787 "default": "compliance_local_session"24788 }24789 },24790 {24791 "name": "id",24792 "type": "string",24793 "required": true,24794 "description": "Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice."24795 },24796 {24797 "name": "created_at",24798 "type": "string",24799 "required": true,24800 "description": "Timestamp of the session's first retained inference call (RFC 3339, UTC). When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected, so this value is the timestamp of the earliest retained call: always strictly after the bounda",24801 "constraints": {24802 "format": "date-time"24803 }24804 },24805 {24806 "name": "organization_uuid",24807 "type": "string",24808 "required": true,24809 "description": "UUID of the child organization the session belongs to"24810 },24811 {24812 "name": "product_surface",24813 "type": "string or null",24814 "required": true,24815 "description": "The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app;"24816 },24817 {24818 "name": "truncated",24819 "type": "boolean",24820 "required": true,24821 "description": "True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the l",24822 "constraints": {24823 "default": "false"24824 }24825 },24826 {24827 "name": "updated_at",24828 "type": "string",24829 "required": true,24830 "description": "Timestamp of the session's last retained inference call (RFC 3339, UTC). Always at or after `created_at`. When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected — but because retention removes only the oldest calls, this val",24831 "constraints": {24832 "format": "date-time"24833 }24834 },24835 {24836 "name": "user",24837 "type": "object",24838 "required": true,24839 "description": "The authenticated user at the time of the session. Always set; `user.id` is always populated. `user.email_address` is null when the user's account has been deleted or the user is no longer a member of an organization the key may read.",24840 "children": [24841 {24842 "name": "id",24843 "type": "string",24844 "required": true,24845 "description": "User identifier (tagged ID, prefixed `user_`). Always set, so attribution survives after the user's account is deleted or the user leaves the organizations the key may read."24846 },24847 {24848 "name": "email_address",24849 "type": "string or null",24850 "required": true,24851 "description": "User's email address. Null when the user's account has been deleted or the user is no longer a member of an organization the key may read. The messages endpoint does not resolve email addresses; this field is always null there."24852 }24853 ]24854 },24855 {24856 "name": "workspace_id",24857 "type": "string or null",24858 "required": true,24859 "description": "Workspace identifier (tagged ID, prefixed `wrkspc_`). Null for sessions not attributed to a workspace."24860 }24861 ],24862 "status": [24863 "DOCUMENTED",24864 "ACCOUNT_RESTRICTED"24865 ],24866 "sources": [24867 {24868 "url": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/list",24869 "retrieved_at": "2026-09-18"24870 }24871 ]24872 },24873 {24874 "provider": "anthropic",24875 "api_family": "compliance",24876 "name": "EffectiveOrganizationSettings",24877 "official_type_name": "effective_organization_settings",24878 "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 f",24879 "fields": [24880 {24881 "name": "type",24882 "type": "\"effective_organization_settings\"",24883 "required": false,24884 "constraints": {24885 "default": "effective_organization_settings"24886 }24887 },24888 {24889 "name": "api_keys",24890 "type": "array of object",24891 "required": true,24892 "description": "Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.",24893 "children": [24894 {24895 "name": "type",24896 "type": "\"compliance_api_key\"",24897 "required": false,24898 "constraints": {24899 "default": "compliance_api_key"24900 }24901 },24902 {24903 "name": "id",24904 "type": "string",24905 "required": true,24906 "description": "Unique identifier for the API key."24907 },24908 {24909 "name": "created_at",24910 "type": "string",24911 "required": true,24912 "description": "When the key was created.",24913 "constraints": {24914 "format": "date-time"24915 }24916 },24917 {24918 "name": "created_by_id",24919 "type": "string or null",24920 "required": true,24921 "description": "Identifier of the user who created the key, or null when the key was created by automation or its creator's account no longer exists."24922 },24923 {24924 "name": "is_active",24925 "type": "boolean",24926 "required": true,24927 "description": "Whether the key is currently active. A deactivated key is listed for audit visibility but cannot authenticate requests."24928 },24929 {24930 "name": "name",24931 "type": "string",24932 "required": true,24933 "description": "The name given to the API key when it was created."24934 },24935 {24936 "name": "scopes",24937 "type": "array of string",24938 "required": true,24939 "description": "The permission scopes granted to the key."24940 },24941 {24942 "name": "expires_at",24943 "type": "string or null",24944 "required": false,24945 "description": "When the key will stop authenticating, or null when the key does not expire.",24946 "constraints": {24947 "format": "date-time"24948 }24949 }24950 ]24951 },24952 {24953 "name": "organization_id",24954 "type": "string",24955 "required": true24956 },24957 {24958 "name": "settings",24959 "type": "array of Boolean or Integer or String or 3 more",24960 "required": true,24961 "children": [24962 {24963 "variant": "Boolean object",24964 "fields": [24965 {24966 "name": "type",24967 "type": "\"boolean\"",24968 "required": false,24969 "constraints": {24970 "default": "boolean"24971 }24972 },24973 {24974 "name": "name",24975 "type": "\"access_transparency_enabled\" or \"ai_powered_artifacts_enabled\" or \"api_workbench_feedback_collection_enabled\" or 57 more",24976 "required": true,24977 "enum": [24978 "access_transparency_enabled",24979 "ai_powered_artifacts_enabled",24980 "api_workbench_feedback_collection_enabled",24981 "api_zero_data_retention_enabled",24982 "artifact_connectors_enabled",24983 "ask_your_org_enabled",24984 "chat_enabled",24985 "claude_ai_chat_sharing_enabled",24986 "claude_ai_feedback_collection_enabled",24987 "claude_ai_integration_sharing_enabled",24988 "claude_ai_skill_plugins_scanning_enabled",24989 "claude_code_desktop_bypass_permissions_enabled",24990 "claude_code_desktop_enabled",24991 "claude_code_fast_mode_enabled",24992 "claude_code_metrics_logging_enabled",24993 "claude_code_remote_control_enabled",24994 "claude_code_review_enabled",24995 "claude_code_routines_enabled",24996 "claude_code_security_enabled",24997 "claude_code_trusted_devices_required",24998 "claude_code_web_enabled",24999 "claude_code_workflows_enabled",25000 "claude_design_enabled",25001 "claude_enterprise_claude_code_zero_data_retention_enabled",25002 "claude_in_slack_enabled",25003 "claude_science_custom_connectors_enabled",25004 "claude_science_custom_skills_enabled",25005 "claude_science_enabled",25006 "claude_science_managed_network_allowlist_enabled",25007 "claude_science_memory_enabled",25008 "claude_science_modal_enabled",25009 "claude_science_scientific_model_endpoints_enabled",25010 "claude_science_ssh_hosts_enabled",25011 "cmek_enabled",25012 "code_execution_enabled",25013 "code_execution_network_egress_enabled",25014 "connector_tools_default_always_allow",25015 "content_redaction_enabled",25016 "cowork_trusted_devices_required",25017 "desktop_extension_allowlist_enabled",25018 "… 60 total"25019 ]25020 },25021 {25022 "name": "value",25023 "type": "boolean",25024 "required": true25025 }25026 ]25027 },25028 {25029 "variant": "Integer object",25030 "fields": [25031 {25032 "name": "type",25033 "type": "\"integer\"",25034 "required": false,25035 "constraints": {25036 "default": "integer"25037 }25038 },25039 {25040 "name": "name",25041 "type": "\"account_session_duration_seconds\"",25042 "required": true25043 },25044 {25045 "name": "value",25046 "type": "number or null",25047 "required": true25048 }25049 ]25050 },25051 {25052 "variant": "String object",25053 "fields": [25054 {25055 "name": "type",25056 "type": "\"string\"",25057 "required": false,25058 "constraints": {25059 "default": "string"25060 }25061 },25062 {25063 "name": "name",25064 "type": "\"claude_code_default_worker_environment_id\" or \"claude_code_default_worker_pool_id\"",25065 "required": true,25066 "enum": [25067 "claude_code_default_worker_environment_id",25068 "claude_code_default_worker_pool_id"25069 ]25070 },25071 {25072 "name": "value",25073 "type": "string or null",25074 "required": true25075 }25076 ]25077 },25078 {25079 "variant": "StringList object",25080 "fields": [25081 {25082 "name": "type",25083 "type": "\"string_list\"",25084 "required": false,25085 "constraints": {25086 "default": "string_list"25087 }25088 },25089 {25090 "name": "name",25091 "type": "\"allowed_invite_domains\" or \"disabled_admin_request_types\" or \"ip_allowlist_ip_ranges\"",25092 "required": true,25093 "enum": [25094 "allowed_invite_domains",25095 "disabled_admin_request_types",25096 "ip_allowlist_ip_ranges"25097 ]25098 },25099 {25100 "name": "value",25101 "type": "array of string",25102 "required": true25103 }25104 ]25105 },25106 {25107 "variant": "ProvisioningMode object",25108 "fields": [25109 {25110 "name": "type",25111 "type": "\"provisioning_mode\"",25112 "required": false,25113 "constraints": {25114 "default": "provisioning_mode"25115 }25116 },25117 {25118 "name": "value",25119 "type": "\"jit_advanced\" or \"jit_permissive\" or \"login_only\" or 2 more",25120 "required": true,25121 "description": "How organization members are provisioned under SSO.",25122 "enum": [25123 "jit_advanced",25124 "jit_permissive",25125 "login_only",25126 "scim_advanced",25127 "scim_permissive"25128 ]25129 },25130 {25131 "name": "name",25132 "type": "\"sso_provisioning_mode\"",25133 "required": false,25134 "constraints": {25135 "default": "sso_provisioning_mode"25136 }25137 }25138 ]25139 },25140 {25141 "variant": "DataRetention object",25142 "fields": [25143 {25144 "name": "type",25145 "type": "\"data_retention\"",25146 "required": false,25147 "constraints": {25148 "default": "data_retention"25149 }25150 },25151 {25152 "name": "value",25153 "type": "map[Fixed or Indefinite]",25154 "required": true,25155 "children": [25156 {25157 "variant": "Fixed object",25158 "fields": [25159 {25160 "name": "type",25161 "type": "\"fixed\"",25162 "required": false,25163 "constraints": {25164 "default": "fixed"25165 }25166 },25167 {25168 "name": "duration",25169 "type": "number",25170 "required": true25171 },25172 {25173 "name": "timescale",25174 "type": "\"day\" or \"month\"",25175 "required": true,25176 "enum": [25177 "day",25178 "month"25179 ]25180 }25181 ]25182 },25183 {25184 "variant": "Indefinite object",25185 "fields": [25186 {25187 "name": "type",25188 "type": "\"indefinite\"",25189 "required": false,25190 "constraints": {25191 "default": "indefinite"25192 }25193 }25194 ]25195 }25196 ]25197 },25198 {25199 "name": "name",25200 "type": "\"data_retention_periods\"",25201 "required": false,25202 "constraints": {25203 "default": "data_retention_periods"25204 }25205 }25206 ]25207 }25208 ]25209 }25210 ],25211 "status": [25212 "DOCUMENTED",25213 "ACCOUNT_RESTRICTED"25214 ],25215 "sources": [25216 {25217 "url": "https://platform.claude.com/docs/en/api/compliance/organizations/settings/retrieve",25218 "retrieved_at": "2026-09-18"25219 }25220 ]25221 }25222]