Sessions
Create Session
List Sessions
Get Session
Update Session
Delete Session
Archive Session
Models
BetaManagedAgentsAdvisorParams object{ type: "advisor", model }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.
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.
model: stringA Claude model id. The model must be permitted as an advisor for this agent's model.
A Claude model id. The model must be permitted as an advisor for this agent's model.
BetaManagedAgentsAgentMessagePreview object{ type: "agent.message", id }
The id the buffered agent.message will carry if it is emitted. Matches the event_id on this preview's event_delta events.
BetaManagedAgentsAgentParams object{ type: "agent", id, version }Specification for an Agent. Provide a specific version or use the short-form agent="agent_id" for the most recent version
Specification for an Agent. Provide a specific version or use the short-form agent="agent_id" for the most recent version
id: stringThe agent ID.
The agent ID.
version: optional numberThe specific agent version to use. Omit to use the latest version. Must be at least 1 if specified.
The specific agent version to use. Omit to use the latest version. Must be at least 1 if specified.
BetaManagedAgentsAgentThinkingPreview object{ type: "agent.thinking", id }
The id the buffered agent.thinking will carry if it is emitted. Start-only — no event_delta events follow.
BetaManagedAgentsAgentWithOverridesParams object{ type: "agent_with_overrides", id, 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.
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.
BetaManagedAgentsBranchCheckout object{ type: "branch", name }
name: stringBranch name to check out.
Branch name to check out.
BetaManagedAgentsBudgetLimit object{ type: "limit", max_list_cost }A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches max_list_cost.
A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches max_list_cost.
max_list_cost: BetaMonetaryAmount { amount, currency }Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
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.
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.
BetaManagedAgentsCacheCreationUsage object{ ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }Prompt-cache creation token usage broken down by cache lifetime.
Prompt-cache creation token usage broken down by cache lifetime.
ephemeral_1h_input_tokens: optional numberTokens used to create 1-hour ephemeral cache entries.
Tokens used to create 1-hour ephemeral cache entries.
ephemeral_5m_input_tokens: optional numberTokens used to create 5-minute ephemeral cache entries.
Tokens used to create 5-minute ephemeral cache entries.
BetaManagedAgentsCommitCheckout object{ type: "commit", sha }
sha: stringFull commit SHA to check out.
Full commit SHA to check out.
BetaManagedAgentsDeletedSession object{ type: "session_deleted", id }Confirmation that a session has been permanently deleted.
Confirmation that a session has been permanently deleted.
BetaManagedAgentsDeltaContent object{ type: "content_delta", content, index }
content: BetaManagedAgentsTextBlock { type: "text", text }A partial element of the content array at index, typed like the element itself — the same shape the buffered agent.message carries in content.
A partial element of the content array at index, typed like the element itself — the same shape the buffered agent.message carries in content.
text: stringThe text content.
The text content.
Which entry in the previewed event's content array this fragment lands in. Insert content as that entry when the index is new; append to the existing entry otherwise.
BetaManagedAgentsDeltaEvent object{ type: "event_delta", delta, event_id }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.
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.
BetaManagedAgentsDeltaType = "agent.message" or "agent.thinking"
BetaManagedAgentsFileResourceParams object{ type: "file", file_id, mount_path }Mount a file uploaded via the Files API into the session.
Mount a file uploaded via the Files API into the session.
file_id: stringID of a previously uploaded file.
ID of a previously uploaded file.
mount_path: optional string or nullMount path in the container. Defaults to /mnt/session/uploads/<file_id>.
Mount path in the container. Defaults to /mnt/session/uploads/<file_id>.
BetaManagedAgentsGitHubRepositoryResourceParams object{ type: "github_repository", url, authorization_token, 2 more }Mount a GitHub repository into the session's container.
Mount a GitHub repository into the session's container.
BetaManagedAgentsMemoryStoreResourceParam object{ type: "memory_store", memory_store_id, access, instructions }Parameters for attaching a memory store to an agent session.
Parameters for attaching a memory store to an agent session.
The memory store ID (memstore_...). Must belong to the caller's organization and workspace.
access: optional "read_write" or "read_only" or nullAccess mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem.
Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem.
instructions: optional string or nullPer-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.
Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.
BetaManagedAgentsMultiagent = BetaManagedAgentsMultiagentCoordinator or BetaManagedAgentsMultiagent20261001Resolved multiagent orchestration configuration as returned in API responses.
Resolved multiagent orchestration configuration as returned in API responses.
BetaManagedAgentsMultiagentCoordinator object{ type: "coordinator", agents }Resolved coordinator topology with a concrete agent roster.
Resolved coordinator topology with a concrete agent roster.
BetaManagedAgentsMultiagent20261001 object{ type: "multiagent_20261001", advisor, subagents, workflows }Resolved multiagent configuration with three members, each enabled or disabled on its own.
Resolved multiagent configuration with three members, each enabled or disabled on its own.
BetaManagedAgentsMultiagentParams = BetaManagedAgentsMultiagentCoordinatorParams or BetaManagedAgentsMultiagent20261001ParamsMultiagent orchestration configuration.
Multiagent orchestration configuration.
BetaManagedAgentsMultiagentCoordinatorParams object{ type: "coordinator", agents }A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the agents roster.
A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the agents roster.
BetaManagedAgentsMultiagent20261001Params object{ type: "multiagent_20261001", advisor, subagents, workflows }Multiagent configuration with three members, each enabled or disabled on its own. On an update, if the agent's stored multiagent also has type multiagent_20261001, this configuration is merged into the stored one, level by level, instead of replacing it. A key that the update omits keeps its stored value. A key sent as null takes its default, on create as well, so "workflows": null enables workflows. An object sent with a type other than the stored one replaces the stored object, and the keys that it omits take their defaults. A predefined_agents list that is sent replaces the stored list. Every object that is sent needs its type, and an enabled advisor needs its model. Other validation applies to the merged result.
Multiagent configuration with three members, each enabled or disabled on its own. On an update, if the agent's stored multiagent also has type multiagent_20261001, this configuration is merged into the stored one, level by level, instead of replacing it. A key that the update omits keeps its stored value. A key sent as null takes its default, on create as well, so "workflows": null enables workflows. An object sent with a type other than the stored one replaces the stored object, and the keys that it omits take their defaults. A predefined_agents list that is sent replaces the stored list. Every object that is sent needs its type, and an enabled advisor needs its model. Other validation applies to the merged result.
BetaManagedAgentsMultiagentRosterEntryParams = string or BetaManagedAgentsAgentParams or BetaManagedAgentsMultiagentSelfParams or BetaManagedAgentsAdvisorParamsAn entry in a multiagent roster: an agent ID string, a versioned agent reference, or self.
An entry in a multiagent roster: an agent ID string, a versioned agent reference, or self.
BetaManagedAgentsOutcomeEvaluationResource object{ type: "outcome_evaluation", completed_at, description, 4 more }Evaluation state for a single outcome defined via a define_outcome event.
Evaluation state for a single outcome defined via a define_outcome event.
completed_at: string or nullWhen the outcome reached a terminal result. Null while pending/running/evaluating.
When the outcome reached a terminal result. Null while pending/running/evaluating.
What the agent should produce.
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.
iteration: number0-indexed revision cycle the outcome is currently on.
0-indexed revision cycle the outcome is currently on.
Server-generated outc_ ID for this outcome.
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.
BetaManagedAgentsServerToolUsage object{ web_fetch_requests, web_search_requests }Cumulative count of server-executed tool invocations, broken down by tool.
Cumulative count of server-executed tool invocations, broken down by tool.
web_fetch_requests: optional numberNumber of server-executed web fetch requests.
Number of server-executed web fetch requests.
web_search_requests: optional numberNumber of server-executed web search requests.
Number of server-executed web search requests.
BetaManagedAgentsSession object{ type: "session", id, agent, 14 more }A Managed Agents session.
A Managed Agents session.
BetaManagedAgentsSessionAgent object{ type: "agent", id, description, 8 more }Resolved agent definition for a session. Snapshot of the agent at session creation time.
Resolved agent definition for a session. Snapshot of the agent at session creation time.
BetaManagedAgentsSessionAgentUpdate object{ mcp_servers, tools }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.
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.
BetaManagedAgentsSessionMultiagent = BetaManagedAgentsSessionMultiagentCoordinator or BetaManagedAgentsSessionMultiagent20261001Resolved multiagent orchestration configuration as returned on a session.
Resolved multiagent orchestration configuration as returned on a session.
BetaManagedAgentsSessionMultiagentCoordinator object{ type: "coordinator", agents }Resolved coordinator topology with full agent definitions for each roster member.
Resolved coordinator topology with full agent definitions for each roster member.
agents: array of BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisorFull agent definitions the coordinator may spawn as session threads.
Full agent definitions the coordinator may spawn as session threads.
BetaManagedAgentsSessionThreadAgent object{ type: "agent", id, description, 7 more }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.
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.
BetaManagedAgentsAdvisor object{ type: "advisor", model }Platform advisor roster entry: a model the session's primary thread may consult mid-turn.
Platform advisor roster entry: a model the session's primary thread may consult mid-turn.
The advisor model id.
BetaManagedAgentsSessionMultiagentSubagents = BetaManagedAgentsSessionMultiagentSubagentsEnabled or BetaManagedAgentsMultiagentSubagentsDisabledWhether the agent can spawn session threads.
Whether the agent can spawn session threads.
BetaManagedAgentsSessionMultiagentSubagentsEnabled object{ type: "enabled", inline_agents, predefined_agents }The agent can spawn session threads.
The agent can spawn session threads.
BetaManagedAgentsMultiagentSubagentsDisabled object{ type: "disabled" }The agent cannot spawn session threads.
The agent cannot spawn session threads.
BetaManagedAgentsSessionMultiagentSubagentsEnabled object{ type: "enabled", inline_agents, predefined_agents }The agent can spawn session threads.
The agent can spawn session threads.
BetaManagedAgentsSessionMultiagentWorkflows = BetaManagedAgentsSessionMultiagentWorkflowsEnabled or BetaManagedAgentsMultiagentWorkflowsDisabledWhether the agent can start workflow runs.
Whether the agent can start workflow runs.
BetaManagedAgentsSessionMultiagentWorkflowsEnabled object{ type: "enabled", inline_agents, predefined_agents }The agent can start workflow runs.
The agent can start workflow runs.
BetaManagedAgentsMultiagentWorkflowsDisabled object{ type: "disabled" }The agent cannot start workflow runs.
The agent cannot start workflow runs.
BetaManagedAgentsSessionMultiagentWorkflowsEnabled object{ type: "enabled", inline_agents, predefined_agents }The agent can start workflow runs.
The agent can start workflow runs.
BetaManagedAgentsSessionMultiagent20261001 object{ type: "multiagent_20261001", advisor, subagents, workflows }Resolved multiagent configuration with three members, as copied to the session at creation.
Resolved multiagent configuration with three members, as copied to the session at creation.
BetaManagedAgentsSessionStats object{ active_seconds, duration_seconds }Timing statistics for a session.
Timing statistics for a session.
active_seconds: optional numberCumulative time in seconds the session spent in running status. Excludes idle time.
Cumulative time in seconds the session spent in running status. Excludes idle time.
duration_seconds: optional numberElapsed time since session creation in seconds. For terminated sessions, frozen at the final update.
Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update.
BetaManagedAgentsSessionUpdatedEvent object{ type: "session.updated", id, processed_at, 4 more }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.
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.
BetaManagedAgentsSessionUsage object{ active_seconds, cache_creation, cache_read_input_tokens, 4 more }Cumulative token usage for a session across all turns.
Cumulative token usage for a session across all turns.
BetaManagedAgentsSessionUsageEvent object{ type: "session.usage", id, processed_at, 2 more }Periodic snapshot of the session's cumulative usage and tracked list cost.
Periodic snapshot of the session's cumulative usage and tracked list cost.
BetaManagedAgentsStartEvent object{ type: "event_start", event }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.
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.
BetaManagedAgentsStartEventPreview = BetaManagedAgentsAgentMessagePreview or BetaManagedAgentsAgentThinkingPreview
BetaManagedAgentsAgentMessagePreview object{ type: "agent.message", id }
The id the buffered agent.message will carry if it is emitted. Matches the event_id on this preview's event_delta events.
BetaManagedAgentsAgentThinkingPreview object{ type: "agent.thinking", id }
The id the buffered agent.thinking will carry if it is emitted. Start-only — no event_delta events follow.
BetaManagedAgentsSystemContentBlock object{ type: "text", text }Content block in a mid-conversation system message. Text-only.
Content block in a mid-conversation system message. Text-only.
text: stringThe text content.
The text content.
BetaManagedAgentsSystemMessageEvent object{ type: "system.message", id, content, processed_at }A mid-conversation system message event. Carries system-role content that is appended to the session as a role: "system" turn.
A mid-conversation system message event. Carries system-role content that is appended to the session as a role: "system" turn.
Unique identifier for this event.
content: array of BetaManagedAgentsSystemContentBlock { type: "text", text }System content blocks. Text-only.
System content blocks. Text-only.
text: stringThe text content.
The text content.
processed_at: optional string or nullTimestamp when this system message was processed.
Timestamp when this system message was processed.
BetaManagedAgentsUserToolResultEvent object{ type: "user.tool_result", id, tool_use_id, 4 more }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.
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.