List conversations

GET

/v1/convai/conversations

GET

/v1/convai/conversations

$ curl https://api.elevenlabs.io/v1/convai/conversations

1 {
2   "conversations": [
3     {
4       "agent_id": "string",
5       "conversation_id": "string",
6       "start_time_unix_secs": 1,
7       "call_duration_secs": 1,
8       "message_count": 1,
9       "status": "initiated",
10       "call_successful": "success",
11       "branch_id": "string",
12       "version_id": "string",
13       "agent_name": "string",
14       "termination_reason": "",
15       "call_success_score": 1.1,
16       "transcript_summary": "string",
17       "call_summary_title": "string",
18       "main_language": "string",
19       "conversation_initiation_source": "unknown",
20       "tool_names": [
21         "string"
22       ],
23       "direction": "inbound",
24       "rating": 1.1,
25       "sentiment_analysis": {
26         "overall_label": "positive",
27         "overall_sentiment_score": 0,
28         "overall_frustration_score": 0.5,
29         "min_user_sentiment_score": 0,
30         "max_user_frustration_score": 0.5,
31         "num_scored_user_turns": 1
32       },
33       "data_collection_results": {},
34       "evaluation_criteria_results": {},
35       "tag_ids": [
36         "string"
37       ]
38     }
39   ],
40   "has_more": true,
41   "next_cursor": "string"
42 }

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.

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. 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|exists|missing. For in, pipe-delimit values.

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.

main_languageslist of strings or nullOptional

Filter conversations by detected main language (language code).

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.

Response

Successful Response

conversationslist of objects

has_moreboolean

next_cursorstring or nullOptional

Errors

422

Unprocessable Entity Error

Headers

Query parameters

Response

Errors