Sessions
api/beta/sessions
History
api/beta/sessions Changed · +288 / -22 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"`
- `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `agent: string or BetaManagedAgentsAgentParams or BetaManagedAgentsAgentWithOverridesParams`
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"`
- `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: optional array of BetaManagedAgentsSession`
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"`
- `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSession object`
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"`
- `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `agent: optional BetaManagedAgentsSessionAgentUpdate`
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"`
- `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsDeletedSession object`
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"`
- `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsSession object`
Model identifier and configuration. - - `name: string` - - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - - - `BetaManagedAgentsAnthropicSkill object` - - A resolved Anthropic-managed skill. - - - `skill_id: string` - - - `type: "anthropic"` - - - `version: string` - - - `BetaManagedAgentsCustomSkill object` - - A resolved user-created custom skill. - - - `skill_id: string` - - - `type: "custom"` - - - `version: string` - - - `system: string or null` - - - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - - - `BetaManagedAgentsAgentToolset20260401 object` - - - `configs: array of BetaManagedAgentsAgentToolConfig` - - - `BetaManagedAgentsBashToolConfig object` - - Configuration for the bash tool. - - - `enabled: boolean` - - - `name: "bash"` - - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - Permission policy for tool execution. - - - `BetaManagedAgentsAlwaysAllowPolicy object` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `type: "bash"
api/beta/sessions Changed · +5698 / -19015 lines
### Headers ### Body parameters #### Response (200) ### Query parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ### Path parameters ### Headers ### Body parameters #### Response (200) ### Path parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ## Domain types ## Sessions › Events ### List Events #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ### Send Events #### Path parameters #### Headers #### Body parameters #### Returns #### Example ##### Response (200) ### Stream Events #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ## Sessions › Resources ### Add Session Resource #### Path parameters #### Headers #### Body parameters #### Returns #### Example ##### Response (200) ### List Session Resources #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ### Get Session Resource #### Path parameters #### Headers #### Returns #### Example ##### Response (200) ### Update Session Resource #### Path parameters #### Headers #### Body parameters #### Returns #### Example ##### Response (200) ### Delete Session Resource #### Path parameters #### Headers #### Returns #### Example ##### Response (200) ## Sessions › Threads ### List Session Threads #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ### Get Session Thread #### Path parameters #### Headers #### Returns #### Example ##### Response (200) ### Archive Session Thread #### Path parameters #### Headers #### Returns #### Example ##### Response (200) ## Sessions › Threads › Events ### List Session Thread Events #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ### Stream Session Thread Events #### Path parameters #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ### Header Parameters ### Body Parameters #### Response ### Query Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters ### Body Parameters #### Response ### Path Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ## Domain Types # Events ## List Events ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Send Events ### Path Parameters ### Header Parameters ### Body Parameters #### Response ## Stream Events ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Domain Types ### Beta Managed Agents Agent Custom Tool Use Event ### Beta Managed Agents Agent MCP Tool Result Event ### Beta Managed Agents Agent MCP Tool Use Event ### Beta Managed Agents Agent Message Event ### Beta Managed Agents Agent Thinking Event ### Beta Managed Agents Agent Thread Context Compacted Event ### Beta Managed Agents Agent Thread Message Received Event ### Beta Managed Agents Agent Thread Message Sent Event ### Beta Managed Agents Agent Tool Result Event ### Beta Managed Agents Agent Tool Use Event ### Beta Managed Agents Base64 Document Source ### Beta Managed Agents Base64 Image Source ### Beta Managed Agents Billing Error ### Beta Managed Agents Credential Host Unreachable Error ### Beta Managed Agents Document Block ### Beta Managed Agents Event Params ### Beta Managed Agents File Document Source ### Beta Managed Agents File Image Source ### Beta Managed Agents File Rubric ### Beta Managed Agents File Rubric Params ### Beta Managed Agents Image Block ### Beta Managed Agents MCP Authentication Failed Error ### Beta Managed Agents MCP Connection Failed Error ### Beta Managed Agents Model Overloaded Error ### Beta Managed Agents Model Rate Limited Error ### Beta Managed Agents Model Request Failed Error ### Beta Managed Agents Plain Text Document Source ### Beta Managed Agents Redacted Block ### Beta Managed Agents Retry Status Exhausted ### Beta Managed Agents Retry Status Retrying ### Beta Managed Agents Retry Status Terminal ### Beta Managed Agents Search Result Block ### Beta Managed Agents Search Result Citations ### Beta Managed Agents Search Result Content ### Beta Managed Agents Send Session Events ### Beta Managed Agents Session Budget Reached ### Beta Managed Agents Session Deleted Event ### Beta Managed Agents Session End Turn ### Beta Managed Agents Session Error Event ### Beta Managed Agents Session Event ### Beta Managed Agents Session Requires Action ### Beta Managed Agents Session Retries Exhausted ### Beta Managed Agents Session Status Idle Event ### Beta Managed Agents Session Status Rescheduled Event ### Beta Managed Agents Session Status Running Event ### Beta Managed Agents Session Status Terminated Event ### Beta Managed Agents Session Thread Created Event ### Beta Managed Agents Session Thread Status Idle Event ### Beta Managed Agents Session Thread Status Rescheduled Event ### Beta Managed Agents Session Thread Status Running Event ### Beta Managed Agents Session Thread Status Terminated Event ### Beta Managed Agents Session Usage Snapshot ### Beta Managed Agents Span Model Request End Event ### Beta Managed Agents Span Model Request Start Event ### Beta Managed Agents Span Model Usage ### Beta Managed Agents Span Outcome Evaluation End Event ### Beta Managed Agents Span Outcome Evaluation Ongoing Event ### Beta Managed Agents Span Outcome Evaluation Start Event ### Beta Managed Agents Stream Session Events ### Beta Managed Agents System Message Event Params ### Beta Managed Agents Text Block ### Beta Managed Agents Text Rubric ### Beta Managed Agents Text Rubric Params ### Beta Managed Agents Unknown Error ### Beta Managed Agents URL Document Source ### Beta Managed Agents URL Image Source ### Beta Managed Agents User Custom Tool Result Event ### Beta Managed Agents User Custom Tool Result Event Params ### Beta Managed Agents User Define Outcome Event ### Beta Managed Agents User Define Outcome Event Params ### Beta Managed Agents User Interrupt Event ### Beta Managed Agents User Interrupt Event Params ### Beta Managed Agents User Message Event ### Beta Managed Agents User Message Event Params ### Beta Managed Agents User Tool Confirmation Event ### Beta Managed Agents User Tool Confirmation Event Params ### Beta Managed Agents User Tool Result Event Params # Resources ## Add Session Resource ### Path Parameters ### Header Parameters ### Body Parameters #### Response ## List Session Resources ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Get Session Resource ### Path Parameters ### Header Parameters #### Response ## Update Session Resource ### Path Parameters ### Header Parameters ### Body Parameters #### Response ## Delete Session Resource ### Path Parameters ### Header Parameters #### Response ## Domain Types ### Beta Managed Agents Delete Session Resource ### Beta Managed Agents File Resource ### Beta Managed Agents GitHub Repository Resource ### Beta Managed Agents Memory Store Resource ### Beta Managed Agents Session Resource ### Resource Retrieve Response ### Resource Update Response # Threads ## List Session Threads ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Get Session Thread ### Path Parameters ### Header Parameters #### Response ## Archive Session Thread ### Path Parameters ### Header Parameters #### Response ## Domain Types ### Beta Managed Agents Session Thread ### Beta Managed Agents Session Thread Stats ### Beta Managed Agents Session Thread Status ### Beta Managed Agents Session Thread Usage ### Beta Managed Agents Stream Session Thread Events # Events ## List Session Thread Events ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Stream Session Thread Events ### Path Parameters ### Query Parameters ### Header Parameters #### Response
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
api/beta/sessions Changed · +15287 / -10074 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
api/beta/sessions Changed · +72 / -34 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
- `model: optional BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams` - Replacement model. Accepts the model string, e.g. `claude-opus-4-6`, or a `model_config` object. Omit to use the agent's model. + Replacement model. Accepts the model string, e.g. `claude-opus-5`, or a `model_config` object. Omit to use the agent's model. - `BetaManagedAgentsModel = "claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more or string`
} ], "model": { - "id": "claude-sonnet-4-6", + "id": "claude-opus-5", "effort": { "type": "low" },
} ], "model": { - "id": "claude-sonnet-4-6", + "id": "claude-opus-5", "effort": { "type": "low" },
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
} ], "model": { - "id": "claude-sonnet-4-6", + "id": "claude-opus-5", "effort": { "type": "low" },
} ], "model": { - "id": "claude-sonnet-4-6", + "id": "claude-opus-5", "effort": { "type": "low" },
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
} ], "model": { - "id": "claude-sonnet-4-6", + "id": "claude-opus-5", "effort": { "type": "low" },
} ], "model": { - "id": "claude-sonnet-4-6", + "id": "claude-opus-5", "effort": { "type": "low" },
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
} ], "model": { - "id": "claude-sonnet-4-6", + "id": "claude-opus-5", "effort": { "type": "low" },
} ], "model": { - "id": "claude-sonnet-4-6", + "id": "claude-opus-5", "effort": { "type": "low" },
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
} ], "model": { - "id": "claude-sonnet-4-6", + "id": "claude-opus-5", "effort": { "type": "low" },
} ], "model": { - "id": "claude-sonnet-4-6", + "id": "claude-opus-5", "effort": { "type": "low" },
- `model: optional BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams` - Replacement model. Accepts the model string, e.g. `claude-opus-4-6`, or a `model_config` object. Omit to use the agent's model. + Replacement model. Accepts the model string, e.g. `claude-opus-5`, or a `model_config` object. Omit to use the agent's model. - `BetaManagedAgentsModel = "claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more or string`
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
- `type: "user.interrupt"` - - `"user.interrupt"` - - - `processed_at: optional string or null` - - A timestamp in RFC 3339 format - - - `session_thread_id: optional string or null` - - If absent, interrupts every non-archived thread + - `"u
api/beta/sessions First recorded · 33358 lines, first recorded
# Sessions ## Create Session ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Sessions ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Session ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Session ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Delete Session ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Session ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Advisor Params ### Beta Managed Agents Agent Message Preview ### Beta Managed Agents Agent Params ### Beta Managed Agents Agent Thinking Preview ### Beta Managed Agents Agent With Overrides Params ### Beta Managed Agents Branch Checkout ### Beta Managed Agents Budget Limit ### Beta Managed Agents Cache Creation Usage ### Beta Managed Agents Commit Checkout ### Beta Managed Agents Deleted Session ### Beta Managed Agents Delta Content ### Beta Managed Agents Delta Event ### Beta Managed Agents Delta Type ### Beta Managed Agents File Resource Params ### Beta Managed Agents GitHub Repository Resource Params ### Beta Managed Agents Memory Store Resource Param ### Beta Managed Agents Multiagent ### Beta Managed Agents Multiagent Params ### Beta Managed Agents Multiagent Roster Entry Params ### Beta Managed Agents Outcome Evaluation Resource ### Beta Managed Agents Server Tool Usage ### Beta Managed Agents Session ### Beta Managed Agents Session Agent ### Beta Managed Agents Session Agent Update ### Beta Managed Agents Session Multiagent Coordinator ### Beta Managed Agents Session Stats ### Beta Managed Agents Session Updated Event ### Beta Managed Agents Session Usage ### Beta Managed Agents Session Usage Event ### Beta Managed Agents Start Event ### Beta Managed Agents Start Event Preview ### Beta Managed Agents System Content Block ### Beta Managed Agents System Message Event ### Beta Managed Agents User Tool Result Event # Events ## List Events ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Send Events ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Stream Events ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Agent Custom Tool Use Event ### Beta Managed Agents Agent MCP Tool Result Event ### Beta Managed Agents Agent MCP Tool Use Event ### Beta Managed Agents Agent Message Event ### Beta Managed Agents Agent Thinking Event ### Beta Managed Agents Agent Thread Context Compacted Event ### Beta Managed Agents Agent Thread Message Received Event ### Beta Managed Agents Agent Thread Message Sent Event ### Beta Managed Agents Agent Tool Result Event ### Beta Managed Agents Agent Tool Use Event ### Beta Managed Agents Base64 Document Source ### Beta Managed Agents Base64 Image Source ### Beta Managed Agents Billing Error ### Beta Managed Agents Credential Host Unreachable Error ### Beta Managed Agents Document Block ### Beta Managed Agents Event Params ### Beta Managed Agents File Document Source ### Beta Managed Agents File Image Source ### Beta Managed Agents File Rubric ### Beta Managed Agents File Rubric Params ### Beta Managed Agents Image Block ### Beta Managed Agents MCP Authentication Failed Error ### Beta Managed Agents MCP Connection Failed Error ### Beta Managed Agents Model Overloaded Error ### Beta Managed Agents Model Rate Limited Error ### Beta Managed Agents Model Request Failed Error ### Beta Managed Agents Plain Text Document Source ### Beta Managed Agents Redacted Block ### Beta Managed Agents Retry Status Exhausted ### Beta Managed Agents Retry Status Retrying ### Beta Managed Agents Retry Status Terminal ### Beta Managed Agents Search Result Block ### Beta Managed Agents Search Result Citations ### Beta Managed Agents Search Result Content ### Beta Managed Agents Send Session Events ### Beta Managed Agents Session Budget Reached ### Beta Managed Agents Session Deleted Event ### Beta Managed Agents Session End Turn ### Beta Managed Agents Session Error Event ### Beta Managed Agents Session Event ### Beta Managed Agents Session Requires Action ### Beta Managed Agents Session Retries Exhausted ### Beta Managed Agents Session Status Idle Event ### Beta Managed Agents Session Status Rescheduled Event ### Beta Managed Agents Session Status Running Event ### Beta Managed Agents Session Status Terminated Event ### Beta Managed Agents Session Thread Created Event ### Beta Managed Agents Session Thread Status Idle Event ### Beta Managed Agents Session Thread Status Rescheduled Event ### Beta Managed Agents Session Thread Status Running Event ### Beta Managed Agents Session Thread Status Terminated Event ### Beta Managed Agents Session Usage Snapshot ### Beta Managed Agents Span Model Request End Event ### Beta Managed Agents Span Model Request Start Event ### Beta Managed Agents Span Model Usage ### Beta Managed Agents Span Outcome Evaluation End Event ### Beta Managed Agents Span Outcome Evaluation Ongoing Event ### Beta Managed Agents Span Outcome Evaluation Start Event ### Beta Managed Agents Stream Session Events ### Beta Managed Agents System Message Event Params ### Beta Managed Agents Text Block ### Beta Managed Agents Text Rubric ### Beta Managed Agents Text Rubric Params ### Beta Managed Agents Unknown Error ### Beta Managed Agents URL Document Source ### Beta Managed Agents URL Image Source ### Beta Managed Agents User Custom Tool Result Event ### Beta Managed Agents User Custom Tool Result Event Params ### Beta Managed Agents User Define Outcome Event ### Beta Managed Agents User Define Outcome Event Params ### Beta Managed Agents User Interrupt Event ### Beta Managed Agents User Interrupt Event Params ### Beta Managed Agents User Message Event ### Beta Managed Agents User Message Event Params ### Beta Managed Agents User Tool Confirmation Event ### Beta Managed Agents User Tool Confirmation Event Params ### Beta Managed Agents User Tool Result Event Params # Resources ## Add Session Resource ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Session Resources ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Session Resource ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Session Resource ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Delete Session Resource ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Delete Session Resource ### Beta Managed Agents File Resource ### Beta Managed Agents GitHub Repository Resource ### Beta Managed Agents Memory Store Resource ### Beta Managed Agents Session Resource ### Resource Retrieve Response ### Resource Update Response # Threads ## List Session Threads ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Session Thread ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Session Thread ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Session Thread ### Beta Managed Agents Session Thread Stats ### Beta Managed Agents Session Thread Status ### Beta Managed Agents Session Thread Usage ### Beta Managed Agents Stream Session Thread Events # Events ## List Session Thread Events ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Stream Session Thread Events ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
The first capture of this source. The page was already there, and this is what it said.
---
title: Sessions
url: https://platform.claude.com/docs/en/api/beta/sessions
---
# Sessions
## Create Session
**post** `/v1/sessions`
Create Session
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Body Parameters
- `agent: string or BetaManagedAgentsAgentParams or BetaManagedAgentsAgentWithOverridesParams`
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.
- `string`
- `BetaManagedAgentsAgentParams object { id, type, version }`
Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version
- `id: string`
The `agent` ID.
- `type: "agent"`
- `"agent"`
- `version: optional number`
The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.
- `BetaManagedAgentsAgentWithOverridesParams object { id, type, mcp_servers, 5 more }`
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.
- `id: string`
The `agent` ID.
- `type: "agent_with_overrides"`
- `"agent_with_overrides"`
- `mcp_servers: optional array of BetaManagedAgentsURLMCPServerParams`
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.
- `name: string`
Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.
- `type: "url"`
- `"url"`
- `url: string`
Endpoint URL for the MCP server.
- `model: optional BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams`
Replacement model. Accepts the model string, e.g. `claude-opus-4-6`, or a `model_config` object. Omit to use the agent's model.
- `BetaManagedAgentsModel = "claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more or string`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5"`
High-performance model for coding and agents
- `"claude-fable-5"`
Next generation of intelligence for the hardest knowledge work and coding problems
- `"claude-opus-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-8"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-7"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-6"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-6"`
Best combination of speed and intelligence
- `"claude-haiku-4-5"`
Fastest model with near-frontier intelligence
- `"claude-haiku-4-5-20251001"`
Fastest model with near-frontier intelligence
- `"claude-opus-4-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-5-20251101"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-5"`
High-performance model for agents and coding
- `"claude-sonnet-4-5-20250929"`
High-performance model for agents and coding
- `string`
- `BetaManagedAgentsModelConfigParams object { id, effort, inference_geo, speed }`
An object that defines additional configuration control over model use
- `id: BetaManagedAgentsModel`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `effort: optional "low" or "medium" or "high" or 2 more or BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or 3 more or null`
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.
- `BetaManagedAgentsEffortLevel = "low" or "medium" or "high" or 2 more`
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.
- `"low"`
- `"medium"`
- `"high"`
- `"xhigh"`
- `"max"`
- `BetaManagedAgentsEffortLow object { type }`
Low effort. Favors latency over reasoning depth.
- `type: "low"`
- `"low"`
- `BetaManagedAgentsEffortMedium object { type }`
Medium effort. Balances latency and reasoning depth.
- `type: "medium"`
- `"medium"`
- `BetaManagedAgentsEffortHigh object { type }`
High effort. Favors reasoning depth.
- `type: "high"`
- `"high"`
- `BetaManagedAgentsEffortXhigh object { type }`
Extra-high effort. Not all models accept this level.
- `type: "xhigh"`
- `"xhigh"`
- `BetaManagedAgentsEffortMax object { type }`
Maximum effort. Favors reasoning depth over latency.
- `type: "max"`
- `"max"`
- `inference_geo: optional string or null`
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.
- `speed: optional "standard" or "fast" or null`
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.
- `"standard"`
- `"fast"`
- `skills: optional array of BetaManagedAgentsSkillParams`
Replacement skill list. Full replacement: the provided array becomes the skills. Send an empty array to clear; omit to preserve the agent's skills.
- `BetaManagedAgentsAnthropicSkillParams object { skill_id, type, version }`
An Anthropic-managed skill.
- `skill_id: string`
Cut at 300 lines.