apicheats.dev elevenlabs/llms.txt Raw .md
GET

/v1/convai/conversations

ElevenLabs API

Get Conversations

Base URL
https://api.elevenlabs.io
Auth
xi-api-key: <ELEVENLABS_API_KEY>
Last verified
2026-09-03 · upstream hash matched
Actions
Agents: curl -H "Accept: text/markdown" this URL
→ 203 tokens · Vary: Accept

Critical gotchas

Authentication uses the non-standard xi-api-key header, not Authorization: Bearer. Sending a Bearer token returns HTTP 401.

Text-to-speech responses are raw binary audio, not JSON. Write the body to a file (--output speech.mp3) rather than parsing it.

cURL

curl -X GET 'https://api.elevenlabs.io/v1/convai/conversations?cursor=example-cursor&agent_id=agent-id&visited_agent_ids=example&visited_agent_branch_ids=example&triggered_procedure_ids=example&call_successful=success&call_start_before_unix=10&call_start_after_unix=10&call_duration_min_secs=10&call_duration_max_secs=10&rating_max=10&rating_min=10&has_feedback_comment=true&user_id=user-id&evaluation_params=example&data_collection_params=example&data_collection_ids=example&evaluation_criteria_ids=example&tool_names=example&tool_names_successful=example&tool_names_errored=example&include_invalid_tool_calls=false&main_languages=example&page_size=30&summary_mode=exclude&search=example-search&conversation_initiation_source=unknown&text_only=true&conversation_product_type=agents&branch_id=branch-id&version_id=version-id&parent_conversation_id=parent-conversation-id&topic_ids=example&exclude_statuses=example&tag_ids=example&workflow_node_entered_id=workflow-node-entered-id&termination_reasons=example&guardrail_types=example&custom_guardrail_names=example&sort_direction=asc' \  -H "xi-api-key: $ELEVENLABS_API_KEY"
Get a free ElevenLabs API key → sponsored

Parameters

Name In Type Required Description
cursor query string No Used for fetching next page. Cursor is returned in the response.
agent_id query string No Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.
visited_agent_ids query string[] No Filter conversations where any of these agents participated. Can not exceed 50 values.
visited_agent_branch_ids query string[] No Filter conversations where any of these agent branches participated. Can not exceed 50 values.
triggered_procedure_ids query string[] No Filter conversations where any of these procedures were triggered. Can not exceed 50 values.
call_successful query string No The result of the success evaluation
call_start_before_unix query integer No Unix timestamp (in seconds) to filter conversations up to this start date.
call_start_after_unix query integer No Unix timestamp (in seconds) to filter conversations after to this start date.
call_duration_min_secs query integer No Minimum call duration in seconds.
call_duration_max_secs query integer No Maximum call duration in seconds.
rating_max query integer No Maximum overall rating (1-5).
rating_min query integer No Minimum overall rating (1-5).
has_feedback_comment query boolean No Filter conversations with user feedback comments.
user_id query string No Filter conversations by the user ID who initiated them.
evaluation_params query string[] No Evaluation filters. Repeat param. Format: criteria_id:result. Example: eval=value_framing:success
data_collection_params query string[] No Data collection filters. Repeat param. Format: id:op:value where op is one of eq|neq|gt|gte|lt|lte|in|exists|missing. For in, pipe-delimit values.
data_collection_ids query string[] No Data collection field IDs to include in each conversation summary. Repeat param. When omitted, data_collection_results is not returned.
evaluation_criteria_ids query string[] No Evaluation criteria IDs to include in each conversation summary. Repeat param. When omitted, evaluation_criteria_results is not returned.
tool_names query string[] No Filter conversations by tool names used during the call.
tool_names_successful query string[] No Filter conversations by tool names that had successful calls.
tool_names_errored query string[] No Filter conversations by tool names that had errored calls.
include_invalid_tool_calls query boolean No Also match tool calls that never ran.
main_languages query string[] No Filter conversations by detected main language (language code).
page_size query integer No How many conversations to return at maximum. Can not exceed 100, defaults to 30.
summary_mode query string No Whether to include transcript summaries in the response.
search query string No Full-text or fuzzy search over transcript messages
conversation_initiation_source query string No query parameter conversation_initiation_source.
text_only query boolean No query parameter text_only.
conversation_product_type query string No Restrict results to a single conversation product surface.
branch_id query string No Filter conversations by branch ID.
version_id query string No Filter conversations by version ID.
parent_conversation_id query string No Filter conversations by parent conversation ID for subagent conversations.
topic_ids query string[] No Filter conversations by topic IDs assigned during topic discovery.
exclude_statuses query string[] No Exclude conversations with the given statuses. Useful for hiding in-progress / processing conversations from list views.
tag_ids query string[] No Filter conversations by conversation tag IDs assigned via the conversation-tags endpoints.
workflow_node_entered_id query string No Filter conversations to only those that entered the given node.
termination_reasons query string[] No Filter conversations by their stored termination_reason (metadata.termination_reason). Repeat param to match any of several.
guardrail_types query string[] No Filter to conversations where a guardrail of any of these types triggered (metadata.triggered_guardrails.guardrail_type). Repeat param to match any of several.
custom_guardrail_names query string[] No Filter to conversations where a custom guardrail with any of these names triggered (metadata.triggered_guardrails.guardrail_name). Only custom guardrails carry a name. Repeat param to match any of several.
sort_direction query string No The direction to sort conversations by call start time. Defaults to descending (newest first).

Response 200 OK

{
  "conversations": [
    {
      "agent_id": "string",
      "branch_id": "string",
      "version_id": "string",
      "agent_name": "string",
      "conversation_id": "string",
      "start_time_unix_secs": 0,
      "call_duration_secs": 0,
      "message_count": 0,
      "status": "initiated",
      "termination_reason": "",
      "call_successful": "success",
      "call_success_score": 0,
      "transcript_summary": "string",
      "call_summary_title": "string",
      "main_language": "string",
      "conversation_initiation_source": "unknown",
      "tool_names": [
        "string"
      ],
      "direction": "inbound",
      "rating": 0,
      "sentiment_analysis": {
        "overall_label": "positive",
        "overall_sentiment_score": 0,
        "overall_frustration_score": 0,
        "min_user_sentiment_score": 0,
        "max_user_frustration_score": 0,
        "num_scored_user_turns": 0
      },
      "data_collection_results": {},
      "evaluation_criteria_results": {},
      "tag_ids": [
        "string"
      ]
    }
  ],
  "next_cursor": "string",
  "has_more": true
}