Skip to main content

KnownSessionEvent

claude_api::managed_agents::events

Enum KnownSessionEvent

#[non_exhaustive]pub enum KnownSessionEvent {
Show 29 variants
    AgentMessage(AgentMessageEvent),
    AgentThinking(AgentThinkingEvent),
    AgentToolUse(AgentToolUseEvent),
    AgentToolResult(AgentToolResultEvent),
    AgentMcpToolUse(AgentMcpToolUseEvent),
    AgentMcpToolResult(AgentMcpToolResultEvent),
    AgentCustomToolUse(AgentCustomToolUseEvent),
    AgentThreadContextCompacted(EventEnvelope),
    AgentThreadMessageSent(AgentThreadMessageSentEvent),
    AgentThreadMessageReceived(AgentThreadMessageReceivedEvent),
    SessionStatusRunning(EventEnvelope),
    SessionStatusIdle(SessionStatusIdleEvent),
    SessionStatusRescheduled(EventEnvelope),
    SessionStatusTerminated(EventEnvelope),
    SessionDeleted(EventEnvelope),
    SessionError(SessionErrorEvent),
    SessionOutcomeEvaluated(EventEnvelope),
    SessionThreadCreated(SessionThreadCreatedEvent),
    SessionThreadIdle(EventEnvelope),
    SpanModelRequestStart(EventEnvelope),
    SpanModelRequestEnd(SpanModelRequestEndEvent),
    SpanOutcomeEvaluationStart(EventEnvelope),
    SpanOutcomeEvaluationOngoing(EventEnvelope),
    SpanOutcomeEvaluationEnd(EventEnvelope),
    UserMessage(UserMessageEvent),
    UserInterrupt(EventEnvelope),
    UserCustomToolResult(UserCustomToolResultEvent),
    UserToolConfirmation(UserToolConfirmationEvent),
    UserDefineOutcome(UserDefineOutcomeEvent),
}

Available on crate feature managed-agents-preview only.

Expand description

All event variants this SDK version recognizes.

Common envelope fields (id, processed_at) are present on most events; we capture them as optional fields when the server includes them and let new fields land in Other via the parent enum.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AgentMessage(AgentMessageEvent)

Agent response containing text content blocks.

AgentThinking(AgentThinkingEvent)

Agent thinking content, emitted separately from messages.

AgentToolUse(AgentToolUseEvent)

Agent invokes a pre-built agent tool (bash, file ops, etc.).

AgentToolResult(AgentToolResultEvent)

Result of a pre-built agent tool execution.

AgentMcpToolUse(AgentMcpToolUseEvent)

Agent invokes an MCP server tool.

AgentMcpToolResult(AgentMcpToolResultEvent)

Result of an MCP tool execution.

AgentCustomToolUse(AgentCustomToolUseEvent)

Agent invokes one of your custom tools. Respond with an OutgoingUserEvent::CustomToolResult.

AgentThreadContextCompacted(EventEnvelope)

Conversation history was compacted.

AgentThreadMessageSent(AgentThreadMessageSentEvent)

Agent sent a message to another multi-agent thread.

AgentThreadMessageReceived(AgentThreadMessageReceivedEvent)

Agent received a message from another multi-agent thread.

SessionStatusRunning(EventEnvelope)

Session is now actively processing.

SessionStatusIdle(SessionStatusIdleEvent)

Session finished its current task and is waiting for input.

SessionStatusRescheduled(EventEnvelope)

Transient error; session is auto-retrying.

SessionStatusTerminated(EventEnvelope)

Session ended due to an unrecoverable error.

SessionDeleted(EventEnvelope)

Session was deleted; emitted as the final event before the session disappears from listings.

SessionError(SessionErrorEvent)

An error occurred during processing.

SessionOutcomeEvaluated(EventEnvelope)

An outcome evaluation reached a terminal status.

SessionThreadCreated(SessionThreadCreatedEvent)

Coordinator spawned a new multi-agent thread.

SessionThreadIdle(EventEnvelope)

A multi-agent thread finished its current work.

SpanModelRequestStart(EventEnvelope)

A model inference call has started.

SpanModelRequestEnd(SpanModelRequestEndEvent)

A model inference call has completed.

SpanOutcomeEvaluationStart(EventEnvelope)

Outcome evaluation has started.

SpanOutcomeEvaluationOngoing(EventEnvelope)

Heartbeat during an ongoing outcome evaluation.

SpanOutcomeEvaluationEnd(EventEnvelope)

Outcome evaluation has completed.

UserMessage(UserMessageEvent)

User-authored text message.

UserInterrupt(EventEnvelope)

User-issued interrupt (no body beyond envelope).

UserCustomToolResult(UserCustomToolResultEvent)

Result of a custom tool the user executed locally.

UserToolConfirmation(UserToolConfirmationEvent)

Allow / deny a pending agent or MCP tool call.

UserDefineOutcome(UserDefineOutcomeEvent)

Define an outcome for the agent to work toward.

Trait Implementations§

impl Clone for KnownSessionEvent

fn clone(&self) -> KnownSessionEvent

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for KnownSessionEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for KnownSessionEvent

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for KnownSessionEvent

fn eq(&self, other: &KnownSessionEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for KnownSessionEvent

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for KnownSessionEvent

Auto Trait Implementations§

impl Freeze for KnownSessionEvent

impl RefUnwindSafe for KnownSessionEvent

impl Send for KnownSessionEvent

impl Sync for KnownSessionEvent

impl Unpin for KnownSessionEvent

impl UnsafeUnpin for KnownSessionEvent

impl UnwindSafe for KnownSessionEvent

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,