List conversations

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

Headers

xi-api-keystringOptional

Query parameters

cursorstringOptional
Used for fetching next page. Cursor is returned in the response.
agent_idstringOptional
The id of the agent you're taking the action on.
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.

tool_namesstringOptional
Filter conversations by tool names used during the call.
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:
searchstringOptional

Full-text or fuzzy search over transcript messages

conversation_initiation_sourceenumOptional
Enum representing the possible sources for conversation initiation.
branch_idstringOptional
Filter conversations by branch ID.

Response

Successful Response
conversationslist of objects
has_moreboolean
next_cursorstring or null

Errors