Agents Platform

Text Search Conversation Messages

Changed on

Search through conversation transcript messages by full-text and fuzzy search

get/v1/convai/conversations/messages/text-search

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/convai/conversations/messages/text-search
  • Auth
    none declared

Query parameters

text_querystring required

The search query text for full-text and fuzzy matching

agent_idstring nullable

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

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz
visited_agent_idsstring[] nullable

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

visited_agent_branch_idsstring[] nullable

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

triggered_procedure_idsstring[] nullable

Filter conversations where any of these procedures were triggered. Can not exceed 50 values.

call_successful'success' | 'failure' | 'unknown' | 'error'

The result of the success evaluation

call_start_before_unixinteger nullable

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

call_start_after_unixinteger nullable

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

call_duration_min_secsinteger nullable

Minimum call duration in seconds.

call_duration_max_secsinteger nullable

Maximum call duration in seconds.

rating_maxinteger nullable

Maximum overall rating (1-5).

rating_mininteger nullable

Minimum overall rating (1-5).

has_feedback_commentboolean nullable

Filter conversations with user feedback comments.

user_idstring nullable

Filter conversations by the user ID who initiated them.

evaluation_paramsstring[] nullable

Evaluation filters. Repeat param. Format: criteria_id:result where result is one of success|failure|unknown. Example: eval=value_framing:success

data_collection_paramsstring[] nullable

Data collection filters. Repeat param. Format: id:op:value where op is one of eq|neq|gt|gte|lt|lte|in. For in, pipe-delimit values. An empty value matches conversations where the field was not collected (id:eq:), and neq with an empty value matches where it was (id:neq:). eq is exact equality. gt|gte|lt|lte require a numeric value.

dynamic_variable_paramsstring[] nullable

Dynamic variable filters. Repeat param. Format: name:op:value where op is one of eq|neq|gt|gte|lt|lte|in. For in, pipe-delimit values. An empty value matches conversations where the variable was not set (name:eq:), and neq with an empty value matches where it was (name:neq:). eq is exact equality. gt|gte|lt|lte require a numeric value. Names containing ':' cannot be expressed.

tool_namesstring[] nullable

Filter conversations by tool names used during the call.

tool_names_successfulstring[] nullable

Filter conversations by tool names that had successful calls.

tool_names_erroredstring[] nullable

Filter conversations by tool names that had errored calls.

include_invalid_tool_callsboolean

Also match tool calls that never ran.

main_languagesstring[] nullable

Filter conversations by detected main language (language code).

exclude_statusesstring[] nullable

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

termination_reasonsstring[] nullable

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

page_sizeinteger

Number of results per page. Max 50.

summary_mode'exclude' | 'include'

Whether to include transcript summaries in the response.

conversation_initiation_source'unknown' | 'android_sdk' | 'node_js_sdk' | 'react_native_sdk' | 'react_sdk' | 'js_sdk' | 'python_sdk' | 'widget' | 'sip_trunk' | 'twilio' | 'exotel' | 'genesys' | 'avaya' | 'audiocodes' | 'swift_sdk' | 'whatsapp' | 'twilio_sms' | 'flutter_sdk' | 'zendesk_integration' | 'slack_integration' | 'telegram_integration' | 'intercom_integration' | 'freshdesk_integration' | 'salesforce_integration' | 'template_preview' | 'genesys_bot_connector' | 'subagent_tool'

Enum representing the possible sources for conversation initiation.

text_onlyboolean nullable
conversation_product_type'agents' | 'speech_engine'

Which product surface owns this agent document.

Restrict results to a single conversation product surface.

branch_idstring nullable

Filter conversations by branch ID.

version_idstring nullable

Filter conversations by version ID.

topic_idsstring[] nullable

Filter conversations by topic IDs assigned during topic discovery.

sort_by'search_score' | 'created_at'

Sort order for search results. 'search_score' sorts by search score, 'created_at' sorts by conversation start time.

cursorstring nullable

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

Headers

xi-api-keystring nullable

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

next_cursorstring nullable

Cursor for the next page of results

has_moreboolean required

Whether there are more results available

Changes