API referenceAgents APISession event typesFrom the sessionstatus.changed

status.changed

⚠️
Preview — this feature is being built; the design below is the spec.

Received on the stream and in the event list. The session’s status changed.

Example

id: evt_01JC7M3B
data: {"type": "status.changed", "status": "requires_action", "outcome": null}

Fields

FieldMeaning
statusrunning, requires_action, idle or archived.
outcomeSet when the agent recorded an outcome, such as resolved.

Handling

Drive your UI state from this event: show a spinner on running, prompt for input on requires_action.

Was this page helpful?