Claude Platform Docs

事件

列出事件
EventListPage Beta.Sessions.Events.List(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/events
发送事件
BetaManagedAgentsSendSessionEvents Beta.Sessions.Events.Send(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/events
流式传输事件
BetaManagedAgentsStreamSessionEvents Beta.Sessions.Events.StreamStreaming(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/events/stream
Models
class BetaManagedAgentsAgentAutoEvaluatedPermission: union

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.

class BetaManagedAgentsAgentAutoEvaluatedPermissionAllow { Type = "allow"; }

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

JsonElement Type = "allow"
class BetaManagedAgentsAgentAutoEvaluatedPermissionAsk { Type = "ask"; ReasonCode; }

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

JsonElement Type = "ask"
required string ReasonCode

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
class BetaManagedAgentsAgentAutoEvaluatedPermissionDeny { Type = "deny"; ReasonCode; }

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

JsonElement Type = "deny"
required string ReasonCode

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
class BetaManagedAgentsAgentAutoEvaluatedPermissionAllow { Type = "allow"; }

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

JsonElement Type = "allow"
class BetaManagedAgentsAgentAutoEvaluatedPermissionAsk { Type = "ask"; ReasonCode; }

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

JsonElement Type = "ask"
required string ReasonCode

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
class BetaManagedAgentsAgentAutoEvaluatedPermissionDeny { Type = "deny"; ReasonCode; }

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

JsonElement Type = "deny"
required string ReasonCode

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
class BetaManagedAgentsAgentCustomToolUseEvent { Type; 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.

required Type Type
required string ID

Unique identifier for this event.

required IReadOnlyDictionary<string, JsonElement> Input

Input parameters for the tool call.

required string Name

Name of the custom tool being called.

required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
string? SessionThreadID

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.

class BetaManagedAgentsAgentMcpToolResultEvent { Type; ID; McpToolUseID; /* 3 more */ }

Event representing the result of an MCP tool execution.

class BetaManagedAgentsAgentMcpToolUseEvent { Type; ID; Input; /* 6 more */ }

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

class BetaManagedAgentsAgentMessageEvent { Type; ID; Content; ProcessedAt; }

An agent response event in the session conversation.

required Type Type
required string ID

Unique identifier for this event.

required IReadOnlyList<Content> Content

Array of text blocks comprising the agent response.

One of the following:
class BetaManagedAgentsTextBlock { Type; Text; }

Regular text content.

required Type Type
required string Text

The text content.

minLength1
class BetaManagedAgentsRedactedBlock { Type; }

Placeholder for content withheld by Anthropic model policy.

required Type Type
required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
class BetaManagedAgentsAgentThinkingEvent { Type; ID; ProcessedAt; }

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

required Type Type
required string ID

Unique identifier for this event.

required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
class BetaManagedAgentsAgentThreadContextCompactedEvent { Type; ID; ProcessedAt; }

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

required Type Type
required string ID

Unique identifier for this event.

required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
class BetaManagedAgentsAgentThreadMessageReceivedEvent { Type; ID; Content; /* 3 more */ }

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

class BetaManagedAgentsAgentThreadMessageSentEvent { Type; ID; Content; /* 3 more */ }

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

class BetaManagedAgentsAgentToolEvaluation: union

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

class BetaManagedAgentsAgentToolEvaluationAlwaysAllow { Type = "always_allow"; }

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

JsonElement Type = "always_allow"
class BetaManagedAgentsAgentToolEvaluationAlwaysAsk { Type = "always_ask"; }

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

JsonElement Type = "always_ask"
class BetaManagedAgentsAgentToolEvaluationAuto { Type = "auto"; EvaluatedPermission; }

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

class BetaManagedAgentsAgentToolEvaluationAlwaysAllow { Type = "always_allow"; }

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

JsonElement Type = "always_allow"
class BetaManagedAgentsAgentToolEvaluationAlwaysAsk { Type = "always_ask"; }

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

JsonElement Type = "always_ask"
class BetaManagedAgentsAgentToolEvaluationAuto { Type = "auto"; EvaluatedPermission; }

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

class BetaManagedAgentsAgentToolResultEvent { Type; ID; ProcessedAt; /* 3 more */ }

Event representing the result of an agent tool execution.

class BetaManagedAgentsAgentToolUseEvent { Type; ID; Input; /* 5 more */ }

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

class BetaManagedAgentsBase64DocumentSource { Type; Data; MediaType; }

Base64-encoded document data.

required Type Type
required string Data

Base64-encoded document data.

minLength1
required string MediaType

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

minLength1
class BetaManagedAgentsBase64ImageSource { Type; Data; MediaType; }

Base64-encoded image data.

required Type Type
required string Data

Base64-encoded image data.

minLength1
required string MediaType

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

minLength1
class BetaManagedAgentsBillingError { Type; Message; RetryStatus; }

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.

required Type Type
required string Message

Human-readable error description.

required RetryStatus RetryStatus

What the client should do next in response to this error.

One of the following:
class BetaManagedAgentsRetryStatusRetrying { Type; }

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.

required Type Type
class BetaManagedAgentsRetryStatusExhausted { Type; }

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

required Type Type
class BetaManagedAgentsRetryStatusTerminal { Type; }

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

required Type Type
class BetaManagedAgentsCredentialHostUnreachableError { Type; CredentialID; Message; /* 2 more */ }

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

class BetaManagedAgentsDocumentBlock { Type; Source; Context; Title; }

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

class BetaManagedAgentsEventParams: union

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

class BetaManagedAgentsFileDocumentSource { Type; FileID; }

Document referenced by file ID.

required Type Type
required string FileID

ID of a previously uploaded file.

minLength1
class BetaManagedAgentsFileImageSource { Type; FileID; }

Image referenced by file ID.

required Type Type
required string FileID

ID of a previously uploaded file.

minLength1
class BetaManagedAgentsFileRubric { Type; FileID; }

Rubric referenced by a file uploaded via the Files API.

required Type Type
required string FileID

ID of the rubric file.

class BetaManagedAgentsFileRubricParams { Type; FileID; }

Rubric referenced by a file uploaded via the Files API.

required Type Type
required string FileID

ID of the rubric file.

class BetaManagedAgentsImageBlock { Type; Source; }

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

class BetaManagedAgentsMcpAuthenticationFailedError { Type; McpServerName; Message; RetryStatus; }

Authentication to an MCP server failed.

class BetaManagedAgentsMcpConnectionFailedError { Type; McpServerName; Message; RetryStatus; }

Failed to connect to an MCP server.

class BetaManagedAgentsModelOverloadedError { Type; Message; RetryStatus; }

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

required Type Type
required string Message

Human-readable error description.

required RetryStatus RetryStatus

What the client should do next in response to this error.

One of the following:
class BetaManagedAgentsRetryStatusRetrying { Type; }

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.

required Type Type
class BetaManagedAgentsRetryStatusExhausted { Type; }

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

required Type Type
class BetaManagedAgentsRetryStatusTerminal { Type; }

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

required Type Type
class BetaManagedAgentsModelRateLimitedError { Type; Message; RetryStatus; }

The model request was rate-limited.

required Type Type
required string Message

Human-readable error description.

required RetryStatus RetryStatus

What the client should do next in response to this error.

One of the following:
class BetaManagedAgentsRetryStatusRetrying { Type; }

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.

required Type Type
class BetaManagedAgentsRetryStatusExhausted { Type; }

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

required Type Type
class BetaManagedAgentsRetryStatusTerminal { Type; }

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

required Type Type
class BetaManagedAgentsModelRequestFailedError { Type; Message; RetryStatus; }

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

required Type Type
required string Message

Human-readable error description.

required RetryStatus RetryStatus

What the client should do next in response to this error.

One of the following:
class BetaManagedAgentsRetryStatusRetrying { Type; }

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.

required Type Type
class BetaManagedAgentsRetryStatusExhausted { Type; }

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

required Type Type
class BetaManagedAgentsRetryStatusTerminal { Type; }

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

required Type Type
class BetaManagedAgentsPlainTextDocumentSource { Type; Data; MediaType; }

Plain text document content.

required Type Type
required string Data

The plain text content.

minLength1
required MediaType MediaType

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

class BetaManagedAgentsRedactedBlock { Type; }

Placeholder for content withheld by Anthropic model policy.

required Type Type
class BetaManagedAgentsRetryStatusExhausted { Type; }

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

required Type Type
class BetaManagedAgentsRetryStatusRetrying { Type; }

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.

required Type Type
class BetaManagedAgentsRetryStatusTerminal { Type; }

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

required Type Type
class BetaManagedAgentsSearchResultBlock { Type; Citations; Content; /* 2 more */ }

A block containing a web search result.

required Type Type

Citation settings for a search result.

required bool Enabled

Whether citations are enabled for this search result.

required IReadOnlyList<BetaManagedAgentsSearchResultContent> Content

Array of text content blocks from the search result.

required Type Type
required string Text

The text content.

minLength1
required string Source

The URL source of the search result.

minLength1
required string Title

The title of the search result.

minLength1
class BetaManagedAgentsSearchResultCitations { Enabled; }

Citation settings for a search result.

required bool Enabled

Whether citations are enabled for this search result.

class BetaManagedAgentsSearchResultContent { Type; Text; }

Text content within a search result.

required Type Type
required string Text

The text content.

minLength1
class BetaManagedAgentsSendSessionEvents { Data; }

Events that were successfully sent to the session.

class BetaManagedAgentsSessionBudgetReached { Type; }

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.

required Type Type
class BetaManagedAgentsSessionDeletedEvent { Type; ID; ProcessedAt; }

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

required Type Type
required string ID

Unique identifier for this event.

required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
class BetaManagedAgentsSessionEndTurn { Type; }

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

required Type Type
class BetaManagedAgentsSessionErrorEvent { Type; ID; Error; ProcessedAt; }

An error event indicating a problem occurred during session execution.

class BetaManagedAgentsSessionEvent: union

Union type for all event types in a session.

class BetaManagedAgentsSessionRequiresAction { Type; EventIds; }

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.

required Type Type
required IReadOnlyList<string> EventIds

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

class BetaManagedAgentsSessionRetriesExhausted { Type; }

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

required Type Type
class BetaManagedAgentsSessionStatusIdleEvent { Type; ID; ProcessedAt; StopReason; }

Indicates the agent has paused and is awaiting user input.

class BetaManagedAgentsSessionStatusRescheduledEvent { Type; ID; ProcessedAt; }

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

required Type Type
required string ID

Unique identifier for this event.

required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
class BetaManagedAgentsSessionStatusRunningEvent { Type; ID; ProcessedAt; }

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

required Type Type
required string ID

Unique identifier for this event.

required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
class BetaManagedAgentsSessionStatusTerminatedEvent { Type; ID; ProcessedAt; }

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

required Type Type
required string ID

Unique identifier for this event.

required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
class BetaManagedAgentsSessionThreadCreatedEvent { Type; ID; AgentName; /* 2 more */ }

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.

required Type Type
required string ID

Unique identifier for this event.

required string AgentName

Name of the callable agent the thread runs.

required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
required string SessionThreadID

Public sthr_ ID of the newly created thread.

class BetaManagedAgentsSessionThreadStatusIdleEvent { Type; ID; AgentName; /* 3 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.

class BetaManagedAgentsSessionThreadStatusRescheduledEvent { Type; ID; AgentName; /* 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.

required Type Type
required string ID

Unique identifier for this event.

required string AgentName

Name of the agent the thread runs.

required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
required string SessionThreadID

Public sthr_ ID of the thread that is retrying.

class BetaManagedAgentsSessionThreadStatusRunningEvent { Type; ID; AgentName; /* 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.

required Type Type
required string ID

Unique identifier for this event.

required string AgentName

Name of the agent the thread runs.

required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
required string SessionThreadID

Public sthr_ ID of the thread that started running.

class BetaManagedAgentsSessionThreadStatusTerminatedEvent { Type; ID; AgentName; /* 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.

required Type Type
required string ID

Unique identifier for this event.

required string AgentName

Name of the agent the thread runs.

required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
required string SessionThreadID

Public sthr_ ID of the thread that terminated.

class BetaManagedAgentsSessionUsageSnapshot { ActiveSeconds; CacheCreation; CacheReadInputTokens; /* 4 more */ }

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

class BetaManagedAgentsSpanModelRequestEndEvent { Type; ID; IsError; /* 3 more */ }

Emitted when a model request completes.

class BetaManagedAgentsSpanModelRequestStartEvent { Type; ID; ProcessedAt; }

Emitted when a model request is initiated by the agent.

required Type Type
required string ID

Unique identifier for this event.

required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
class BetaManagedAgentsSpanModelUsage { CacheCreationInputTokens; CacheReadInputTokens; InputTokens; /* 2 more */ }

Token usage for a single model request.

required int CacheCreationInputTokens

Tokens used to create prompt cache in this request.

formatint32
required int CacheReadInputTokens

Tokens read from prompt cache in this request.

formatint32
required int InputTokens

Input tokens consumed by this request.

formatint32
required int OutputTokens

Output tokens generated by this request.

formatint32
Speed? Speed

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.

One of the following:
Standard("standard")
Fast("fast")
class BetaManagedAgentsSpanOutcomeEvaluationEndEvent { Type; 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.

class BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent { Type; 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.

required Type Type
required string ID

Unique identifier for this event.

required int Iteration

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

formatint32
required string OutcomeID

The outc_ ID of the outcome being evaluated.

required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
class BetaManagedAgentsSpanOutcomeEvaluationStartEvent { Type; ID; Iteration; /* 2 more */ }

Emitted when an outcome evaluation cycle begins.

required Type Type
required string ID

Unique identifier for this event.

required int Iteration

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

formatint32
required string OutcomeID

The outc_ ID of the outcome being evaluated.

required DateTimeOffset ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
class BetaManagedAgentsStreamSessionEvents: union

Server-sent event in the session stream.

class BetaManagedAgentsSystemMessageEventParams { Type; 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.

required Type Type
required IReadOnlyList<BetaManagedAgentsSystemContentBlock> Content

System content blocks to append. Text-only.

required Type Type
required string Text

The text content.

minLength1
class BetaManagedAgentsTextBlock { Type; Text; }

Regular text content.

required Type Type
required string Text

The text content.

minLength1
class BetaManagedAgentsTextRubric { Type; Content; }

Rubric content provided inline as text.

required Type Type
required string Content

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

class BetaManagedAgentsTextRubricParams { Type; Content; }

Rubric content provided inline as text.

required Type Type
required string Content

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

maxLength262144
class BetaManagedAgentsUnknownError { Type; Message; RetryStatus; }

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.

required Type Type
required string Message

Human-readable error description.

required RetryStatus RetryStatus

What the client should do next in response to this error.

One of the following:
class BetaManagedAgentsRetryStatusRetrying { Type; }

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.

required Type Type
class BetaManagedAgentsRetryStatusExhausted { Type; }

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

required Type Type
class BetaManagedAgentsRetryStatusTerminal { Type; }

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

required Type Type
class BetaManagedAgentsUrlDocumentSource { Type; Url; }

Document referenced by URL.

required Type Type
required string Url

URL of the document to fetch.

minLength1
class BetaManagedAgentsUrlImageSource { Type; Url; }

Image referenced by URL.

required Type Type
required string Url

URL of the image to fetch.

minLength1
class BetaManagedAgentsUserCustomToolResultEvent { Type; ID; CustomToolUseID; /* 4 more */ }

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

class BetaManagedAgentsUserCustomToolResultEventParams { Type; CustomToolUseID; Content; IsError; }

Parameters for providing the result of a custom tool execution.

class BetaManagedAgentsUserDefineOutcomeEvent { Type; 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.

class BetaManagedAgentsUserDefineOutcomeEventParams { Type; Description; Rubric; MaxIterations; }

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

required Type Type
required string Description

What the agent should produce. This is the task specification.

required Rubric Rubric

Rubric for grading the quality of an outcome.

One of the following:
class BetaManagedAgentsFileRubricParams { Type; FileID; }

Rubric referenced by a file uploaded via the Files API.

required Type Type
required string FileID

ID of the rubric file.

class BetaManagedAgentsTextRubricParams { Type; Content; }

Rubric content provided inline as text.

required Type Type
required string Content

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

maxLength262144
int? MaxIterations

Eval→revision cycles before giving up. Default 3, max 20.

formatint32
class BetaManagedAgentsUserInterruptEvent { Type; ID; ProcessedAt; SessionThreadID; }

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

required Type Type
required string ID

Unique identifier for this event.

DateTimeOffset? ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
string? SessionThreadID

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.

class BetaManagedAgentsUserInterruptEventParams { Type; SessionThreadID; }

Parameters for sending an interrupt to pause the agent.

required Type Type
string? SessionThreadID

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.

class BetaManagedAgentsUserMessageEvent { Type; ID; Content; ProcessedAt; }

A user message event in the session conversation.

class BetaManagedAgentsUserMessageEventParams { Type; Content; }

Parameters for sending a user message to the session.

class BetaManagedAgentsUserToolConfirmationEvent { Type; ID; Result; /* 4 more */ }

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

required Type Type
required string ID

Unique identifier for this event.

required Result Result

UserToolConfirmationResult enum

One of the following:
Allow("allow")
Deny("deny")
required string ToolUseID

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.

string? DenyMessage

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

maxLength10000
DateTimeOffset? ProcessedAt

A timestamp in RFC 3339 format

formatdate-time
string? SessionThreadID

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

class BetaManagedAgentsUserToolConfirmationEventParams { Type; Result; ToolUseID; DenyMessage; }

Parameters for confirming or denying a tool execution request.

required Type Type
required Result Result

UserToolConfirmationResult enum

One of the following:
Allow("allow")
Deny("deny")
required string ToolUseID

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
string? DenyMessage

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

maxLength10000
class BetaManagedAgentsUserToolResultEventParams { Type; ToolUseID; Content; IsError; }

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.