Claude Platform Docs

Eventos

Listar eventos
client.beta.sessions.events.list(sessionID, params?, options?): PageCursor<BetaManagedAgentsSessionEvent>
GET/v1/sessions/{session_id}/events
Enviar eventos
client.beta.sessions.events.send(sessionID, params, options?): BetaManagedAgentsSendSessionEvents
POST/v1/sessions/{session_id}/events
Streaming de eventos
client.beta.sessions.events.stream(sessionID, params?, options?): BetaManagedAgentsStreamSessionEvents | Stream<BetaManagedAgentsStreamSessionEvents>
GET/v1/sessions/{session_id}/events/stream
Models

The server's per-invocation judgement under the auto permission policy. Its type always equals the event's top-level evaluated_permission. Open union: clients must tolerate unknown variants.

One of the following:
interface BetaManagedAgentsAgentAutoEvaluatedPermissionAllow { type: "allow" }

The server judged the invocation safe to execute without client approval.

type: "allow"
interface BetaManagedAgentsAgentAutoEvaluatedPermissionAsk { type: "ask"; reason_code }

The server reached no judgement; the invocation is held for client approval.

type: "ask"
reason_code: string

The judgement's grounds in registry-bound terms, for client branching and audit rather than end-user display. Open registry; currently "indeterminate" (no judgement was reached). Clients must tolerate values outside this set.

maxLength64
interface BetaManagedAgentsAgentAutoEvaluatedPermissionDeny { type: "deny"; reason_code }

The server judged the invocation high-risk; it does not execute and a synthetic error tool result is appended.

type: "deny"
reason_code: string

The judgement's grounds in registry-bound terms. Open registry; currently "high_risk" (judged high-risk; the call does not run). Clients must tolerate values outside this set.

maxLength64
interface BetaManagedAgentsAgentCustomToolUseEvent { type: "agent.custom_tool_use"; id; input; /* 3 more */ }

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. The client can send it as soon as this event arrives, without waiting for session.status_idle.

type: "agent.custom_tool_use"
id: string

Unique identifier for this event.

input: Record<string, unknown>

Input parameters for the tool call.

name: string

Name of the custom tool being called.

processed_at: string

Timestamp when this tool use was processed.

formatdate-time
session_thread_id?: string | null

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.

type BetaManagedAgentsAgentEvaluatedPermission = "allow" | "ask" | "deny"
One of the following:
"allow"
"ask"
"deny"
interface BetaManagedAgentsAgentMCPToolResultEvent { type: "agent.mcp_tool_result"; id; mcp_tool_use_id; /* 3 more */ }

Event representing the result of an MCP tool execution.

interface BetaManagedAgentsAgentMCPToolUseEvent { type: "agent.mcp_tool_use"; id; input; /* 6 more */ }

Event emitted when the agent invokes a tool provided by an MCP server.

interface BetaManagedAgentsAgentMessageEvent { type: "agent.message"; id; content; processed_at }

An agent response event in the session conversation.

type: "agent.message"
id: string

Unique identifier for this event.

Array of text blocks comprising the agent response.

One of the following:
interface BetaManagedAgentsTextBlock { type: "text"; text }

Regular text content.

type: "text"
text: string

The text content.

minLength1
interface BetaManagedAgentsRedactedBlock { type: "redacted" }

Placeholder for content withheld by Anthropic model policy.

type: "redacted"
processed_at: string

Timestamp when this response was generated.

formatdate-time
interface BetaManagedAgentsAgentThinkingEvent { type: "agent.thinking"; id; processed_at }

Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier.

type: "agent.thinking"
id: string

Unique identifier for this event.

processed_at: string

Timestamp when this thinking was produced.

formatdate-time
interface BetaManagedAgentsAgentThreadContextCompactedEvent { type: "agent.thread_context_compacted"; id; processed_at }

Indicates that context compaction (summarization) occurred during the session.

type: "agent.thread_context_compacted"
id: string

Unique identifier for this event.

processed_at: string

Timestamp when compaction was processed.

formatdate-time
interface BetaManagedAgentsAgentThreadMessageReceivedEvent { type: "agent.thread_message_received"; id; content; /* 3 more */ }

Delivery event written to the target thread's input stream when an agent-to-agent message arrives.

interface BetaManagedAgentsAgentThreadMessageSentEvent { type: "agent.thread_message_sent"; id; content; /* 3 more */ }

Observability event emitted to the sender's output stream when an agent-to-agent message is sent.

Names the resolved permission_policy that produced evaluated_permission, and under auto carries the judgement. Open union: clients must tolerate unknown variants.

One of the following:
interface BetaManagedAgentsAgentToolEvaluationAlwaysAllow { type: "always_allow" }

The resolved permission_policy was always_allow; accompanies evaluated_permission "allow".

type: "always_allow"
interface BetaManagedAgentsAgentToolEvaluationAlwaysAsk { type: "always_ask" }

The resolved permission_policy was always_ask; accompanies evaluated_permission "ask".

type: "always_ask"
interface BetaManagedAgentsAgentToolEvaluationAuto { type: "auto"; evaluated_permission }

The resolved permission_policy was auto: the server judged this invocation individually.

interface BetaManagedAgentsAgentToolEvaluationAlwaysAllow { type: "always_allow" }

The resolved permission_policy was always_allow; accompanies evaluated_permission "allow".

type: "always_allow"
interface BetaManagedAgentsAgentToolEvaluationAlwaysAsk { type: "always_ask" }

The resolved permission_policy was always_ask; accompanies evaluated_permission "ask".

type: "always_ask"
interface BetaManagedAgentsAgentToolEvaluationAuto { type: "auto"; evaluated_permission }

The resolved permission_policy was auto: the server judged this invocation individually.

interface BetaManagedAgentsAgentToolResultEvent { type: "agent.tool_result"; id; processed_at; /* 3 more */ }

Event representing the result of an agent tool execution.

interface BetaManagedAgentsAgentToolUseEvent { type: "agent.tool_use"; id; input; /* 5 more */ }

Event emitted when the agent invokes a built-in agent tool.

interface BetaManagedAgentsBase64DocumentSource { type: "base64"; data; media_type }

Base64-encoded document data.

type: "base64"
data: string

Base64-encoded document data.

minLength1
media_type: string

MIME type of the document (e.g., "application/pdf").

minLength1
interface BetaManagedAgentsBase64ImageSource { type: "base64"; data; media_type }

Base64-encoded image data.

type: "base64"
data: string

Base64-encoded image data.

minLength1
media_type: string

MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

minLength1
interface BetaManagedAgentsBillingError { type: "billing_error"; message; retry_status }

The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state.

interface BetaManagedAgentsCredentialHostUnreachableError { type: "credential_host_unreachable_error"; credential_id; message; /* 2 more */ }

An environment_variable credential's auth.networking.allowed_hosts includes a host the environment's network policy does not permit.

interface BetaManagedAgentsDocumentBlock { type: "document"; source; context; title }

Document content, either specified directly as base64 data, as text, or as a reference via a URL.

Union type for event parameters that can be sent to a session.

One of the following:
interface BetaManagedAgentsFileDocumentSource { type: "file"; file_id }

Document referenced by file ID.

type: "file"
file_id: string

ID of a previously uploaded file.

minLength1
interface BetaManagedAgentsFileImageSource { type: "file"; file_id }

Image referenced by file ID.

type: "file"
file_id: string

ID of a previously uploaded file.

minLength1
interface BetaManagedAgentsFileRubric { type: "file"; file_id }

Rubric referenced by a file uploaded via the Files API.

type: "file"
file_id: string

ID of the rubric file.

interface BetaManagedAgentsFileRubricParams { type: "file"; file_id }

Rubric referenced by a file uploaded via the Files API.

type: "file"
file_id: string

ID of the rubric file.

interface BetaManagedAgentsImageBlock { type: "image"; source }

Image content specified directly as base64 data or as a reference via a URL.

interface BetaManagedAgentsMaxWorkflowRunsWorkflowRunError { type: "max_workflow_runs_error"; message }

No run was created, because the session was at its limit of open workflow runs, which are runs that have not ended. Only workflow_run.error carries this type.

type: "max_workflow_runs_error"
message: string

Short explanation written by the server. It never contains content from the run or its agents.

interface BetaManagedAgentsMCPAuthenticationFailedError { type: "mcp_authentication_failed_error"; mcp_server_name; message; retry_status }

Authentication to an MCP server failed.

interface BetaManagedAgentsMCPConnectionFailedError { type: "mcp_connection_failed_error"; mcp_server_name; message; retry_status }

Failed to connect to an MCP server.

interface BetaManagedAgentsModelOverloadedError { type: "model_overloaded_error"; message; retry_status }

The model is currently overloaded. Emitted after automatic retries are exhausted.

interface BetaManagedAgentsModelRateLimitedError { type: "model_rate_limited_error"; message; retry_status }

The model request was rate-limited.

interface BetaManagedAgentsModelRequestFailedError { type: "model_request_failed_error"; message; retry_status }

A model request failed for a reason other than overload or rate-limiting.

interface BetaManagedAgentsPlainTextDocumentSource { type: "text"; data; media_type }

Plain text document content.

type: "text"
data: string

The plain text content.

minLength1
media_type: "text/plain"

MIME type of the text content. Must be "text/plain".

interface BetaManagedAgentsProgramWorkflowRunError { type: "program_error"; message }

The plan, a program that the agent wrote, failed, or the server refused it.

type: "program_error"
message: string

Short explanation written by the server. It never contains content from the run or its agents.

interface BetaManagedAgentsRedactedBlock { type: "redacted" }

Placeholder for content withheld by Anthropic model policy.

type: "redacted"
interface BetaManagedAgentsRepositoryAuthenticationError { type: "repository_authentication_error"; message; repository_url; retry_status }

The repository host rejected the credentials, or required credentials and received none.

interface BetaManagedAgentsRepositoryCheckoutError { type: "repository_checkout_error"; message; repository_url; retry_status }

The requested branch or commit does not exist in the repository.

interface BetaManagedAgentsRepositoryCloneError { type: "repository_clone_error"; message; repository_url; retry_status }

The repository could not be cloned.

interface BetaManagedAgentsRepositoryForbiddenError { type: "repository_forbidden_error"; message; repository_url; retry_status }

The repository host refused access to the repository.

interface BetaManagedAgentsRepositoryNotFoundError { type: "repository_not_found_error"; message; repository_url; retry_status }

The repository host reported the repository as not found.

interface BetaManagedAgentsRetryStatusExhausted { type: "exhausted" }

This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

type: "exhausted"
interface BetaManagedAgentsRetryStatusRetrying { type: "retrying" }

The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

type: "retrying"
interface BetaManagedAgentsRetryStatusTerminal { type: "terminal" }

The session encountered a terminal error and will transition to terminated state.

type: "terminal"
interface BetaManagedAgentsSearchResultBlock { type: "search_result"; citations; content; /* 2 more */ }

A block containing a web search result.

type: "search_result"
citations: BetaManagedAgentsSearchResultCitations { enabled }

Citation settings for this search result.

enabled: boolean

Whether citations are enabled for this search result.

content: Array<BetaManagedAgentsSearchResultContent { type: "text"; text }>

Array of text content blocks from the search result.

type: "text"
text: string

The text content.

minLength1
source: string

The URL source of the search result.

minLength1
title: string

The title of the search result.

minLength1
interface BetaManagedAgentsSearchResultCitations { enabled }

Citation settings for a search result.

enabled: boolean

Whether citations are enabled for this search result.

interface BetaManagedAgentsSearchResultContent { type: "text"; text }

Text content within a search result.

type: "text"
text: string

The text content.

minLength1
interface BetaManagedAgentsSendSessionEvents { data }

Events that were successfully sent to the session.

interface BetaManagedAgentsSessionBudgetReached { type: "budget_reached" }

The agent stopped because the session's tracked list cost reached its budget, or because its usage includes a model with no list price (which the budget cannot measure). Raise the budget to continue — or, if raising is rejected because a model has no list price, remove the budget.

type: "budget_reached"
interface BetaManagedAgentsSessionDeletedEvent { type: "session.deleted"; id; processed_at }

Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session.

type: "session.deleted"
id: string

Unique identifier for this event.

processed_at: string

Timestamp when the session was deleted.

formatdate-time
interface BetaManagedAgentsSessionEndTurn { type: "end_turn" }

The agent completed its turn naturally and is ready for the next user message.

type: "end_turn"
interface BetaManagedAgentsSessionErrorEvent { type: "session.error"; id; error; processed_at }

An error event indicating a problem occurred during session execution.

Union type for all event types in a session.

One of the following:
type BetaManagedAgentsSessionEventType = "user.message" | "user.interrupt" | "user.tool_confirmation" | 38 more

The type of a session event.

One of the following:
interface BetaManagedAgentsSessionRefusal { type: "refusal" }

The turn ended because the model's response was refused, for example by a safety classifier.

type: "refusal"
interface BetaManagedAgentsSessionRefusalStopDetails { type: "refusal"; category; explanation }

Structured information about a refusal.

type: "refusal"
category: "cyber" | "bio" | "frontier_llm" | 2 more | null

The policy category that triggered the refusal, or null when there is no named category. New values can be added over time.

One of the following:
"cyber"
"bio"
"frontier_llm"
"reasoning_extraction"
"general_harms"
explanation: string | null

Human-readable explanation of the refusal, or null when none is available. The wording can change, so do not parse it.

interface BetaManagedAgentsSessionRequiresAction { type: "requires_action"; event_ids }

The agent is idle waiting on one or more blocking user-input events (tool confirmation, custom tool result, etc.). Resolving all of them transitions the session back to running.

type: "requires_action"
event_ids: Array<string>

The ids of events the agent is blocked on. Resolving fewer than all re-emits session.status_idle with the remainder.

interface BetaManagedAgentsSessionRetriesExhausted { type: "retries_exhausted" }

The turn ended because repeated errors exhausted the retry budget or an error escalated to retry_status: 'exhausted'.

type: "retries_exhausted"
interface BetaManagedAgentsSessionStatusIdleEvent { type: "session.status_idle"; id; processed_at; /* 2 more */ }

Indicates the agent has paused and is awaiting user input.

interface BetaManagedAgentsSessionStatusRescheduledEvent { type: "session.status_rescheduled"; id; processed_at }

Indicates the session is recovering from an error state and is rescheduled for execution.

type: "session.status_rescheduled"
id: string

Unique identifier for this event.

processed_at: string

Timestamp of status change.

formatdate-time
interface BetaManagedAgentsSessionStatusRunningEvent { type: "session.status_running"; id; processed_at }

Indicates the session is actively running and the agent is working.

type: "session.status_running"
id: string

Unique identifier for this event.

processed_at: string

Timestamp of status change.

formatdate-time
interface BetaManagedAgentsSessionStatusTerminatedEvent { type: "session.status_terminated"; id; processed_at }

Indicates the session has terminated, either due to an error or completion.

type: "session.status_terminated"
id: string

Unique identifier for this event.

processed_at: string

Timestamp of status change.

formatdate-time
interface BetaManagedAgentsSessionThreadCreatedEvent { type: "session.thread_created"; id; agent_name; /* 3 more */ }

Emitted when a child thread is created. Written to the parent thread's output stream so clients observing the session see child creation.

type: "session.thread_created"
id: string

Unique identifier for this event.

agent_name: string

Name of the callable agent the thread runs.

processed_at: string

Timestamp when the thread was created.

formatdate-time
session_thread_id: string

Public sthr_ ID of the newly created thread.

workflow_run_id: string | null

Identifier of the workflow run that created the thread, or null for any other thread.

interface BetaManagedAgentsSessionThreadStatusIdleEvent { type: "session.thread_status_idle"; id; agent_name; /* 4 more */ }

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.

interface BetaManagedAgentsSessionThreadStatusRescheduledEvent { type: "session.thread_status_rescheduled"; id; agent_name; /* 2 more */ }

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.

type: "session.thread_status_rescheduled"
id: string

Unique identifier for this event.

agent_name: string

Name of the agent the thread runs.

processed_at: string

Timestamp of the status transition.

formatdate-time
session_thread_id: string

Public sthr_ ID of the thread that is retrying.

interface BetaManagedAgentsSessionThreadStatusRunningEvent { type: "session.thread_status_running"; id; agent_name; /* 2 more */ }

A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads.

type: "session.thread_status_running"
id: string

Unique identifier for this event.

agent_name: string

Name of the agent the thread runs.

processed_at: string

Timestamp of the status transition.

formatdate-time
session_thread_id: string

Public sthr_ ID of the thread that started running.

interface BetaManagedAgentsSessionThreadStatusTerminatedEvent { type: "session.thread_status_terminated"; id; agent_name; /* 2 more */ }

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.

type: "session.thread_status_terminated"
id: string

Unique identifier for this event.

agent_name: string

Name of the agent the thread runs.

processed_at: string

Timestamp of the status transition.

formatdate-time
session_thread_id: string

Public sthr_ ID of the thread that terminated.

interface BetaManagedAgentsSessionUsageSnapshot { active_seconds; cache_creation; cache_read_input_tokens; /* 4 more */ }

Point-in-time snapshot of a session's cumulative usage.

interface BetaManagedAgentsSpanModelRequestEndEvent { type: "span.model_request_end"; id; is_error; /* 3 more */ }

Emitted when a model request completes.

interface BetaManagedAgentsSpanModelRequestStartEvent { type: "span.model_request_start"; id; processed_at }

Emitted when a model request is initiated by the agent.

type: "span.model_request_start"
id: string

Unique identifier for this event.

processed_at: string

Timestamp when the model request started.

formatdate-time
interface BetaManagedAgentsSpanModelUsage { cache_creation_input_tokens; cache_read_input_tokens; input_tokens; /* 2 more */ }

Token usage for a single model request.

cache_creation_input_tokens: number

Tokens used to create prompt cache in this request.

formatint32
cache_read_input_tokens: number

Tokens read from prompt cache in this request.

formatint32
input_tokens: number

Input tokens consumed by this request.

formatint32
output_tokens: number

Output tokens generated by this request.

formatint32
speed?: "standard" | "fast" | null

Inference speed tier this request actually ran at. Mirrors usage.speed on /v1/messages. Only present when the fast-mode beta is active.

One of the following:
"standard"
"fast"
interface BetaManagedAgentsSpanOutcomeEvaluationEndEvent { type: "span.outcome_evaluation_end"; id; explanation; /* 6 more */ }

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.

interface BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent { type: "span.outcome_evaluation_ongoing"; id; iteration; /* 2 more */ }

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.

type: "span.outcome_evaluation_ongoing"
id: string

Unique identifier for this event.

iteration: number

0-indexed revision cycle, matching the corresponding span.outcome_evaluation_start.

formatint32
outcome_id: string

The outc_ ID of the outcome being evaluated.

processed_at: string

Timestamp when this heartbeat was emitted.

formatdate-time
interface BetaManagedAgentsSpanOutcomeEvaluationStartEvent { type: "span.outcome_evaluation_start"; id; iteration; /* 2 more */ }

Emitted when an outcome evaluation cycle begins.

type: "span.outcome_evaluation_start"
id: string

Unique identifier for this event.

iteration: number

0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc.

formatint32
outcome_id: string

The outc_ ID of the outcome being evaluated.

processed_at: string

Timestamp when outcome evaluation started.

formatdate-time

Server-sent event in the session stream.

One of the following:
interface BetaManagedAgentsSystemMessageEventParams { type: "system.message"; content }

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.

type: "system.message"
content: Array<BetaManagedAgentsSystemContentBlock { type: "text"; text }>

System content blocks to append. Text-only.

type: "text"
text: string

The text content.

minLength1
interface BetaManagedAgentsTextBlock { type: "text"; text }

Regular text content.

type: "text"
text: string

The text content.

minLength1
interface BetaManagedAgentsTextRubric { type: "text"; content }

Rubric content provided inline as text.

type: "text"
content: string

Rubric content. Plain text or markdown — the grader treats it as freeform text.

interface BetaManagedAgentsTextRubricParams { type: "text"; content }

Rubric content provided inline as text.

type: "text"
content: string

Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.

maxLength262144
interface BetaManagedAgentsThreadLimitWorkflowRunError { type: "thread_limit_error"; message }

The run exceeded the limit on the number of threads that a run can create.

type: "thread_limit_error"
message: string

Short explanation written by the server. It never contains content from the run or its agents.

interface BetaManagedAgentsTimeoutWorkflowRunError { type: "timeout_error"; message }

The run reached its time limit.

type: "timeout_error"
message: string

Short explanation written by the server. It never contains content from the run or its agents.

interface BetaManagedAgentsUnknownError { type: "unknown_error"; message; retry_status }

An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on retry_status and message alone.

interface BetaManagedAgentsUnknownWorkflowRunError { type: "unknown_error"; message }

A failure that has no type of its own.

type: "unknown_error"
message: string

Short explanation written by the server. It never contains content from the run or its agents.

interface BetaManagedAgentsURLDocumentSource { type: "url"; url }

Document referenced by URL.

type: "url"
url: string

URL of the document to fetch.

minLength1
interface BetaManagedAgentsURLImageSource { type: "url"; url }

Image referenced by URL.

type: "url"
url: string

URL of the image to fetch.

minLength1
interface BetaManagedAgentsUserCustomToolResultEvent { type: "user.custom_tool_result"; id; custom_tool_use_id; /* 4 more */ }

Event sent by the client providing the result of a custom tool execution.

interface BetaManagedAgentsUserCustomToolResultEventParams { type: "user.custom_tool_result"; custom_tool_use_id; content; is_error }

Parameters for providing the result of a custom tool execution.

interface BetaManagedAgentsUserDefineOutcomeEvent { type: "user.define_outcome"; id; description; /* 4 more */ }

Echo of a user.define_outcome input event. Carries the server-generated outcome_id that subsequent span.outcome_evaluation_* events reference.

interface BetaManagedAgentsUserDefineOutcomeEventParams { type: "user.define_outcome"; description; rubric; max_iterations }

Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.

interface BetaManagedAgentsUserInterruptEvent { type: "user.interrupt"; id; processed_at; session_thread_id }

An interrupt event that pauses agent execution and returns control to the user.

type: "user.interrupt"
id: string

Unique identifier for this event.

processed_at?: string | null

Timestamp when the interrupt was processed.

formatdate-time
session_thread_id?: string | null

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.

interface BetaManagedAgentsUserInterruptEventParams { type: "user.interrupt"; session_thread_id }

Parameters for sending an interrupt to pause the agent.

type: "user.interrupt"
session_thread_id?: string | null

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.

interface BetaManagedAgentsUserMessageEvent { type: "user.message"; id; content; processed_at }

A user message event in the session conversation.

interface BetaManagedAgentsUserMessageEventParams { type: "user.message"; content }

Parameters for sending a user message to the session.

interface BetaManagedAgentsUserToolConfirmationEvent { type: "user.tool_confirmation"; id; result; /* 4 more */ }

A tool confirmation event that approves or denies a pending tool execution.

type: "user.tool_confirmation"
id: string

Unique identifier for this event.

result: "allow" | "deny"

The confirmation result: 'allow' or 'deny'.

One of the following:
"allow"
"deny"
tool_use_id: string

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 stop_reason.event_ids field.

deny_message?: string | null

Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'.

maxLength10000
processed_at?: string | null

Timestamp when the confirmation was processed.

formatdate-time
session_thread_id?: string | null

Set by the server to the subagent thread this confirmation was routed to. Omitted when it was routed to the primary thread.

interface BetaManagedAgentsUserToolConfirmationEventParams { type: "user.tool_confirmation"; result; tool_use_id; deny_message }

Parameters for confirming or denying a tool execution request.

type: "user.tool_confirmation"
result: "allow" | "deny"

The confirmation result: 'allow' or 'deny'.

One of the following:
"allow"
"deny"
tool_use_id: string

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 stop_reason.event_ids field.

minLength1
maxLength128
deny_message?: string | null

Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'.

maxLength10000
interface BetaManagedAgentsUserToolResultEventParams { type: "user.tool_result"; tool_use_id; content; is_error }

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.

interface BetaManagedAgentsWorkflowRunCreatedEvent { type: "workflow_run.created"; id; description; /* 4 more */ }

A workflow run was created. A workflow run is background work that the session's agent starts. Emitted once per run, before the run's other workflow_run.* events.

Why a workflow run did not finish, or was not created. More types may be added. On workflow_run.status_ended, for a type you do not recognize, rely on the event's result.type.

One of the following:
interface BetaManagedAgentsWorkflowRunErrorEvent { type: "workflow_run.error"; id; error; /* 2 more */ }

A workflow run met an error, or an error kept a run from being created. A run that ends with a result.type of error emits this event before its workflow_run.status_ended, with the same error.

type: "workflow_run.error"
id: string

Unique identifier for this event.

Why the run did not finish, or was not created.

One of the following:
processed_at: string

Timestamp when this event was processed.

formatdate-time
workflow_run_id: string | null

Identifier of the run that met the error, or null when the error kept a run from being created.

interface BetaManagedAgentsWorkflowRunPhase { id; description; name }

A phase that a workflow run's plan declares.

id: string

Unique identifier for the phase.

description: string | null

Description that the agent gave the phase, passed on as written, or null if it gave none.

name: string

Name that the agent gave the phase, passed on as written.

interface BetaManagedAgentsWorkflowRunPhaseEndedEvent { type: "workflow_run.phase_ended"; id; phase_started_id; /* 3 more */ }

A workflow run's plan left a phase, or the run's end closed it. Emitted once for every workflow_run.phase_started event, before the run's workflow_run.status_ended event. The event does not say whether the plan finished the phase's work, or why it left.

type: "workflow_run.phase_ended"
id: string

Unique identifier for this event.

phase_started_id: string

Identifier of the workflow_run.phase_started event that opened the phase.

processed_at: string

Timestamp when this event was processed.

formatdate-time
workflow_run_id: string

Identifier of the run. The same value is on all of the run's workflow_run.* events.

workflow_run_phase_id: string

Identifier of the phase, as in phases on the run's workflow_run.created event.

interface BetaManagedAgentsWorkflowRunPhaseStartedEvent { type: "workflow_run.phase_started"; id; processed_at; /* 2 more */ }

A workflow run's plan entered a phase.

type: "workflow_run.phase_started"
id: string

Unique identifier for this event.

processed_at: string

Timestamp when this event was processed.

formatdate-time
workflow_run_id: string

Identifier of the run. The same value is on all of the run's workflow_run.* events.

workflow_run_phase_id: string

Identifier of the phase, as in phases on the run's workflow_run.created event.

One of the following:
interface BetaManagedAgentsWorkflowRunResultCompleted { type: "completed" }

The run's plan, a program that the agent wrote, finished. This does not say whether the work succeeded.

type: "completed"
interface BetaManagedAgentsWorkflowRunResultError { type: "error"; error }

The run failed or reached its time limit.

type: "error"

Why the run did not finish.

One of the following:
interface BetaManagedAgentsWorkflowRunResultStopped { type: "stopped" }

The agent stopped the run.

type: "stopped"
interface BetaManagedAgentsWorkflowRunResultCompleted { type: "completed" }

The run's plan, a program that the agent wrote, finished. This does not say whether the work succeeded.

type: "completed"
interface BetaManagedAgentsWorkflowRunResultError { type: "error"; error }

The run failed or reached its time limit.

type: "error"

Why the run did not finish.

One of the following:
interface BetaManagedAgentsWorkflowRunResultStopped { type: "stopped" }

The agent stopped the run.

type: "stopped"
interface BetaManagedAgentsWorkflowRunStatusEndedEvent { type: "workflow_run.status_ended"; id; processed_at; /* 2 more */ }

A workflow run ended. Emitted once per run, as the last of the run's workflow_run.* events.

interface BetaManagedAgentsWorkflowRunStatusIdleEvent { type: "workflow_run.status_idle"; id; processed_at; workflow_run_id }

A workflow run is idle. Emitted each time the run goes idle, whatever the cause. If the run ends while idle, no workflow_run.status_running comes between this event and its workflow_run.status_ended.

type: "workflow_run.status_idle"
id: string

Unique identifier for this event.

processed_at: string

Timestamp when this event was processed.

formatdate-time
workflow_run_id: string

Identifier of the run. The same value is on all of the run's workflow_run.* events.

interface BetaManagedAgentsWorkflowRunStatusRunningEvent { type: "workflow_run.status_running"; id; processed_at; workflow_run_id }

A workflow run is running. Emitted when the run starts to execute, and each time it resumes after being idle. A run that starts idle emits workflow_run.status_idle first.

type: "workflow_run.status_running"
id: string

Unique identifier for this event.

processed_at: string

Timestamp when this event was processed.

formatdate-time
workflow_run_id: string

Identifier of the run. The same value is on all of the run's workflow_run.* events.