List conversations

GET

/v1/convai/conversations

GET

/v1/convai/conversations

$ curl -G https://api.elevenlabs.io/v1/convai/conversations \
>      -d agent_id=agent_id \
>      -d branch_id=branch_id \
>      -d call_duration_max_secs=1 \
>      -d call_duration_min_secs=1 \
>      -d call_start_after_unix=1 \
>      -d call_start_before_unix=1 \
>      -d call_successful=success \
>      -d conversation_initiation_source=unknown \
>      -d conversation_product_type=agents \
>      -d cursor=cursor \
>      -d data_collection_ids=data_collection_ids \
>      -d data_collection_params=data_collection_params \
>      -d evaluation_criteria_ids=evaluation_criteria_ids \
>      -d evaluation_params=evaluation_params \
>      -d exclude_statuses=initiated \
>      -d has_feedback_comment=true \
>      -d main_languages=main_languages \
>      -d page_size=1 \
>      -d rating_max=1 \
>      -d rating_min=1 \
>      -d search=search \
>      -d summary_mode=exclude \
>      -d tag_ids=tag_ids \
>      -d termination_reasons=termination_reasons \
>      -d text_only=true \
>      -d tool_names=tool_names \
>      -d tool_names_errored=tool_names_errored \
>      -d tool_names_successful=tool_names_successful \
>      -d topic_ids=topic_ids \
>      -d user_id=user_id \
>      -d visited_agent_branch_ids=visited_agent_branch_ids \
>      -d visited_agent_ids=visited_agent_ids \
>      -d workflow_node_entered_id=workflow_node_entered_id

1 {
2   "conversations": [
3     {
4       "agent_id": "agent_id",
5       "conversation_id": "conversation_id",
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": "branch_id",
12       "version_id": "version_id",
13       "agent_name": "agent_name",
14       "termination_reason": "termination_reason",
15       "call_success_score": 1.1,
16       "transcript_summary": "transcript_summary",
17       "call_summary_title": "call_summary_title",
18       "main_language": "main_language",
19       "conversation_initiation_source": "unknown",
20       "tool_names": [
21         "tool_names"
22       ],
23       "direction": "inbound",
24       "rating": 1.1,
25       "sentiment_analysis": {
26         "overall_label": "positive",
27         "overall_sentiment_score": 1.1,
28         "overall_frustration_score": 1.1,
29         "min_user_sentiment_score": 1.1,
30         "max_user_frustration_score": 1.1,
31         "num_scored_user_turns": 1
32       },
33       "data_collection_results": {
34         "key": "value"
35       },
36       "tag_ids": [
37         "tag_ids"
38       ]
39     }
40   ],
41   "has_more": true,
42   "next_cursor": "next_cursor"
43 }

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

Query parameters

cursorstringOptional

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

agent_idstringOptional

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

visited_agent_idsstringOptional

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

visited_agent_branch_idsstringOptional

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

call_successfulenumOptional

The result of the success evaluation

Allowed values:

call_start_before_unixintegerOptional

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

call_start_after_unixintegerOptional

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

call_duration_min_secsintegerOptional

Minimum call duration in seconds.

call_duration_max_secsintegerOptional

Maximum call duration in seconds.

rating_maxintegerOptional1-5

Maximum overall rating (1-5).

rating_minintegerOptional1-5

Minimum overall rating (1-5).

has_feedback_commentbooleanOptional

Filter conversations with user feedback comments.

user_idstringOptional

Filter conversations by the user ID who initiated them.

evaluation_paramsstringOptional

Evaluation filters. Repeat param. Format: criteria_id:result. Example: eval=value_framing:success

data_collection_paramsstringOptional

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_idsstringOptional

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

evaluation_criteria_idsstringOptional

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

tool_namesstringOptional

Filter conversations by tool names used during the call.

tool_names_successfulstringOptional

Filter conversations by tool names that had successful calls.

tool_names_erroredstringOptional

Filter conversations by tool names that had errored calls.

main_languagesstringOptional

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:

searchstringOptionalDeprecated

Full-text or fuzzy search over transcript messages

conversation_initiation_sourceenumOptionalDefaults to unknown

Enum representing the possible sources for conversation initiation.

text_onlybooleanOptional

conversation_product_typeenumOptional

Restrict results to a single conversation product surface.

Allowed values:

branch_idstringOptional

Filter conversations by branch ID.

topic_idsstringOptional

Filter conversations by topic IDs assigned during topic discovery.

exclude_statusesenumOptional

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

Allowed values:

tag_idsstringOptional

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

workflow_node_entered_idstringOptional

Filter conversations to only those that entered the given node.

termination_reasonsstringOptional

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

Response

Successful Response

conversationslist of objects

has_moreboolean

next_cursorstring

Errors

422

Conversations List Request Unprocessable Entity Error

Headers

Query parameters

Response

Errors