Overview
The Conversations API provides endpoints for managing and retrieving conversation data from AI agents.Authentication
All conversation endpoints require authentication using a Bearer token:Get Conversations
Retrieve a paginated list of conversations for an organization.Endpoint
Query Parameters
Response Structure
The response includes a list of conversations with pagination metadata:-
conversations: Array of conversation objects containing:
- id, summary, duration_seconds, agent_name, agent_config_id
- created_at, status, end_user_email, end_user_identifier
- provider_conversation_id, processing_type, type
- rating, feedback, isAdmin
-
pagination: Object containing:
- page, limit, total, hasMore
Example Request
Get Conversation by ID
Retrieve detailed information about a specific conversation.Endpoint
Path Parameters
Response Structure
The response includes detailed conversation information:- Conversation fields: id, audio_url, agent_config_id, end_user_id
- Analysis data: provider_conversation_id, analysis object, conversation_duration_secs
- Status fields: status, processing_type, type
- Timestamps: created_at, updated_at
- Feedback: rating, feedback, isAdmin
- Related data: agent_config (id, name, description), end_user (id, email, identifier)
Example Request
Date Filtering
The start_date and end_date parameters filter conversations based on their created_at timestamp:- start_date: Returns conversations created on or after this date
- end_date: Returns conversations created on or before this date