List conversations

GET

/v1/convai/conversations

GET

/v1/convai/conversations

$ curl https://api.elevenlabs.io/v1/convai/conversations \
>      -H "Content-Type: application/json"

1 {
2   "conversations": [
3     {
4       "agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
5       "conversation_id": "conv_20240604123045_abc123xyz",
6       "start_time_unix_secs": 1710000000,
7       "call_duration_secs": 320,
8       "message_count": 15,
9       "status": "done",
10       "call_successful": "success",
11       "branch_id": "branch_9f8d7c6b5a4e3d2c1b0a",
12       "version_id": "v1.3.0",
13       "agent_name": "Customer Support Bot",
14       "termination_reason": "Call completed successfully",
15       "transcript_summary": "Customer inquired about refund policy and received detailed explanation.",
16       "call_summary_title": "Refund Policy Inquiry",
17       "main_language": "en",
18       "conversation_initiation_source": "widget",
19       "tool_names": [
20         "sentiment_analysis",
21         "entity_recognition"
22       ],
23       "direction": "inbound",
24       "rating": 4.7
25     }
26   ],
27   "has_more": true,
28   "next_cursor": "cursor_20240604123045_001"
29 }

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

List conversations

GET

/v1/convai/conversations

GET

/v1/convai/conversations

$ curl https://api.elevenlabs.io/v1/convai/conversations \
>      -H "Content-Type: application/json"

1 {
2   "conversations": [
3     {
4       "agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
5       "conversation_id": "conv_20240604123045_abc123xyz",
6       "start_time_unix_secs": 1710000000,
7       "call_duration_secs": 320,
8       "message_count": 15,
9       "status": "done",
10       "call_successful": "success",
11       "branch_id": "branch_9f8d7c6b5a4e3d2c1b0a",
12       "version_id": "v1.3.0",
13       "agent_name": "Customer Support Bot",
14       "termination_reason": "Call completed successfully",
15       "transcript_summary": "Customer inquired about refund policy and received detailed explanation.",
16       "call_summary_title": "Refund Policy Inquiry",
17       "main_language": "en",
18       "conversation_initiation_source": "widget",
19       "tool_names": [
20         "sentiment_analysis",
21         "entity_recognition"
22       ],
23       "direction": "inbound",
24       "rating": 4.7
25     }
26   ],
27   "has_more": true,
28   "next_cursor": "cursor_20240604123045_001"
29 }

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.

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.

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

branch_idstring or nullOptional

Filter conversations by branch ID.

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.

Response

Successful Response

conversationslist of objects

has_moreboolean

next_cursorstring or null

Errors

422

Unprocessable Entity Error

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.

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.

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

branch_idstring or nullOptional

Filter conversations by branch ID.

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.

Response

Successful Response

conversationslist of objects

has_moreboolean

next_cursorstring or null

Errors

422

Unprocessable Entity Error

List conversations

List conversations

Headers

Query parameters

Response

Errors

Headers

Query parameters

Response

Errors

$	curl https://api.elevenlabs.io/v1/convai/conversations \
>	-H "Content-Type: application/json"

1	{
2	"conversations": [
3	{
4	"agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
5	"conversation_id": "conv_20240604123045_abc123xyz",
6	"start_time_unix_secs": 1710000000,
7	"call_duration_secs": 320,
8	"message_count": 15,
9	"status": "done",
10	"call_successful": "success",
11	"branch_id": "branch_9f8d7c6b5a4e3d2c1b0a",
12	"version_id": "v1.3.0",
13	"agent_name": "Customer Support Bot",
14	"termination_reason": "Call completed successfully",
15	"transcript_summary": "Customer inquired about refund policy and received detailed explanation.",
16	"call_summary_title": "Refund Policy Inquiry",
17	"main_language": "en",
18	"conversation_initiation_source": "widget",
19	"tool_names": [
20	"sentiment_analysis",
21	"entity_recognition"
22	],
23	"direction": "inbound",
24	"rating": 4.7
25	}
26	],
27	"has_more": true,
28	"next_cursor": "cursor_20240604123045_001"
29	}