Text Search Conversation Messages

{ "results": [ { "conversation_id": "<string>", "agent_id": "<string>", "transcript_index": 123, "chunk_text": "<string>", "score": 123, "conversation_start_time_unix_secs": 123, "agent_name": "<string>" } ], "has_more": true, "meta": {}, "next_cursor": "<string>" }

Headers

x-api-key

string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Query Parameters

text_query

string

required

The search query text for full-text and fuzzy matching

agent_id

string | null

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

Example:

"agent_3701k3ttaq12ewp8b7qv5rfyszkz"

visited_agent_ids

string[] | null

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

Maximum array length: 50

visited_agent_branch_ids

string[] | null

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

Maximum array length: 50

triggered_procedure_ids

string[] | null

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

Maximum array length: 50

call_successful

enum<string> | null

The result of the success evaluation

Available options:

success,

failure,

unknown,

error

Example:

"success"

call_start_before_unix

integer | null

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

call_start_after_unix

integer | null

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

call_duration_min_secs

integer | null

Minimum call duration in seconds.

call_duration_max_secs

integer | null

Maximum call duration in seconds.

rating_max

integer | null

Maximum overall rating (1-5).

Required range: 1 <= x <= 5

rating_min

integer | null

Minimum overall rating (1-5).

Required range: 1 <= x <= 5

has_feedback_comment

boolean | null

Filter conversations with user feedback comments.

user_id

string | null

Filter conversations by the user ID who initiated them.

evaluation_params

string[] | null

Evaluation filters. Repeat param. Format: criteria_id:result. Example: eval=value_framing:success

data_collection_params

string[] | null

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_names

string[] | null

Filter conversations by tool names used during the call.

tool_names_successful

string[] | null

Filter conversations by tool names that had successful calls.

tool_names_errored

string[] | null

Filter conversations by tool names that had errored calls.

include_invalid_tool_calls

boolean

default:false

Also match tool calls that never ran.

main_languages

string[] | null

Filter conversations by detected main language (language code).

exclude_statuses

enum<string>[] | null

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

Available options:

initiated,

in-progress,

processing,

done,

failed

termination_reasons

string[] | null

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

page_size

integer

default:20

Number of results per page. Max 50.

Required range: 1 <= x <= 50

summary_mode

enum<string>

default:exclude

Whether to include transcript summaries in the response.

Available options:

exclude,

include

conversation_initiation_source

enum<string> | null

default:unknown

Enum representing the possible sources for conversation initiation.

Available options:

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

text_only

boolean | null

conversation_product_type

enum<string> | null

Restrict results to a single conversation product surface. Which product surface owns this agent document.

Available options:

agents,

speech_engine

branch_id

string | null

Filter conversations by branch ID.

version_id

string | null

Filter conversations by version ID.

topic_ids

string[] | null

Filter conversations by topic IDs assigned during topic discovery.

sort_by

enum<string>

default:search_score

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

Available options:

search_score,

created_at

cursor

string | null

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

Response

Successful Response

results

MessagesSearchResult · object[]

required

Show child attributes

has_more

boolean

required

Whether there are more results available

Agents Platform

API Reference

Agents Insights

Agents Workspace Analytics

Outbound Calls

Conversational AI

Voices

Phone Numbers

workspace

access:all

Time Zones

Headers

Query Parameters

Response