Skip to main content
POST
audio.transcription.get

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})$
view
enum<string>
default:text

Part of the transcript to read. Default text.

Available options:
text,
words,
utterances,
sentences,
paragraphs
limit
integer
default:100

Items or text characters per page, 1 to 1000. Default 100.

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

Continuation from the same transcript and view.

Required string length: 1 - 2048

Response

The result

status
enum<string>
required

Processing state.

Available options:
queued,
processing,
completed,
failed
text
string

Requested text page.

results
object[]

Requested timed word, utterance, sentence or paragraph page.

language
string

Detected two-letter language.

durationSeconds
number

Audio length in seconds.

Required range: x >= 0
confidence
number

Recognition confidence.

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

Continuation for the same view.