API ReferenceConversations

Get conversation

GET
/api/v1/console/agents/{agentId}/conversations/{conversationId}

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Team API key (prefix sk_). Use Authorization: Bearer or X-Api-Key: .

In: header

Path Parameters

agentId*string
conversationId*string

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/console/agents/string/conversations/string"
{  "message": "Success",  "data": {    "id": "string",    "channel_type": "string",    "channel_id": "string",    "is_test_channel": true,    "full_name": "string",    "email": "string",    "phone_number": "string",    "channel_username": "string",    "is_ai_chat_paused": true,    "last_message_at": "2019-08-24T14:15:22Z",    "last_message_preview": "string",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}
{  "message": "Resource not found",  "error": "Not Found",  "code": "not_found",  "statusCode": 404,  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"}

Update workflow (owned only)

Previous Page

Issue SSE stream ticket

Exchange the API key for a short-lived (~60s), single-use ticket, then open the live message stream at GET .../messages/stream?ticket=<ticket>. Required because EventSource cannot send Authorization headers. The ticket is bound to this agent + conversation and consumed on first use. Requires the conversations:read scope.