Skip to main content
GET
Search interview transcripts

Authorizations

Authorization
string
header
required

Use Authorization: Bearer

Path Parameters

project_id
string<uuid>
required

UUID of the project

Query Parameters

query
string
required

Search keywords (whitespace-separated; a message matches any term). Minimum 2 characters; stopwords and single-character terms are ignored.

campaign
string

Filter by campaign: a campaign UUID, or "none" for interviews without a campaign.

interview_ids
string

Comma-separated interview UUIDs to search within.

Response

Successful response

query
string
terms
string[]

The parsed search terms (unique, lowercased).

count_interviews_matched
integer

Interviews with at least one matching message (before the total-hit cap).

interviews_scanned
integer

Candidate interviews whose transcripts were examined.

scan_limit_reached
boolean

True when more interviews matched the prefilter than could be scanned, so older ones were not examined at all and matches may be missing entirely (not merely trimmed).

truncated
boolean

True when more matches exist than were returned (per-interview cap, total cap, or scan bound reached).

hits
object[]