List conversations

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

Headers

xi-api-keystringRequired

Query Parameters

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

Full-text or fuzzy search over transcript messages

Response

Successful Response
conversationslist of objects
has_moreboolean
next_cursorstring or null

Errors