Events
api/beta/sessions/events
History
api/beta/sessions/events Changed · +45 / -3 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"`
- `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `data: optional array of BetaManagedAgentsSessionEvent`
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"`
- `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Body parameters - `events: array of BetaManagedAgentsEventParams`
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"`
- `"mid-conversation-tool-changes-2026-07-01"` + - `"compact-2026-01-12"` + + - `"computer-use-2025-11-24"` + + - `"mcp-tunnels-2026-06-22"` + + - `"structured-outputs-2025-11-13"` + + - `"task-budgets-2026-03-13"` + + - `"thinking-display-updates-2026-08-18"` + + - `"ce-user-management-2026-07-13"` + ### Returns - `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 34 more`
- `result: string` - Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - - - `type: "span.outcome_evaluation_end"` - - - `usage: BetaManagedAgentsSpanModelUsage` - - Token usage for a single model request. - - - `cache_creation_input_tokens: number` - - Tokens used to create prompt cache in this request. - - format: int32 - - - `cache_read_input_tokens: number` - - Tokens read from prompt cache in this request. - - format: int32 - - - `input_tokens: number` - - Input tokens consumed by this request. - - format: int32 - - - `output_tokens: number` - - Output tokens generated by this request. - - form + Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the s
api/beta/sessions/events Changed · +2194 / -2579 lines
### Path parameters ### Query parameters ### Headers #### Response (200) ### Path parameters ### Headers ### Body parameters #### Response (200) ### Path parameters ### Query parameters ### Headers #### Response (200) ## Domain types ### Path Parameters ### Query Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters ### Body Parameters #### Response ### Path Parameters ### Query Parameters ### Header Parameters #### Response ## Domain Types
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
api/beta/sessions/events Changed · +4805 / -3965 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
api/beta/sessions/events Changed · +9 / -3 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
- `type: "credential_host_unreachable_error"` - - `"credential_host_unreachable_error"` - - - `vault_id: string` - - ID of the vault containing the affected credential. - - - `pr + - `"credential_host_unreachable_err
api/beta/sessions/events First recorded · 13925 lines, first recorded
# Events ## List Events ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Send Events ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Stream Events ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Agent Custom Tool Use Event ### Beta Managed Agents Agent MCP Tool Result Event ### Beta Managed Agents Agent MCP Tool Use Event ### Beta Managed Agents Agent Message Event ### Beta Managed Agents Agent Thinking Event ### Beta Managed Agents Agent Thread Context Compacted Event ### Beta Managed Agents Agent Thread Message Received Event ### Beta Managed Agents Agent Thread Message Sent Event ### Beta Managed Agents Agent Tool Result Event ### Beta Managed Agents Agent Tool Use Event ### Beta Managed Agents Base64 Document Source ### Beta Managed Agents Base64 Image Source ### Beta Managed Agents Billing Error ### Beta Managed Agents Credential Host Unreachable Error ### Beta Managed Agents Document Block ### Beta Managed Agents Event Params ### Beta Managed Agents File Document Source ### Beta Managed Agents File Image Source ### Beta Managed Agents File Rubric ### Beta Managed Agents File Rubric Params ### Beta Managed Agents Image Block ### Beta Managed Agents MCP Authentication Failed Error ### Beta Managed Agents MCP Connection Failed Error ### Beta Managed Agents Model Overloaded Error ### Beta Managed Agents Model Rate Limited Error ### Beta Managed Agents Model Request Failed Error ### Beta Managed Agents Plain Text Document Source ### Beta Managed Agents Redacted Block ### Beta Managed Agents Retry Status Exhausted ### Beta Managed Agents Retry Status Retrying ### Beta Managed Agents Retry Status Terminal ### Beta Managed Agents Search Result Block ### Beta Managed Agents Search Result Citations ### Beta Managed Agents Search Result Content ### Beta Managed Agents Send Session Events ### Beta Managed Agents Session Budget Reached ### Beta Managed Agents Session Deleted Event ### Beta Managed Agents Session End Turn ### Beta Managed Agents Session Error Event ### Beta Managed Agents Session Event ### Beta Managed Agents Session Requires Action ### Beta Managed Agents Session Retries Exhausted ### Beta Managed Agents Session Status Idle Event ### Beta Managed Agents Session Status Rescheduled Event ### Beta Managed Agents Session Status Running Event ### Beta Managed Agents Session Status Terminated Event ### Beta Managed Agents Session Thread Created Event ### Beta Managed Agents Session Thread Status Idle Event ### Beta Managed Agents Session Thread Status Rescheduled Event ### Beta Managed Agents Session Thread Status Running Event ### Beta Managed Agents Session Thread Status Terminated Event ### Beta Managed Agents Session Usage Snapshot ### Beta Managed Agents Span Model Request End Event ### Beta Managed Agents Span Model Request Start Event ### Beta Managed Agents Span Model Usage ### Beta Managed Agents Span Outcome Evaluation End Event ### Beta Managed Agents Span Outcome Evaluation Ongoing Event ### Beta Managed Agents Span Outcome Evaluation Start Event ### Beta Managed Agents Stream Session Events ### Beta Managed Agents System Message Event Params ### Beta Managed Agents Text Block ### Beta Managed Agents Text Rubric ### Beta Managed Agents Text Rubric Params ### Beta Managed Agents Unknown Error ### Beta Managed Agents URL Document Source ### Beta Managed Agents URL Image Source ### Beta Managed Agents User Custom Tool Result Event ### Beta Managed Agents User Custom Tool Result Event Params ### Beta Managed Agents User Define Outcome Event ### Beta Managed Agents User Define Outcome Event Params ### Beta Managed Agents User Interrupt Event ### Beta Managed Agents User Interrupt Event Params ### Beta Managed Agents User Message Event ### Beta Managed Agents User Message Event Params ### Beta Managed Agents User Tool Confirmation Event ### Beta Managed Agents User Tool Confirmation Event Params ### Beta Managed Agents User Tool Result Event Params
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
The first capture of this source. The page was already there, and this is what it said.
---
title: Events
url: https://platform.claude.com/docs/en/api/beta/sessions/events
---
# Events
## List Events
**get** `/v1/sessions/{session_id}/events`
List Events
### Path Parameters
- `session_id: string`
### Query Parameters
- `"created_at[gt]": optional string`
Return events created after this time (exclusive). Compared against the event's `processed_at` value.
- `"created_at[gte]": optional string`
Return events created at or after this time (inclusive). Compared against the event's `processed_at` value.
- `"created_at[lt]": optional string`
Return events created before this time (exclusive). Compared against the event's `processed_at` value.
- `"created_at[lte]": optional string`
Return events created at or before this time (inclusive). Compared against the event's `processed_at` value.
- `limit: optional number`
Query parameter for limit
- `order: optional "asc" or "desc"`
Sort direction for results, ordered by the event's `processed_at`. Defaults to asc (chronological).
- `"asc"`
- `"desc"`
- `page: optional string`
Opaque pagination cursor from a previous response's next_page.
- `types: optional array of string`
Filter by event type. Values match the `type` field on returned events (for example, `user.message` or `agent.tool_use`). Omit to return all event types.
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `data: optional array of BetaManagedAgentsSessionEvent`
Events for the session, ordered by `processed_at`.
- `BetaManagedAgentsUserMessageEvent object { id, content, type, processed_at }`
A user message event in the session conversation.
- `id: string`
Unique identifier for this event.
- `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`
Array of content blocks comprising the user message.
- `BetaManagedAgentsTextBlock object { text, type }`
Regular text content.
- `text: string`
The text content.
- `type: "text"`
- `"text"`
- `BetaManagedAgentsImageBlock object { source, type }`
Image content specified directly as base64 data or as a reference via a URL.
- `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
Union type for image source variants.
- `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`
Base64-encoded image data.
- `data: string`
Base64-encoded image data.
- `media_type: string`
MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsURLImageSource object { type, url }`
Image referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the image to fetch.
- `BetaManagedAgentsFileImageSource object { file_id, type }`
Image referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "image"`
- `"image"`
- `BetaManagedAgentsDocumentBlock object { source, type, context, title }`
Document content, either specified directly as base64 data, as text, or as a reference via a URL.
- `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
Union type for document source variants.
- `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`
Base64-encoded document data.
- `data: string`
Base64-encoded document data.
- `media_type: string`
MIME type of the document (e.g., "application/pdf").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`
Plain text document content.
- `data: string`
The plain text content.
- `media_type: "text/plain"`
MIME type of the text content. Must be "text/plain".
- `"text/plain"`
- `type: "text"`
- `"text"`
- `BetaManagedAgentsURLDocumentSource object { type, url }`
Document referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the document to fetch.
- `BetaManagedAgentsFileDocumentSource object { file_id, type }`
Document referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "document"`
- `"document"`
- `context: optional string or null`
Additional context about the document for the model.
- `title: optional string or null`
The title of the document.
- `BetaManagedAgentsRedactedBlock object { type }`
Placeholder for content withheld by Anthropic model policy.
- `type: "redacted"`
- `"redacted"`
- `type: "user.message"`
Cut at 300 lines.