List conversations

GET

/v1/convai/conversations

GET

/v1/convai/conversations

curl -G https://api.elevenlabs.io/v1/convai/conversations \
     -d agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz \
     -d call_successful=success

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

Get all conversations of agents that user owns. With option to restrict to a specific agent.

Query parameters

cursorstring or nullOptional

Used for fetching next page. Cursor is returned in the response.

agent_idstring or nullOptional

Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.

visited_agent_idslist of strings or nullOptional

Filter conversations where any of these agents participated. Can not exceed 50 values.

visited_agent_branch_idslist of strings or nullOptional

Filter conversations where any of these agent branches participated. Can not exceed 50 values.

triggered_procedure_idslist of strings or nullOptional

Filter conversations where any of these procedures were triggered. Can not exceed 50 values.

call_successfulenum or nullOptional

The result of the success evaluation

Allowed values:

call_start_before_unixinteger or nullOptional

Unix timestamp (in seconds) to filter conversations up to this start date.

call_start_after_unixinteger or nullOptional

Unix timestamp (in seconds) to filter conversations after to this start date.

call_duration_min_secsinteger or nullOptional

Minimum call duration in seconds.

call_duration_max_secsinteger or nullOptional

Maximum call duration in seconds.

rating_maxinteger or nullOptional1-5

Maximum overall rating (1-5).

rating_mininteger or nullOptional1-5

Minimum overall rating (1-5).

has_feedback_commentboolean or nullOptional

Filter conversations with user feedback comments.

user_idstring or nullOptional

Filter conversations by the user ID who initiated them.

evaluation_paramslist of strings or nullOptional

Evaluation filters. Repeat param. Format: criteria_id:result where result is one of success|failure|unknown. Example: eval=value_framing:success

data_collection_paramslist of strings or nullOptional

Data collection filters. Repeat param. Format: id:op:value where op is one of eq|neq|gt|gte|lt|lte|in. For in, pipe-delimit values. An empty value matches conversations where the field was not collected (id:eq:), and neq with an empty value matches where it was (id:neq:). eq is exact equality. gt|gte|lt|lte require a numeric value.

dynamic_variable_paramslist of strings or nullOptional

Dynamic variable filters. Repeat param. Format: name:op:value where op is one of eq|neq|gt|gte|lt|lte|in. For in, pipe-delimit values. An empty value matches conversations where the variable was not set (name:eq:), and neq with an empty value matches where it was (name:neq:). eq is exact equality. gt|gte|lt|lte require a numeric value. Names containing ’:’ cannot be expressed.

data_collection_filterstring or nullOptional

A single data collection filter, for callers that can only send one scalar value per query param. Same format as data_collection_params (id:op:value); combined with it when both are given.

dynamic_variable_filterstring or nullOptional

A single dynamic variable filter, for callers that can only send one scalar value per query param. Same format as dynamic_variable_params (name:op:value); combined with it when both are given.

data_collection_idslist of strings or nullOptional

Data collection field IDs to include in each conversation summary. Repeat param. When omitted, data_collection_results is not returned.

evaluation_criteria_idslist of strings or nullOptional

Evaluation criteria IDs to include in each conversation summary. Repeat param. When omitted, evaluation_criteria_results is not returned.

tool_nameslist of strings or nullOptional

Filter conversations by tool names used during the call.

tool_names_successfullist of strings or nullOptional

Filter conversations by tool names that had successful calls.

tool_names_erroredlist of strings or nullOptional

Filter conversations by tool names that had errored calls.

tool_idslist of strings or nullOptional

Filter conversations by IDs of tools used during the call. Use ‘_system<tool_name>’ for system tools. Unlike tool_names, distinguishes between tools that share a name.

tool_ids_successfullist of strings or nullOptional

Filter conversations by IDs of tools that had successful calls.

tool_ids_erroredlist of strings or nullOptional

Filter conversations by IDs of tools that had errored calls.

include_invalid_tool_callsbooleanOptionalDefaults to false

Also match tool calls that never ran.

main_languageslist of strings or nullOptional

Filter conversations by detected main language (language code).

phone_number_idslist of strings or nullOptional

Filter conversations by agent phone number IDs.

whatsapp_phone_number_idslist of strings or nullOptional

Filter conversations by agent WhatsApp number IDs.

page_sizeintegerOptional1-100Defaults to 30

How many conversations to return at maximum. Can not exceed 100, defaults to 30.

summary_modeenumOptionalDefaults to exclude

Whether to include transcript summaries in the response.

Allowed values:

searchstring or nullOptionalDeprecated

Full-text or fuzzy search over transcript messages

conversation_initiation_sourceenum or nullOptionalDefaults to unknown

Enum representing the possible sources for conversation initiation.

text_onlyboolean or nullOptional

conversation_product_typeenum or nullOptional

Restrict results to a single conversation product surface.

Allowed values:

branch_idstring or nullOptional

Filter conversations by branch ID.

version_idstring or nullOptional

Filter conversations by version ID.

parent_conversation_idstring or nullOptional

Filter conversations by parent conversation ID for subagent conversations.

topic_idslist of strings or nullOptional

Filter conversations by topic IDs assigned during topic discovery.

exclude_statuseslist of enums or nullOptional

Exclude conversations with the given statuses. Useful for hiding in-progress / processing conversations from list views.

Allowed values:

tag_idslist of strings or nullOptional

Filter conversations by conversation tag IDs assigned via the conversation-tags endpoints.

workflow_node_entered_idstring or nullOptional

Filter conversations to only those that entered the given node.

termination_reasonslist of strings or nullOptional

Filter conversations by their stored termination_reason (metadata.termination_reason). Repeat param to match any of several.

guardrail_typeslist of enums or nullOptional

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_nameslist of strings or nullOptional

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_directionenumOptional

The direction to sort conversations by call start time. Defaults to descending (newest first).

Allowed values:

Response

Successful Response

conversationslist of objects

has_moreboolean

next_cursorstring or nullOptional

Errors

422

Unprocessable Entity Error

Headers

Query parameters

Response

Errors