v5
OpenAPI 3.1.02026-08-043621,4011.8 MBText Search Conversation Messages
Search through conversation transcript messages by full-text and fuzzy search
Query parameters
The search query text for full-text and fuzzy matching
The search query text for full-text and fuzzy matching
Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.
Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.
Filter conversations where any of these agents participated. Can not exceed 50 values.
Filter conversations where any of these agents participated. Can not exceed 50 values.
Filter conversations where any of these agent branches participated. Can not exceed 50 values.
Filter conversations where any of these agent branches participated. Can not exceed 50 values.
The result of the success evaluation
Unix timestamp (in seconds) to filter conversations up to this start date.
Unix timestamp (in seconds) to filter conversations up to this start date.
Unix timestamp (in seconds) to filter conversations after to this start date.
Unix timestamp (in seconds) to filter conversations after to this start date.
Minimum call duration in seconds.
Minimum call duration in seconds.
Maximum call duration in seconds.
Maximum call duration in seconds.
Maximum overall rating (1-5).
Maximum overall rating (1-5).
Minimum overall rating (1-5).
Minimum overall rating (1-5).
Filter conversations with user feedback comments.
Filter conversations with user feedback comments.
Filter conversations by the user ID who initiated them.
Filter conversations by the user ID who initiated them.
Evaluation filters. Repeat param. Format: criteria_id:result. Example: eval=value_framing:success
Evaluation filters. Repeat param. Format: criteria_id:result. Example: eval=value_framing:success
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 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.
Filter conversations by tool names used during the call.
Filter conversations by tool names used during the call.
Filter conversations by tool names that had successful calls.
Filter conversations by tool names that had successful calls.
Filter conversations by tool names that had errored calls.
Filter conversations by tool names that had errored calls.
Filter conversations by detected main language (language code).
Filter conversations by detected main language (language code).
Exclude conversations with the given statuses. Useful for hiding in-progress / processing conversations from list views.
Exclude conversations with the given statuses. Useful for hiding in-progress / processing conversations from list views.
Filter conversations by their stored termination_reason (metadata.termination_reason). Repeat param to match any of several.
Filter conversations by their stored termination_reason (metadata.termination_reason). Repeat param to match any of several.
Number of results per page. Max 50.
Number of results per page. Max 50.
Whether to include transcript summaries in the response.
Whether to include transcript summaries in the response.
Enum representing the possible sources for conversation initiation.
Which product surface owns this agent document.
Restrict results to a single conversation product surface.
Filter conversations by branch ID.
Filter conversations by branch ID.
Filter conversations by version ID.
Filter conversations by version ID.
Filter conversations by topic IDs assigned during topic discovery.
Filter conversations by topic IDs assigned during topic discovery.
Sort order for search results. 'search_score' sorts by search score, 'created_at' sorts by conversation start time.
Used for fetching next page. Cursor is returned in the response.
Used for fetching next page. Cursor is returned in the response.
Headers
Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.
Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.
Response
Successful Response