Skip to main content
POST
audio.transcription.word-search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by a row of audio.transcriptions.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
words
string[]
required

Up to 100 exact words or phrases.

Required array length: 1 - 100 elements

Word or phrase to find.

Required string length: 1 - 200
limit
integer
default:100

Occurrences per page, 1 to 1000.

Required range: 1 <= x <= 1000
cursor
string

Continuation with the same search words.

Required string length: 1 - 2048

Response

The result

results
object[]
required

Matching occurrences.

totalCount
integer
required

Number of matching occurrences across all pages.

Required range: 0 <= x <= 9007199254740991
nextCursor
string

Continuation for this search.