Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.retellai.com/llms.txt

Use this file to discover all available pages before exploring further.

Legacy list endpoints are deprecated

The following list endpoints are deprecated in favor of newer versioned endpoints with unified pagination patterns. Affected APIs:

Endpoint migrations

What’s changing on 06/15/2026:
  1. The legacy list endpoints above will no longer be supported.
  2. GET /list-chat changes both method and path to POST /v3/list-chats.
  3. Versioned list endpoints return unified pagination fields: items, pagination_key, and has_more.
Migration:
  • Update each client call to the new method/path listed above.
  • Update response handling to read items from the paginated response object (instead of expecting a top-level array from legacy endpoints).
  • Keep using pagination_key and has_more for page traversal.
Effective date: After 06/15/2026, the legacy endpoints listed above will no longer be supported.

Analysis prompt fields are deprecated

The following top-level analysis prompt fields on voice and chat agent configurations are deprecated in favor of the post_call_analysis_data and post_chat_analysis_data arrays. Deprecated fields:
  • analysis_summary_prompt
  • analysis_successful_prompt
  • analysis_user_sentiment_prompt
These fields exist on both voice agent and chat agent endpoints: What’s changing on 06/15/2026:
  1. The three prompt fields above will be removed from the API.
  2. Use system preset items inside post_call_analysis_data (voice agents) or post_chat_analysis_data (chat agents) to customize prompts for summary, success, and sentiment analysis.
Migration: Replace each deprecated field with a system preset entry in the corresponding analysis data array. Set type to system-presets, name to the preset identifier, and description to your custom prompt.
Deprecated fieldPreset name (voice)Preset name (chat)
analysis_summary_promptcall_summarychat_summary
analysis_successful_promptcall_successfulchat_successful
analysis_user_sentiment_promptuser_sentimentuser_sentiment
For example, if you currently set analysis_summary_prompt on a voice agent:
{
  "analysis_summary_prompt": "Summarize the outcome of the conversation in two sentences."
}