Agents Platform

Get Conversation Turn

Changed on

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.

get/v1/convai/conversations/{conversation_id}/turns/{turn_id}

Request

Path parameters

conversation_idstring required

The Conversation ID

turn_idstring required

The Turn ID

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

turn_idstring required
status'in_progress' | 'completed' | 'requires_action' | 'failed' | 'timed_out' required
stream_cursorstring nullable

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.

Changes