APIAPI Reference
Conversations
/conversations
List conversations for the organization
Authorization
apiKeyAuth AuthorizationBearer <token>
Backend API key for server-to-server calls. Format: sk_live_... or sk_test_...
In: header
Query Parameters
status?string
Value in
"pending" | "in_progress" | "completed" | "abandoned" | "archived"agent_id?string
Format
uuidlimit?integer
Default
20Range
1 <= value <= 100after?string
before?string
Response Body
application/json
curl -X GET "http://localhost:3002/v1/backend/conversations"{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"connection_code": "string",
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"status": "pending",
"started_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"turn_count": 0,
"participant_profile": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "string",
"first_name": "string",
"last_name": "string",
"organization_name": "string",
"organization_domain": "string",
"avatar_image_url": "string"
}
}
],
"pagination": {
"has_more": true,
"next_cursor": "string",
"prev_cursor": "string"
}
}/conversations/{id}
Get a single conversation by ID
Authorization
apiKeyAuth AuthorizationBearer <token>
Backend API key for server-to-server calls. Format: sk_live_... or sk_test_...
In: header
Path Parameters
id*string
Format
uuidResponse Body
application/json
application/json
curl -X GET "http://localhost:3002/v1/backend/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"connection_code": "string",
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"status": "pending",
"started_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"turn_count": 0,
"participant_profile": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "string",
"first_name": "string",
"last_name": "string",
"organization_name": "string",
"organization_domain": "string",
"avatar_image_url": "string"
},
"session_properties": {
"property1": null,
"property2": null
},
"path_taken": [
null
]
}
}{
"error": {
"code": "string",
"message": "string"
}
}/conversations/{id}/transcript
Get the transcript for a conversation
Authorization
apiKeyAuth AuthorizationBearer <token>
Backend API key for server-to-server calls. Format: sk_live_... or sk_test_...
In: header
Path Parameters
id*string
Format
uuidResponse Body
application/json
application/json
curl -X GET "http://localhost:3002/v1/backend/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08/transcript"{
"data": {
"conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",
"messages": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"role": "user",
"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"modality": "voice"
}
]
}
}{
"error": {
"code": "string",
"message": "string"
}
}