Skip to main content
The Conversations API gives you programmatic access to structured conversation records generated by PolyAI agents. It provides historical transcripts, turn-by-turn metadata, handoff details, and performance metrics.
Most customers should use v3, the current supported version with the most complete and reliable data.

​
API versions

v3 is the fully supported release of the Conversations API. It runs on PolyAI’s event-sourced data platform and offers:
  • real-time, highly reliable ingestion
  • consistent timestamp formatting
  • empty strings ("") instead of null for empty text fields
  • additional metadata fields such as latency, translated_user_input, and english_agent_response
Authentication for v3 is managed internally by PolyAI. Customers must request access through their PolyAI representative. Example base path: https://api.{region}.platform.polyai.app/v3/{account_id}/{project_id}/conversations

​
Regional base URLs

RegionBase URL
UShttps://api.us-1.platform.polyai.app
UKhttps://api.uk-1.platform.polyai.app
EUWhttps://api.euw-1.platform.polyai.app
Endpoint format: https://api.{region}.platform.polyai.app/{version}/{account_id}/{project_id}/conversations

​
Authentication

The Conversations API uses API key authentication.

​
v3

API keys for v3 are issued directly by PolyAI and configured internally for your organisation. Customers should request v3 access through their PolyAI representative.

​
Endpoints

The Conversations API includes endpoints for:
  • retrieving conversation records
  • accessing turn-by-turn transcripts
  • reviewing handoff details
  • querying concurrency limits
  • configuring dynamic number insertion (DNI) reservations
  • receiving webhook updates in real time
Endpoint specifics vary between v1 and v3 and are documented in their respective sections.

​
Example: Retrieve a conversation (v3)

GET https://api.{region}.platform.polyai.app/v3/{account_id}/{project_id}/conversations/{conversation_id} Response includes:
  • full transcript with consistent timestamps
  • latency metrics
  • translation fields (when enabled)
  • agent and user turns
  • handoff metadata (if present)