Updated August 12, 2026

On this page

Frozen dataclasses for every transport event kind -- Text, ToolUse, StepFinish, ApiRetry, Result, SessionSuspended, RateLimit, UnknownEvent, etc. -- and the TransportEvent union.

#transport.src.orxtra.transport._events

#`transport.src.orxtra.transport._events`

#`ContentBlock`

ContentBlock
Field	Type	Default
`type`	`str`
`text`	`str	None`	`None`
`tool_use_id`	`str	None`	`None`
`tool_name`	`str	None`	`None`
`tool_input`	`dict[str, Any]	None`	`None`

#`Usage`

Usage
Field	Type	Default
`input_tokens`	`int`	`0`
`output_tokens`	`int`	`0`
`reasoning_tokens`	`int`	`0`
`cache_read_tokens`	`int`	`0`
`cache_write_tokens`	`int`	`0`

#`StepStart`

StepStart
Field	Type	Default
`session_id`	`str`

#`Text`

Text
Field	Type	Default
`text`	`str`

#`StreamDelta`

StreamDelta
Field	Type	Default
`text`	`str`

#`Thinking`

Thinking
Field	Type	Default
`text`	`str`

#`StreamToolUse`

A tool_use block assembled from streaming chunks.

#`StreamUsage`

Usage info extracted from a streaming message_delta.

#`ToolUse`

ToolUse
Field	Type	Default
`tool_use_id`	`str`
`tool_name`	`str`
`input`	`dict[str, Any]`
`output`	`str`
`status`	`str`
`error`	`str	None`	`None`
`duration_ms`	`int`	`0`
`typed_output`	`Any	None`	`None`

#`StepFinish`

StepFinish
Field	Type	Default
`reason`	`str`
`input_tokens`	`int`	`0`
`output_tokens`	`int`	`0`
`reasoning_tokens`	`int`	`0`
`cache_read_tokens`	`int`	`0`
`cache_write_tokens`	`int`	`0`

#`ApiRetry`

ApiRetry
Field	Type	Default
`attempt`	`int`
`max_retries`	`int`
`delay_ms`	`int`
`status_code`	`int`
`error`	`str`

#`Error`

Error
Field	Type	Default
`name`	`str`
`message`	`str`
`metadata`	`dict[str, Any]	None`	`None`

#`Result`

Result
Field	Type	Default
`text`	`str`
`session_id`	`str`
`total_input_tokens`	`int`	`0`
`total_output_tokens`	`int`	`0`
`total_reasoning_tokens`	`int`	`0`
`total_cache_read_tokens`	`int`	`0`
`total_cache_write_tokens`	`int`	`0`
`tool_calls`	`int`	`0`

#`SessionSuspended`

SessionSuspended
Field	Type	Default
`continuation`	`Continuation`
`session_id`	`str	None`

#`LivenessWarning`

Emitted when no SSE event has arrived within the health threshold.

#`StuckDetected`

Emitted when no SSE event has arrived within the stuck threshold.

#`UnknownEvent`

Emitted when a provider encounters an unrecognized content block or SSE event.

#`RateLimit`

Emitted before an ApiRetry when rate limit headers are present on a 429.

#`ToolExecuting`

Emitted immediately before a tool begins execution.

#`ContextWarning`

Emitted when a session's token usage approaches the model's context limit.

#transport.src.orxtra.transport._events

#transport.src.orxtra.transport._events

#ContentBlock

#Usage

#StepStart

#Text

#StreamDelta

#Thinking

#StreamToolUse

#StreamUsage

#ToolUse

#StepFinish

#ApiRetry

#Error

#Result

#SessionSuspended

#LivenessWarning

#StuckDetected

#UnknownEvent

#RateLimit

#ToolExecuting

#ContextWarning

#`transport.src.orxtra.transport._events`

#`ContentBlock`

#`Usage`

#`StepStart`

#`Text`

#`StreamDelta`

#`Thinking`

#`StreamToolUse`

#`StreamUsage`

#`ToolUse`

#`StepFinish`

#`ApiRetry`

#`Error`

#`Result`

#`SessionSuspended`

#`LivenessWarning`

#`StuckDetected`

#`UnknownEvent`

#`RateLimit`

#`ToolExecuting`

#`ContextWarning`