Skip to navigation

Get conversation turn

Alpha

Get the status and output of a turn. The status comes from the stored transcript, so a turn that failed after the agent started can show as completed. Only the stream_ended event has the real outcome. This endpoint is in alpha and may change.

Path parameters

conversation_idstringRequired
The Conversation ID
turn_idstringRequiredformat: "^[1-9][0-9]*$"<=20 characters
The Turn ID

Headers

xi-api-keystringOptional

Response

Successful Response
turn_idstring
statusenum
Allowed values:
outputlist of objectsOptional
errorobject or nullOptional
required_actionslist of objectsOptional

The actions the agent waits on. Answer each client_tool_call with a client_tool_result item in input to continue.

stream_cursorstring or nullOptional

Resume token for this turn’s event stream. Present while the turn is in progress; pass it as Last-Event-ID to stream the turn’s events.

Errors

422
Unprocessable Entity Error