Claude Platform Docs

工作階段

建立工作階段
BetaManagedAgentsSession beta().sessions().create(params, requestOptions = RequestOptions.none())
POST/v1/sessions
列出工作階段
SessionListPage beta().sessions().list(params = SessionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions
取得工作階段
BetaManagedAgentsSession beta().sessions().retrieve(params = SessionRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}
更新工作階段
BetaManagedAgentsSession beta().sessions().update(params = SessionUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}
刪除工作階段
BetaManagedAgentsDeletedSession beta().sessions().delete(params = SessionDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/sessions/{session_id}
封存工作階段
BetaManagedAgentsSession beta().sessions().archive(params = SessionArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/archive
Models
class BetaManagedAgentsAdvisorParams { type; 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.

Type type
String model

A Claude model id. The model must be permitted as an advisor for this agent's model.

minLength1
maxLength256
class BetaManagedAgentsAgentMessagePreview { type; id; }
Type type
String id

The id the buffered agent.message will carry if it is emitted. Matches the event_id on this preview's event_delta events.

class BetaManagedAgentsAgentParams { type; id; version; }

Specification for an Agent. Provide a specific version or use the short-form agent="agent_id" for the most recent version

Type type
String id

The agent ID.

minLength1
maxLength128
Optional<Long> version

The specific agent version to use. Omit to use the latest version. Must be at least 1 if specified.

formatint32
class BetaManagedAgentsAgentThinkingPreview { type; id; }
Type type
String id

The id the buffered agent.thinking will carry if it is emitted. Start-only — no event_delta events follow.

class BetaManagedAgentsAgentWithOverridesParams { type; id; mcpServers; /* 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.

class BetaManagedAgentsBranchCheckout { type; name; }
Type type
String name

Branch name to check out.

minLength1
maxLength255
class BetaManagedAgentsBudgetLimit { type; maxListCost; }

A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches max_list_cost.

Type type
BetaMonetaryAmount maxListCost

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.

String amount

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.

BetaCurrency currency

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.

class BetaManagedAgentsCacheCreationUsage { ephemeral1hInputTokens; ephemeral5mInputTokens; }

Prompt-cache creation token usage broken down by cache lifetime.

Optional<Long> ephemeral1hInputTokens

Tokens used to create 1-hour ephemeral cache entries.

formatint32
Optional<Long> ephemeral5mInputTokens

Tokens used to create 5-minute ephemeral cache entries.

formatint32
class BetaManagedAgentsCommitCheckout { type; sha; }
Type type
String sha

Full commit SHA to check out.

minLength7
maxLength64
class BetaManagedAgentsDeletedSession { type; id; }

Confirmation that a session has been permanently deleted.

Type type
String id
class BetaManagedAgentsDeltaContent { type; content; index; }
Type type
BetaManagedAgentsTextBlock 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.

Type type
String text

The text content.

minLength1
Optional<Long> index

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.

class BetaManagedAgentsDeltaEvent { type; delta; eventId; }

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.

Type type
BetaManagedAgentsDeltaContent delta

One fragment of the previewed event. The delta type is named for the previewed event's field it streams into: agent.message events stream content_delta fragments, each a partial element of the content array.

Type type
BetaManagedAgentsTextBlock 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.

Type type
String text

The text content.

minLength1
Optional<Long> index

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.

String eventId

The id of the event being previewed. Matches event.id on the corresponding event_start and the buffered event that reconciles the preview.

enum BetaManagedAgentsDeltaType
AGENT_MESSAGE("agent.message")
AGENT_THINKING("agent.thinking")
class BetaManagedAgentsFileResourceParams { type; fileId; mountPath; }

Mount a file uploaded via the Files API into the session.

Type type
String fileId

ID of a previously uploaded file.

minLength1
maxLength128
Optional<String> mountPath

Mount path in the container. Defaults to /mnt/session/uploads/<file_id>.

minLength1
maxLength4096
class BetaManagedAgentsGitHubRepositoryResourceParams { type; url; authorizationToken; /* 2 more */ }

Mount a GitHub repository into the session's container.

class BetaManagedAgentsMemoryStoreResourceParam { type; memoryStoreId; access; instructions; }

Parameters for attaching a memory store to an agent session.

Type type
String memoryStoreId

The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

Optional<Access> access

Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem.

One of the following:
READ_WRITE("read_write")
READ_ONLY("read_only")
Optional<String> instructions

Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.

maxLength4096
class BetaManagedAgentsMultiagent: union

Resolved multiagent orchestration configuration as returned in API responses.

class BetaManagedAgentsMultiagentParams: union

Multiagent orchestration configuration.

class BetaManagedAgentsMultiagentCoordinatorParams { type; agents; }

A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the agents roster.

class BetaManagedAgentsMultiagent20261001Params { 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.

class BetaManagedAgentsMultiagentRosterEntryParams: union

An entry in a multiagent roster: an agent ID string, a versioned agent reference, or self.

String
class BetaManagedAgentsAgentParams { type; id; version; }

Specification for an Agent. Provide a specific version or use the short-form agent="agent_id" for the most recent version

Type type
String id

The agent ID.

minLength1
maxLength128
Optional<Long> version

The specific agent version to use. Omit to use the latest version. Must be at least 1 if specified.

formatint32
class BetaManagedAgentsMultiagentSelfParams { type; }

Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference.

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

Type type
String model

A Claude model id. The model must be permitted as an advisor for this agent's model.

minLength1
maxLength256
class BetaManagedAgentsOutcomeEvaluationResource { type; completedAt; description; /* 4 more */ }

Evaluation state for a single outcome defined via a define_outcome event.

Type type
Optional<LocalDateTime> completedAt

When the outcome reached a terminal result. Null while pending/running/evaluating.

formatdate-time
String description

What the agent should produce.

Optional<String> explanation

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.

long iteration

0-indexed revision cycle the outcome is currently on.

formatint32
String outcomeId

Server-generated outc_ ID for this outcome.

String result

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.

class BetaManagedAgentsServerToolUsage { webFetchRequests; webSearchRequests; }

Cumulative count of server-executed tool invocations, broken down by tool.

Optional<Long> webFetchRequests

Number of server-executed web fetch requests.

formatint32
Optional<Long> webSearchRequests

Number of server-executed web search requests.

formatint32
class BetaManagedAgentsSession { type; id; agent; /* 14 more */ }

A Managed Agents session.

class BetaManagedAgentsSessionAgent { type; id; description; /* 9 more */ }

Resolved agent definition for a session. Snapshot of the agent at session creation time.

class BetaManagedAgentsSessionAgentUpdate { mcpServers; 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.

class BetaManagedAgentsSessionMultiagent: union

Resolved multiagent orchestration configuration as returned on a session.

class BetaManagedAgentsSessionMultiagentCoordinator { type; agents; }

Resolved coordinator topology with full agent definitions for each roster member.

Type type
List<Agent> agents

Full agent definitions the coordinator may spawn as session threads.

One of the following:
class BetaManagedAgentsSessionThreadAgent { type; id; description; /* 8 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.

class BetaManagedAgentsAdvisor { type; model; }

Platform advisor roster entry: a model the session's primary thread may consult mid-turn.

Type type
String model

The advisor model id.

class BetaManagedAgentsSessionMultiagent20261001 { type = "multiagent_20261001"; advisor; subagents; workflows; }

Resolved multiagent configuration with three members, as copied to the session at creation.

class BetaManagedAgentsSessionMultiagentCoordinator { type; agents; }

Resolved coordinator topology with full agent definitions for each roster member.

Type type
List<Agent> agents

Full agent definitions the coordinator may spawn as session threads.

One of the following:
class BetaManagedAgentsSessionThreadAgent { type; id; description; /* 8 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.

class BetaManagedAgentsAdvisor { type; model; }

Platform advisor roster entry: a model the session's primary thread may consult mid-turn.

Type type
String model

The advisor model id.

class BetaManagedAgentsSessionMultiagentSubagents: union

Whether the agent can spawn session threads.

class BetaManagedAgentsSessionMultiagentSubagentsEnabled { type = "enabled"; inlineAgents; predefinedAgents; }

The agent can spawn session threads.

class BetaManagedAgentsMultiagentSubagentsDisabled { type = "disabled"; }

The agent cannot spawn session threads.

JsonValue type = "disabled"
class BetaManagedAgentsSessionMultiagentSubagentsEnabled { type = "enabled"; inlineAgents; predefinedAgents; }

The agent can spawn session threads.

class BetaManagedAgentsSessionMultiagentWorkflows: union

Whether the agent can start workflow runs.

class BetaManagedAgentsSessionMultiagentWorkflowsEnabled { type = "enabled"; inlineAgents; predefinedAgents; }

The agent can start workflow runs.

class BetaManagedAgentsMultiagentWorkflowsDisabled { type = "disabled"; }

The agent cannot start workflow runs.

JsonValue type = "disabled"
class BetaManagedAgentsSessionMultiagentWorkflowsEnabled { type = "enabled"; inlineAgents; predefinedAgents; }

The agent can start workflow runs.

class BetaManagedAgentsSessionMultiagent20261001 { type = "multiagent_20261001"; advisor; subagents; workflows; }

Resolved multiagent configuration with three members, as copied to the session at creation.

class BetaManagedAgentsSessionStats { activeSeconds; durationSeconds; }

Timing statistics for a session.

Optional<Double> activeSeconds

Cumulative time in seconds the session spent in running status. Excludes idle time.

formatdouble
Optional<Double> durationSeconds

Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update.

formatdouble
class BetaManagedAgentsSessionUpdatedEvent { type; id; processedAt; /* 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.

class BetaManagedAgentsSessionUsage { activeSeconds; cacheCreation; cacheReadInputTokens; /* 4 more */ }

Cumulative token usage for a session across all turns.

class BetaManagedAgentsSessionUsageEvent { type; id; processedAt; /* 2 more */ }

Periodic snapshot of the session's cumulative usage and tracked list cost.

Type type
String id

Unique identifier for this event.

LocalDateTime processedAt

Timestamp when the snapshot was taken.

formatdate-time
BetaManagedAgentsSessionUsageSnapshot usage

The session's cumulative usage at the snapshot time.

Optional<BetaManagedAgentsBudgetLimit> budget

The session's configured budget at the snapshot time, or null when the session has no budget.

Type type
BetaMonetaryAmount maxListCost

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.

String amount

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.

BetaCurrency currency

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.

class BetaManagedAgentsStartEvent { type; 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.

Type type
BetaManagedAgentsStartEventPreview event

The previewed event's type and id. The event type determines which delta types the preview's event_delta events carry: agent.message events stream content_delta fragments; agent.thinking previews are start-only — no deltas follow, and the buffered agent.thinking with the same id concludes them.

One of the following:
class BetaManagedAgentsAgentMessagePreview { type; id; }
Type type
String id

The id the buffered agent.message will carry if it is emitted. Matches the event_id on this preview's event_delta events.

class BetaManagedAgentsAgentThinkingPreview { type; id; }
Type type
String id

The id the buffered agent.thinking will carry if it is emitted. Start-only — no event_delta events follow.

class BetaManagedAgentsStartEventPreview: union
class BetaManagedAgentsAgentMessagePreview { type; id; }
Type type
String id

The id the buffered agent.message will carry if it is emitted. Matches the event_id on this preview's event_delta events.

class BetaManagedAgentsAgentThinkingPreview { type; id; }
Type type
String id

The id the buffered agent.thinking will carry if it is emitted. Start-only — no event_delta events follow.

class BetaManagedAgentsSystemContentBlock { type; text; }

Content block in a mid-conversation system message. Text-only.

Type type
String text

The text content.

minLength1
class BetaManagedAgentsSystemMessageEvent { type; id; content; processedAt; }

A mid-conversation system message event. Carries system-role content that is appended to the session as a role: "system" turn.

Type type
String id

Unique identifier for this event.

List<BetaManagedAgentsSystemContentBlock> content

System content blocks. Text-only.

Type type
String text

The text content.

minLength1
Optional<LocalDateTime> processedAt

Timestamp when this system message was processed.

formatdate-time
class BetaManagedAgentsUserToolResultEvent { type; id; toolUseId; /* 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.

工作階段事件

列出事件
EventListPage beta().sessions().events().list(params = EventListParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/events
傳送事件
BetaManagedAgentsSendSessionEvents beta().sessions().events().send(params, requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/events
串流事件
StreamResponse<BetaManagedAgentsStreamSessionEvents> beta().sessions().events().streamStreaming(params = EventStreamParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/events/stream

工作階段資源

新增工作階段資源
BetaManagedAgentsFileResource beta().sessions().resources().add(params, requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/resources
列出工作階段資源
ResourceListPage beta().sessions().resources().list(params = ResourceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/resources
取得工作階段資源
ResourceRetrieveResponse beta().sessions().resources().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/resources/{resource_id}
更新工作階段資源
ResourceUpdateResponse beta().sessions().resources().update(params, requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/resources/{resource_id}
刪除工作階段資源
BetaManagedAgentsDeleteSessionResource beta().sessions().resources().delete(params, requestOptions = RequestOptions.none())
DELETE/v1/sessions/{session_id}/resources/{resource_id}

工作階段執行緒

列出工作階段執行緒
ThreadListPage beta().sessions().threads().list(params = ThreadListParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads
取得工作階段執行緒
BetaManagedAgentsSessionThread beta().sessions().threads().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads/{thread_id}
封存工作階段執行緒
BetaManagedAgentsSessionThread beta().sessions().threads().archive(params, requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

工作階段執行緒事件

列出工作階段執行緒事件
EventListPage beta().sessions().threads().events().list(params, requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads/{thread_id}/events
串流工作階段執行緒事件
StreamResponse<BetaManagedAgentsStreamSessionThreadEvents> beta().sessions().threads().events().streamStreaming(params, requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads/{thread_id}/stream