Skip to main content

​
Overview

The Conversations API provides access to conversation data, transcripts, and metadata for your voice agents. This allows you to analyze interactions, review performance, and extract insights.

​
Key Features

  • Retrieve conversation transcripts
  • Filter conversations by agent, status, date, and more
  • Access conversation metadata
  • Pagination support with cursor-based navigation
  • Optional summary inclusion

​
Common Use Cases

List Conversations

Use the GET /conversations endpoint to retrieve conversations with advanced filtering options.

Get Conversation

Use the GET /conversations/{id} endpoint to retrieve detailed information about a specific conversation.

Filter by Agent

Filter conversations by agent ID to see all interactions for a specific agent.

Filter by Date

Use call_start_before_unix and call_start_after_unix to filter by time range.

Filter by Status

Filter conversations by success status using the call_successful parameter.

​
Conversation Properties

Conversations include the following key properties:
  • conversation_id: Unique conversation identifier
  • agent_id: Associated agent ID
  • agent_name: Name of the agent
  • status: Conversation status
  • transcript: Array of conversation transcript entries
  • metadata: Additional conversation metadata
  • created_at: Timestamp when conversation started

​
Filtering Options

The list conversations endpoint supports various filters:
  • agent_id: Filter by specific agent
  • call_successful: Filter by success status (success or failure)
  • call_start_before_unix: Conversations before Unix timestamp
  • call_start_after_unix: Conversations after Unix timestamp
  • user_id: Filter by user ID
  • summary_mode: Include or exclude summary (include or exclude)
  • page_size: Number of results per page (1-100, default: 30)
  • cursor: Pagination cursor for next page

​
Pagination

Conversations use cursor-based pagination:
  1. Make an initial request without a cursor
  2. Use the cursor from the response for the next page
  3. Continue until has_more is false
The cursor field in the response contains the pagination token for the next page of results.

​
Endpoints