How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Anthropic Sessions API

Stateful agent execution instances

Anthropic Sessions API is one of 43 APIs that Anthropic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sessions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 23 operations across 14 paths, and defines 217 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.anthropic.com.

23 operations 14 paths 217 schemas 3 DELETE11 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.anthropic.com/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Anthropic Sessions API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth).

Paths & Operations 23

Across 14 paths, the API surfaces 23 operations — 3 DELETE, 11 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Sessions 23
POST
/v1/sessions/{session_id}/archive?beta=true
Archive Session
BetaArchiveSession 3 params → 200400401403404408409412
GET
/v1/sessions/{session_id}/events/stream?beta=true
Stream Events
BetaStreamSessionEvents 5 params → 200400401403404408409412
GET
/v1/sessions/{session_id}/events?beta=true
List Events
BetaListEvents 12 params → 200400401403404408409412
POST
/v1/sessions/{session_id}/events?beta=true
Send Events
BetaSendEvents 3 params body → 200400401403404408409412
GET
/v1/sessions/{session_id}/resources/{resource_id}?beta=true
Get Session Resource
BetaGetResource 5 params → 200400401403404408409412
DELETE
/v1/sessions/{session_id}/resources/{resource_id}?beta=true
Delete Session Resource
BetaDeleteResource 5 params → 200400401403404408409412
POST
/v1/sessions/{session_id}/resources/{resource_id}?beta=true
Update Session Resource
BetaUpdateResource 4 params body → 200400401403404408409412
GET
/v1/sessions/{session_id}/resources?beta=true
List Session Resources
BetaListResources 6 params → 200400401403404408409412
POST
/v1/sessions/{session_id}/resources?beta=true
Add Session Resource
BetaAddResource 3 params body → 200400401403404408409412
POST
/v1/sessions/{session_id}/threads/{thread_id}/archive?beta=true
Archive Session Thread
BetaArchiveSessionThread 4 params → 200400401403404408409412
GET
/v1/sessions/{session_id}/threads/{thread_id}/events?beta=true
List Session Thread Events
BetaListSessionThreadEvents 7 params → 200400401403404408409412
GET
/v1/sessions/{session_id}/threads/{thread_id}/stream?beta=true
Stream Session Thread Events
BetaStreamSessionThreadEvents 6 params → 200400401403404408409412
GET
/v1/sessions/{session_id}/threads/{thread_id}?beta=true
Get Session Thread
BetaGetSessionThread 5 params → 200400401403404408409412
GET
/v1/sessions/{session_id}/threads?beta=true
List Session Threads
BetaListSessionThreads 6 params → 200400401403404408409412
GET
/v1/sessions/{session_id}?beta=true
Get Session
BetaGetSession 4 params → 200400401403404408409412
POST
/v1/sessions/{session_id}?beta=true
Update Session
BetaUpdateSession 3 params body → 200400401403404408409412
DELETE
/v1/sessions/{session_id}?beta=true
Delete Session
BetaDeleteSession 4 params → 200400401403404408409412
POST
/v1/sessions
Anthropic Create Session
createSession 2 params body → 200
GET
/v1/sessions
Anthropic List Sessions
listSessions 4 params → 200
GET
/v1/sessions/{session_id}
Anthropic Get Session
getSession 3 params → 200
POST
/v1/sessions/{session_id}
Anthropic Update Session
updateSession 3 params body → 200
DELETE
/v1/sessions/{session_id}
Anthropic Delete Session
deleteSession 3 params → 200
POST
/v1/sessions/{session_id}/archive
Anthropic Archive Session
archiveSession 3 params → 200

Schemas 217

The contract defines 217 schemas that model the data the API accepts and returns. The most detailed are BetaManagedAgentsSession (17 properties), BetaManagedAgentsSessionAgent (11 properties), BetaManagedAgentsSessionThread (11 properties), BetaManagedAgentsSessionThreadAgent (10 properties). Each schema is shown below with its type and property counts.

BetaManagedAgentsMCPToolsetParams
object
Configuration for tools from an MCP server defined in mcpservers.
4 properties 2 required
BetaManagedAgentsAgentToolResultEvent
object
Event representing the result of an agent tool execution.
6 properties 4 required
BetaManagedAgentsUserDefineOutcomeEvent
object
Echo of a user.defineoutcome input event. Carries the server-generated outcomeid that subsequent span.outcomeevaluation events reference.
7 properties 7 required
BetaManagedAgentsModelRateLimitedError
object
The model request was rate-limited.
3 properties 3 required
BetaManagedAgentsSessionStatusRescheduledEvent
object
Indicates the session is recovering from an error state and is rescheduled for execution.
3 properties 3 required
BetaManagedAgentsSessionErrorEvent
object
An error event indicating a problem occurred during session execution.
4 properties 4 required
BetaManagedAgentsSessionUsage
object
Cumulative token usage for a session across all turns.
7 properties
BetaManagedAgentsMCPToolConfig
object
Resolved configuration for a specific MCP tool.
3 properties 3 required
BetaManagedAgentsAgentMcpToolResultEvent
object
Event representing the result of an MCP tool execution.
6 properties 4 required
BetaManagedAgentsUserToolConfirmationEvent
object
A tool confirmation event that approves or denies a pending tool execution.
7 properties 4 required
BetaManagedAgentsUserMessageEventParams
object
Parameters for sending a user message to the session.
2 properties 2 required
BetaManagedAgentsMCPToolsetDefaultConfig
object
Resolved default configuration for all tools from an MCP server.
2 properties 2 required
BetaManagedAgentsRubric
Rubric for grading the quality of an outcome.
BetaManagedAgentsDocumentBlock
object
Document content, either specified directly as base64 data, as text, or as a reference via a URL.
4 properties 2 required
BetaManagedAgentsUserToolResultEvent
object
Event sent by the client providing the result of an agent-toolset tool execution. Only valid on selfhosted environments, where sandbox-routed tools are execute…
7 properties 3 required
BetaManagedAgentsEventStartEvent_AgentThinkingPreview
object
2 properties 2 required
BetaManagedAgentsEffortHigh
object
High effort. Favors reasoning depth.
1 property 1 required
BetaManagedAgentsCredentialHostUnreachableError
object
An environmentvariable credential's auth.networking.allowedhosts includes a host the environment's network policy does not permit.
5 properties 5 required
BetaManagedAgentsCustomToolParams
object
A custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an agent.customtooluse event is emitted and the session…
4 properties 4 required
BetaManagedAgentsURLImageSource
object
Image referenced by URL.
2 properties 2 required
BetaManagedAgentsBudget
object
An enforced spend ceiling on a session. Discriminated on type; limit is the only kind currently supported.
BetaManagedAgentsAgentToolset20260401Params
object
Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent.
3 properties 1 required
BetaManagedAgentsWriteToolConfig
object
Configuration for the write tool.
4 properties 4 required
BetaManagedAgentsSessionRetriesExhausted
object
The turn ended because repeated errors exhausted the retry budget or an error escalated to retrystatus: 'exhausted'.
1 property 1 required
BetaManagedAgentsModelConfig
object
Model identifier and configuration.
4 properties 1 required
BetaManagedAgentsListSessionThreads
object
Paginated list of threads within a session.
2 properties
BetaManagedAgentsCacheCreationUsage
object
Prompt-cache creation token usage broken down by cache lifetime.
2 properties
BetaManagedAgentsEventDeltaType
string
EventDeltaType enum
BetaManagedAgentsUpdateSessionResourceParams
object
Request parameters for updating a session resource.
1 property 1 required
BetaManagedAgentsPermissionPolicy
object
Permission policy for tool execution.
BetaManagedAgentsEventDeltaEvent
object
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 == eventid is produc…
3 properties 3 required
BetaManagedAgentsSearchResultContent
object
Text content within a search result.
2 properties 2 required
BetaManagedAgentsUserToolConfirmationResult
string
UserToolConfirmationResult enum
BetaManagedAgentsSystemMessageEvent
object
A mid-conversation system message event. Carries system-role content that is appended to the session as a role: "system" turn.
4 properties 3 required
BetaManagedAgentsMcpConnectionFailedError
object
Failed to connect to an MCP server.
4 properties 4 required
BetaManagedAgentsFileDocumentSource
object
Document referenced by file ID.
2 properties 2 required
BetaManagedAgentsAgentToolConfigUnion
object
Configuration for a specific agent tool.
BetaManagedAgentsSpanOutcomeEvaluationEndEvent
object
Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of needsrevision means another evaluation cycle fo…
9 properties 9 required
BetaManagedAgentsFileRubricParams
object
Rubric referenced by a file uploaded via the Files API.
2 properties 2 required
BetaManagedAgentsSessionBudgetReached
object
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…
1 property 1 required
BetaManagedAgentsAddSessionResourceParams
object
Request parameters for adding a resource to a session.
BetaManagedAgentsCustomSkill
object
A resolved user-created custom skill.
3 properties 3 required
BetaManagedAgentsGlobToolConfig
object
Configuration for the glob tool.
4 properties 4 required
BetaManagedAgentsSpanOutcomeEvaluationStartEvent
object
Emitted when an outcome evaluation cycle begins.
5 properties 5 required
BetaManagedAgentsUserContentBlock
object
Content block in a user message. Can be text, image, or document.
BetaManagedAgentsRetryStatus
object
What the client should do next in response to this error.
BetaManagedAgentsMCPToolConfigParams
object
Configuration override for a specific MCP tool.
3 properties 1 required
BetaManagedAgentsReadToolConfigParams
object
Configuration override for the read tool.
4 properties 1 required
BetaManagedAgentsAgentMcpToolUseEvent
object
Event emitted when the agent invokes a tool provided by an MCP server.
8 properties 6 required
BetaManagedAgentsToolResultContentBlock
object
Content block in a tool result. Can be text, image, document, or searchresult.
BetaGatewayTimeoutError
object
2 properties 2 required
BetaManagedAgentsAddSessionResource
object
The added session resource.
BetaManagedAgentsAgentToolsetDefaultConfigParams
object
Default configuration for all tools in a toolset.
2 properties
BetaManagedAgentsUserCustomToolResultEvent
object
Event sent by the client providing the result of a custom tool execution.
7 properties 3 required
BetaManagedAgentsGrepToolConfig
object
Configuration for the grep tool.
4 properties 4 required
BetaManagedAgentsSessionThreadAgent
object
Resolved agent definition for a single sessionthread. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from S…
10 properties 10 required
BetaManagedAgentsModel
The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
BetaManagedAgentsWebFetchToolConfigParams
object
Configuration override for the webfetch tool.
7 properties 1 required
BetaManagedAgentsSessionStats
object
Timing statistics for a session.
2 properties
BetaManagedAgentsAnthropicSkill
object
A resolved Anthropic-managed skill.
3 properties 3 required
BetaManagedAgentsCustomToolInputSchema
object
JSON Schema for custom tool input parameters.
3 properties 1 required
BetaManagedAgentsSessionAgent
object
Resolved agent definition for a session. Snapshot of the agent at session creation time.
11 properties 11 required
BetaManagedAgentsDeleteSessionResource
object
Confirmation of resource deletion.
2 properties 2 required
BetaManagedAgentsAgentToolset20260401
object
3 properties 3 required
BetaManagedAgentsMcpAuthenticationFailedError
object
Authentication to an MCP server failed.
4 properties 4 required
BetaManagedAgentsEffortXhigh
object
Extra-high effort. Not all models accept this level.
1 property 1 required
BetaManagedAgentsBranchCheckout
object
2 properties 2 required
BetaManagedAgentsAgentThreadMessageSentEvent
object
Observability event emitted to the sender's output stream when an agent-to-agent message is sent.
6 properties 5 required
BetaManagedAgentsGrepToolConfigParams
object
Configuration override for the grep tool.
4 properties 1 required
BetaManagedAgentsModelOverloadedError
object
The model is currently overloaded. Emitted after automatic retries are exhausted.
3 properties 3 required
BetaManagedAgentsBase64DocumentSource
object
Base64-encoded document data.
3 properties 3 required
BetaManagedAgentsSessionDeletedEvent
object
Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session.
3 properties 3 required
BetaManagedAgentsAgentToolParams
object
Union type for tool configurations in the tools array.
BetaManagedAgentsSessionMultiagentCoordinator
object
Resolved coordinator topology with full agent definitions for each roster member.
2 properties 2 required
BetaManagedAgentsMCPServer
object
Union type for MCP server connection definitions returned in API responses.
BetaManagedAgentsRetryStatusExhausted
object
This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.
1 property 1 required
BetaManagedAgentsAgentToolConfigUnionParams
object
Configuration override for a specific tool within a toolset.
BetaManagedAgentsSessionThreadStatusTerminatedEvent
object
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.
5 properties 5 required
BetaManagedAgentsSessionThreadStatusRunningEvent
object
A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads.
5 properties 5 required
BetaManagedAgentsAgentMessageEvent
object
An agent response event in the session conversation.
4 properties 4 required
BetaManagedAgentsUserCustomToolResultEventParams
object
Parameters for providing the result of a custom tool execution.
4 properties 2 required
BetaManagedAgentsSessionThreadStats
object
Timing statistics for a session thread.
3 properties
BetaManagedAgentsSessionMultiagent
Resolved multiagent orchestration configuration as returned on a session.
BetaManagedAgentsFileResourceParams
object
Mount a file uploaded via the Files API into the session.
3 properties 2 required
BetaManagedAgentsBashToolConfigParams
object
Configuration override for the bash tool.
4 properties 1 required
BetaManagedAgentsMCPServerParams
object
Union type for MCP server connection definitions.
BetaManagedAgentsSessionAgentUpdate
object
Mid-session agent configuration update. Only tools and mcpservers are updatable. Full replacement: the provided array becomes the new value. To preserve existi…
2 properties
BetaAPIError
object
2 properties 2 required
BetaManagedAgentsUpdateSessionParams
object
Request parameters for updating a session. Omit a field to preserve its current value.
5 properties
BetaManagedAgentsListSessionResources
object
Paginated list of resources attached to a session.
2 properties 1 required
BetaManagedAgentsUpdateSessionResource
object
The updated session resource.
BetaManagedAgentsWebSearchToolConfigParams
object
Configuration override for the websearch tool.
7 properties 1 required
BetaManagedAgentsUserToolConfirmationEventParams
object
Parameters for confirming or denying a tool execution request.
4 properties 3 required
BetaManagedAgentsSessionThreadStatusRescheduledEvent
object
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 threa…
5 properties 5 required
BetaManagedAgentsAgentCustomToolUseEvent
object
Event emitted when the agent calls a custom tool. The session goes idle until the client sends a user.customtoolresult event with the result.
6 properties 5 required
BetaManagedAgentsSessionStatusIdleEvent
object
Indicates the agent has paused and is awaiting user input.
4 properties 4 required
BetaManagedAgentsWriteToolConfigParams
object
Configuration override for the write tool.
4 properties 1 required
BetaRateLimitError
object
2 properties 2 required
BetaManagedAgentsEventStartEvent_AgentMessagePreview
object
2 properties 2 required
BetaManagedAgentsOutcomeEvaluationResource
object
Evaluation state for a single outcome defined via a defineoutcome event.
7 properties 7 required
BetaManagedAgentsServerToolUsage
object
Cumulative count of server-executed tool invocations, broken down by tool.
2 properties
BetaManagedAgentsMCPServerURLDefinition
object
URL-based MCP server connection as returned in API responses.
3 properties 3 required
BetaManagedAgentsSessionStatusRunningEvent
object
Indicates the session is actively running and the agent is working.
3 properties 3 required
BetaManagedAgentsUserLocation
object
Approximate user location for search result localization.
5 properties 1 required
BetaManagedAgentsRetryStatusTerminal
object
The session encountered a terminal error and will transition to terminated state.
1 property 1 required
BetaManagedAgentsURLDocumentSource
object
Document referenced by URL.
2 properties 2 required
BetaManagedAgentsSystemMessageEventParams
object
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…
2 properties 2 required
BetaManagedAgentsAgentToolUseEvent
object
Event emitted when the agent invokes a built-in agent tool.
7 properties 5 required
BetaManagedAgentsSpanModelRequestEndEvent
object
Emitted when a model request completes.
6 properties 6 required
BetaManagedAgentsInputEvent
object
Union type for events that can be sent to a session.
BetaManagedAgentsModelRequestFailedError
object
A model request failed for a reason other than overload or rate-limiting.
3 properties 3 required
BetaManagedAgentsStreamSessionThreadEvents
object
Server-sent event in a single thread's stream.
BetaManagedAgentsCommitCheckout
object
2 properties 2 required
BetaManagedAgentsPlainTextDocumentSource
object
Plain text document content.
3 properties 3 required
BetaManagedAgentsReadToolConfig
object
Configuration for the read tool.
4 properties 4 required
BetaManagedAgentsDeletedSession
object
Confirmation that a session has been permanently deleted.
2 properties 2 required
BetaManagedAgentsMemoryStoreResource
object
A memory store attached to an agent session.
7 properties 2 required
BetaManagedAgentsSpeed
string
Inference speed mode. fast provides significantly faster output token generation at premium pricing. Not all models support fast; invalid combinations are reje…
BetaManagedAgentsMCPToolset
object
4 properties 4 required
BetaManagedAgentsSessionThreadCreatedEvent
object
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.
5 properties 5 required
BetaManagedAgentsGetSessionResource
object
The requested session resource.
BetaInvalidRequestError
object
2 properties 2 required
BetaManagedAgentsRubricParams
Rubric for grading the quality of an outcome.
BetaManagedAgentsUnknownError
object
An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on retrystatus an…
3 properties 3 required
BetaManagedAgentsWebSearchToolConfig
object
Configuration for the websearch tool.
7 properties 4 required
BetaManagedAgentsSessionUsageSnapshot
object
Point-in-time snapshot of a session's cumulative usage.
7 properties
BetaManagedAgentsSessionUpdatedEvent
object
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 conf…
7 properties 3 required
BetaManagedAgentsStreamSessionEvents
object
Server-sent event in the session stream.
BetaManagedAgentsAgentTool
object
Union type for tool configurations returned in API responses.
BetaManagedAgentsEffortMedium
object
Medium effort. Balances latency and reasoning depth.
1 property 1 required
BetaManagedAgentsEffortLow
object
Low effort. Favors latency over reasoning depth.
1 property 1 required
BetaManagedAgentsSessionEvent
object
Union type for all event types in a session.
BetaManagedAgentsSessionStatusTerminatedEvent
object
Indicates the session has terminated, either due to an error or completion.
3 properties 3 required
BetaManagedAgentsAgentThreadMessageReceivedEvent
object
Delivery event written to the target thread's input stream when an agent-to-agent message arrives.
6 properties 5 required
BetaManagedAgentsGlobToolConfigParams
object
Configuration override for the glob tool.
4 properties 1 required
BetaManagedAgentsTextRubricParams
object
Rubric content provided inline as text.
2 properties 2 required
BetaManagedAgentsRedactedBlock
object
Placeholder for content withheld by Anthropic model policy.
1 property 1 required
BetaManagedAgentsSessionThreadAgentEntry
The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot.
BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent
object
Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between…
5 properties 5 required
BetaManagedAgentsUserDefineOutcomeEventParams
object
Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.
4 properties 3 required
BetaCurrency
string
BetaManagedAgentsBudgetLimit
object
A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches maxlistcost.
2 properties 2 required
BetaManagedAgentsSessionThread
object
An execution thread within a session. Each session has one primary thread plus zero or more child threads spawned by the coordinator.
11 properties 11 required
BetaManagedAgentsURLMCPServerParams
object
URL-based MCP server connection.
3 properties 3 required
BetaManagedAgentsSendSessionEventsParams
object
Request parameters for sending events to a session.
1 property 1 required
BetaManagedAgentsGitHubRepositoryResource
object
7 properties 6 required
BetaManagedAgentsSessionThreadStatusIdleEvent
object
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.
6 properties 6 required
BetaManagedAgentsImageBlock
object
Image content specified directly as base64 data or as a reference via a URL.
2 properties 2 required
BetaTimestamp
string
A timestamp in RFC 3339 format
BetaOverloadedError
object
2 properties 2 required
BetaBillingError
object
2 properties 2 required
BetaManagedAgentsFileResource
object
6 properties 6 required
BetaManagedAgentsEditToolConfig
object
Configuration for the edit tool.
4 properties 4 required
BetaManagedAgentsSystemContentBlock
object
Content block in a mid-conversation system message. Text-only.
BetaManagedAgentsEffortMax
object
Maximum effort. Favors reasoning depth over latency.
1 property 1 required
BetaManagedAgentsRepositoryCheckout
object
BetaManagedAgentsSpanModelRequestStartEvent
object
Emitted when a model request is initiated by the agent.
3 properties 3 required
BetaManagedAgentsEditToolConfigParams
object
Configuration override for the edit tool.
4 properties 1 required
BetaManagedAgentsAlwaysAskPolicy
object
Tool calls require user confirmation before execution.
1 property 1 required
BetaManagedAgentsFileRubric
object
Rubric referenced by a file uploaded via the Files API.
2 properties 2 required
BetaManagedAgentsListSessionEvents
object
Paginated list of events for a session.
2 properties
BetaManagedAgentsSessionRosterEntry
A session-resolved multiagent roster entry.
BetaManagedAgentsAgentEvaluatedPermission
string
AgentEvaluatedPermission enum
BetaManagedAgentsUserMessageEvent
object
A user message event in the session conversation.
4 properties 3 required
BetaAuthenticationError
object
2 properties 2 required
BetaManagedAgentsTextBlock
object
Regular text content.
2 properties 2 required
BetaNotFoundError
object
2 properties 2 required
BetaManagedAgentsStruct
object
BetaManagedAgentsSpanModelUsage
object
Token usage for a single model request.
5 properties 4 required
BetaManagedAgentsEventDeltaEvent_Delta
object
BetaManagedAgentsAgentMessageContentBlock
object
Content block in an agent message.
BetaManagedAgentsSessionUsageEvent
object
Periodic snapshot of the session's cumulative usage and tracked list cost.
5 properties 4 required
BetaManagedAgentsAdvisor
object
Platform advisor roster entry: a model the session's primary thread may consult mid-turn.
2 properties 2 required
BetaManagedAgentsAgentThreadContextCompactedEvent
object
Indicates that context compaction (summarization) occurred during the session.
3 properties 3 required
BetaManagedAgentsUserInterruptEventParams
object
Parameters for sending an interrupt to pause the agent.
2 properties 1 required
BetaManagedAgentsEventStartEvent
object
Opens a preview of a buffered event. Carries the previewed event's type and id only. Followed by zero or more eventdelta events with the same event id, normall…
2 properties 2 required
BetaManagedAgentsEffort
object
How hard Claude works on each turn. Sets outputconfig.effort on every Messages call the session makes.
BetaPermissionError
object
2 properties 2 required
BetaManagedAgentsTextRubric
object
Rubric content provided inline as text.
2 properties 2 required
BetaManagedAgentsAgentToolsetDefaultConfig
object
Resolved default configuration for agent tools.
2 properties 2 required
BetaManagedAgentsBashToolConfig
object
Configuration for the bash tool.
4 properties 4 required
BetaManagedAgentsSkill
Resolved skill as returned in API responses.
BetaManagedAgentsSessionEndTurn
object
The agent completed its turn naturally and is ready for the next user message.
1 property 1 required
BetaMonetaryAmount
object
A monetary amount in a specific currency.
2 properties 2 required
BetaManagedAgentsSendSessionEvents
object
Events that were successfully sent to the session.
1 property
BetaManagedAgentsUserInterruptEvent
object
An interrupt event that pauses agent execution and returns control to the user.
4 properties 2 required
BetaManagedAgentsAlwaysAllowPolicy
object
Tool calls are automatically approved without user confirmation.
1 property 1 required
BetaManagedAgentsFileImageSource
object
Image referenced by file ID.
2 properties 2 required
BetaManagedAgentsEventDeltaEvent_ContentDelta
object
3 properties 2 required
BetaManagedAgentsBillingError
object
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;…
3 properties 3 required
BetaManagedAgentsMCPToolsetDefaultConfigParams
object
Default configuration for all tools from an MCP server.
2 properties
BetaManagedAgentsSessionRequiresAction
object
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 sessio…
2 properties 2 required
BetaManagedAgentsListOrder
string
ListOrder enum
BetaManagedAgentsSessionResource
object
BetaManagedAgentsSearchResultCitations
object
Citation settings for a search result.
1 property 1 required
BetaManagedAgentsEventParams
object
Union type for event parameters that can be sent to a session.
BetaManagedAgentsMountMode
string
Access mode for an attached memory store.
BetaManagedAgentsImageSource
object
Union type for image source variants.
BetaManagedAgentsDocumentSource
object
Union type for document source variants.
BetaManagedAgentsCustomTool
object
A custom tool as returned in API responses.
4 properties 4 required
BetaErrorResponse
object
3 properties 3 required
BetaManagedAgentsListSessionThreadEvents
object
Paginated list of events for a single thread within a session.
2 properties
BetaManagedAgentsAgentThinkingEvent
object
Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier.
3 properties 3 required
BetaManagedAgentsRetryStatusRetrying
object
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.
1 property 1 required
BetaManagedAgentsSessionStatus
string
SessionStatus enum
BetaManagedAgentsWebFetchToolConfig
object
Configuration for the webfetch tool.
7 properties 4 required
BetaManagedAgentsSessionThreadUsage
object
Cumulative token usage for a session thread across all turns.
7 properties
BetaManagedAgentsBase64ImageSource
object
Base64-encoded image data.
3 properties 3 required
BetaManagedAgentsSession
object
A Managed Agents session.
17 properties 16 required
BetaManagedAgentsSearchResultBlock
object
A block containing a web search result.
5 properties 5 required
AnthropicBeta
BetaManagedAgentsSessionThreadStatus
string
SessionThreadStatus enum
BetaManagedAgentsUserToolResultEventParams
object
Parameters for providing the result of an agent-toolset tool execution. Only valid on selfhosted environments, where sandbox-routed tools are executed by the c…
4 properties 2 required
BetaManagedAgentsEventStartEvent_Event
object
SessionList
object
2 properties
Session
object
7 properties
CreateSessionRequest
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

anthropic-sessions-api-openapi.yml Raw ↑

Other APIs Anthropic publishes across the network.

Anthropic Messages API
Anthropic Models API
Anthropic Files API
Anthropic Skills API
Anthropic Agents API
Anthropic Api Keys API
Anthropic Cost API
Anthropic Environments API
Anthropic Events API
Anthropic Organization API
Anthropic Organization Invites API
Anthropic Organization Members API
Where this information came from

This is an independent, third-party profile of Anthropic Sessions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.