Skip to main content
GET
Get a transcript

Authorizations

Authorization
string
header
required

Your API key: Authorization: Bearer aircaps_sk_...

Path Parameters

id
string
required

Transcript ID.

Example:

"tr_01k6z3m4q8w7e5r2t1y0u9i8o7"

Query Parameters

wait
number
default:0

Seconds to wait for the transcript to finish before answering (0 to 120). Answers as soon as it finishes, or with its current state when the time is up.

Required range: 0 <= x <= 120

Response

The transcript.

id
string
required

Transcript ID.

Example:

"tr_01k6z3m4q8w7e5r2t1y0u9i8o7"

object
enum<string>
required
Available options:
transcript
Example:

"transcript"

status
enum<string>
required

queued: waiting for a processing slot. processing: being transcribed. completed: result fields present. error: see error.

Available options:
queued,
processing,
completed,
error
created_at
string<date-time>
required

When the transcript was created (UTC).

started_at
string<date-time> | null
required

When processing started.

completed_at
string<date-time> | null
required

When the job finished (completed or error).

audio_url
string | null
required

The submitted audio_url, if any.

file_id
string | null
required

The submitted file_id, if any.

language_code
enum<string>
required

Language of the transcript (normalised).

Available options:
en
model
enum<string>
required
Available options:
a5s-async-v1
audio_duration
number | null
required

Audio duration in seconds, once known.

Example:

3600.512

metadata
object | null
required

Your metadata, echoed back.

webhook_url
string | null
required

Webhook target, if any.

webhook_status
enum<string> | null
required

Webhook delivery state, if webhook_url was set.

Available options:
pending,
delivered,
failed,
null
webhook_status_code
integer | null
required

HTTP status of the last webhook delivery.

error
object | null
required

Set when status is error.

text
string

Completed only. Full transcript: verbatim, lowercase, no punctuation.

speakers
object[]

Completed only. With speaker_identification, each speaker also has speaker_id, name, score, matches and compared_duration.

utterances
object[]

Completed only. Speaker turns, in time order; overlapping speech overlaps.

words
object[]

Completed only. Every word, in time order.

timing_mode
enum<string>

The timing_mode used.

Available options:
phrase,
region
keyterms
string[]

Only when the transcript was created with keyterms: the list used (duplicates removed).

large_meeting
boolean

Only when the transcript was created with large_meeting: true.

speaker_identification
object

Only when the transcript was created with speaker_identification: its settings and outcome.