Skip to navigation

Get a realtime transcription

View as Markdown

Reads one session: its status, received audio, billed minutes and final pass. When finalPass.status is ready, read the transcript from GET /v1/files/{fileId}.

Learn more: Realtime transcription

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

The session.
object"realtime_transcription"
idstring
statusenum
closeReasonenum or null
audioobject
maxDurationSecondsinteger-9007199254740991-9007199254740991
audioSecondsdouble
Received audio, in seconds.
billedMinutesinteger-9007199254740991-9007199254740991
Minutes charged so far.
finalPassobject
metadatamap from strings to strings or null
createdAtdatetime
connectedAtdatetime or null
closedAtdatetime or null
connectBydatetime or null
Connect before this time, or the session expires. Null once a client connected.
websocketobjectOptional
Only in the create response.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error