Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
Agents Platform

Smart Search Conversation Messages

Search conversation transcripts by semantic similarity to surface relevant messages based on meaning and intent, rather than exact keyword matches

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

Query parameters

text_querystring required

The search query text for semantic similarity matching

The search query text for semantic similarity matching

agent_idstring nullable

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

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

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

page_sizeinteger

Number of results per page. Max 50.

Number of results per page. Max 50.

cursorstring nullable

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

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.

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