API v1
Agents
Agent Conversations

Conversation Run State

Cheap snapshot of the conversation's run / queue / steer state.

get/v1/agents/{agent_id}/conversations/{conversation_id}/run-state

Request

  • Base URL
    https://api.xpander.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header x-api-key

Path parameters

agent_idstring required
conversation_idstring required

Response

Successful Response

conversation_idstring required
is_runningboolean
is_steerableboolean
steer_target'none' | 'gateway' | 'child' | 'process'

Where a steer would land right now (run-state / accept responses).

Distinct from GatewaySteerTarget, which records where a steer WAS delivered after the fact (router | child | next_turn).

active_child_idstring nullable
queue_depthinteger
steer_depthinteger
execution_statusstring nullable
conversation_statestring
process_statestring nullable

Changes

No recorded changes to this operation across all 4 revisions of this API.