Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

q
string
required

Natural language search query. The text is embedded into a 1024-dimensional vector and compared against indexed record chunks using semantic similarity.

Minimum string length: 1
Example:

"customer called about billing issue"

region
enum<string>

Restrict search to a specific region. When omitted, all regions are queried in parallel (fan-out) and results are merged by similarity score.

Available options:
USA,
DEU,
AUS,
UAE
Example:

"USA"

page[number]
integer
default:1

Page number to return (1-based). Defaults to 1.

Required range: x >= 1
Example:

1

page[size]
integer
default:20

Number of results per page. Defaults to 20, maximum 100.

Required range: 1 <= x <= 100
Example:

10

min_score
number<float>
default:0

Minimum cosine similarity score threshold (0.0 to 1.0). Results below this threshold are excluded.

Required range: 0 <= x <= 1
Example:

0.5

filter[user_id]
string

Filter to records owned by a specific user (exact match).

Example:

"user-123"

filter[record_id]
string

Filter to chunks belonging to a specific parent record (exact match).

Example:

"rec-001"

filter[region][in]
string

Filter by the region stored on the record. Comma-separated to match multiple regions (USA, DEU, AUS, UAE). Distinct from the region parameter, which selects which cluster(s) are queried.

Example:

"USA,DEU"

filter[record_created_at][gte]
string<date-time>

Only include records whose original creation time is on or after this ISO 8601 timestamp.

Example:

"2026-01-01T00:00:00Z"

filter[record_created_at][lte]
string<date-time>

Only include records whose original creation time is on or before this ISO 8601 timestamp.

Example:

"2026-12-31T23:59:59Z"

filter[ingested_at][gte]
string<date-time>

Only include records ingested (chunked, embedded, and indexed) on or after this ISO 8601 timestamp.

Example:

"2026-01-01T00:00:00Z"

filter[ingested_at][lte]
string<date-time>

Only include records ingested (chunked, embedded, and indexed) on or before this ISO 8601 timestamp.

Example:

"2026-12-31T23:59:59Z"

filter[retention]
string

Filter by retention policy (exact match). Filter-only: not returned in the response body.

Response

Successful search response with ranked conversation history chunks.

Search response following the standard Telnyx V2 API format.

data
object[]
required

Ranked list of matching text chunks, sorted by cosine similarity score descending.

meta
object
required

Pagination metadata following the standard Telnyx V2 API format.