Text search | ElevenLabs Documentation

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

Headers

xi-api-keystringOptional

Query parameters

text_querystringRequired

The search query text for full-text and fuzzy matching

agent_idstringOptional

The id of the agent you're taking the action on.

call_successfulenumOptional

The result of the success evaluation

Allowed values:

call_start_before_unixintegerOptional

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

call_start_after_unixintegerOptional

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

call_duration_min_secsintegerOptional

Minimum call duration in seconds.

call_duration_max_secsintegerOptional

Maximum call duration in seconds.

rating_maxintegerOptional1-5

Maximum overall rating (1-5).

rating_minintegerOptional1-5

Minimum overall rating (1-5).

has_feedback_commentbooleanOptional

Filter conversations with user feedback comments.

user_idstringOptional

Filter conversations by the user ID who initiated them.

evaluation_paramsstringOptional

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

data_collection_paramsstringOptional

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_namesstringOptional

Filter conversations by tool names used during the call.

main_languagesstringOptional

Filter conversations by detected main language (language code).

page_sizeintegerOptional1-50Defaults to 20

Number of results per page. Max 50.

summary_modeenumOptionalDefaults to exclude

Whether to include transcript summaries in the response.

Allowed values:

conversation_initiation_sourceenumOptional

Enum representing the possible sources for conversation initiation.

branch_idstringOptional

Filter conversations by branch ID.

cursorstringOptional

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

Response

Successful Response

resultslist of objects

has_moreboolean

Whether there are more results available

metaobject or null

next_cursorstring or null

Cursor for the next page of results

1	from elevenlabs import ElevenLabs
2	from elevenlabs.environment import ElevenLabsEnvironment
3
4	client = ElevenLabs(
5	environment=ElevenLabsEnvironment.PRODUCTION
6	)
7
8	client.conversational_ai.conversations.messages.text_search(
9	text_query="refund policy",
10	agent_id="21m00Tcm4TlvDq8ikWAM",
11	call_successful="success",
12	call_start_before_unix=1700000000,
13	call_start_after_unix=1600000000,
14	call_duration_min_secs=60,
15	call_duration_max_secs=3600,
16	rating_max=5,
17	rating_min=3,
18	has_feedback_comment=True,
19	user_id="user_12345",
20	page_size=20,
21	summary_mode="include",
22	conversation_initiation_source="widget",
23	branch_id="branch_789",
24	cursor="eyJwYWdlIjoxfQ==",
25	evaluation_params=[
26	"value_framing:success",
27	"tone:failure"
28	],
29	data_collection_params=[
30	"region:eq:us-west",
31	"device:in:mobile\|desktop"
32	],
33	tool_names=[
34	"crm_integration",
35	"call_recorder"
36	],
37	main_languages=[
38	"en",
39	"es"
40	]
41	)

1	{
2	"results": [
3	{
4	"conversation_id": "conv_987654321",
5	"agent_id": "21m00Tcm4TlvDq8ikWAM",
6	"transcript_index": 5,
7	"chunk_text": "I understand your concern about the refund policy. Let me explain how it works in detail.",
8	"score": 0.95,
9	"conversation_start_time_unix_secs": 1688208000,
10	"agent_name": "Jane Doe"
11	}
12	],
13	"has_more": false,
14	"meta": {
15	"total": 1,
16	"page": 1,
17	"page_size": 1
18	},
19	"next_cursor": "eyJwYWdlIjoyfQ=="
20	}

Headers

Query parameters

Response

Errors