Skip to main content
GET
Get transcript

Authorizations

Authorization
string
header
required

Path Parameters

transcript_id
string
required

ID of the transcript

Response

The transcript resource

A transcript object

audio_url
string<url>
required

The URL of the media that was transcribed

auto_highlights
boolean
required

Whether Key Phrases is enabled, either true or false

id
string<uuid>
required

The unique identifier of your transcript

language_confidence
number<double> | null
required

The confidence score for the detected language, between 0.0 (low confidence) and 1.0 (high confidence). See Automatic Language Detection for more details.

Required range: 0 <= x <= 1
language_confidence_threshold
number<float> | null
required

The confidence threshold for the automatically detected language. An error will be returned if the language confidence is below this threshold. See Automatic Language Detection for more details.

Required range: 0 <= x <= 1
redact_pii
boolean
required

Whether PII Redaction is enabled, either true or false

status
enum<string>
required

The status of your transcript. Possible values are queued, processing, completed, or error.

Available options:
queued,
processing,
completed,
error
summarization
boolean
required
deprecated

Whether Summarization is enabled, either true or false. Deprecated - use LLM Gateway instead for more flexible summaries. See the updated Summarization page for details.

Note: This parameter is only supported for the Universal-2 model.

webhook_auth
boolean
required

Whether webhook authentication details were provided

acoustic_model
string
required
deprecated

This parameter does not currently have any functionality attached to it.

language_model
string
required
deprecated

This parameter does not currently have any functionality attached to it.

speech_model
enum<string> | null
required
deprecated

This parameter has been replaced with the speech_models parameter, learn more about the speech_models parameter here.

Available options:
universal-3-5-pro,
universal-2
audio_channels
integer

The number of audio channels in the audio file. This is only present when multichannel is enabled.

audio_duration
integer | null

The duration of this transcript object's media file, in seconds

audio_end_at
integer | null

The point in time, in milliseconds, in the file at which the transcription was terminated. See Set the start and end of the transcript for more details.

audio_start_from
integer | null

The point in time, in milliseconds, in the file at which the transcription was started. See Set the start and end of the transcript for more details.

auto_chapters
boolean | null
deprecated

Whether Auto Chapters is enabled, can be true or false. Deprecated - use LLM Gateway instead for more flexible chapter summaries. See the updated Auto Chapters page for details.

Note: This parameter is only supported for the Universal-2 model.

auto_highlights_result
object | null

An array of results for the Key Phrases model, if it is enabled. See Key Phrases for more information.

Example:
chapters
object[] | null

An array of temporally sequential chapters for the audio file. See Auto Chapters for more information.

confidence
number<double> | null

The confidence score for the transcript, between 0.0 (low confidence) and 1.0 (high confidence)

Required range: 0 <= x <= 1
content_safety
boolean | null

Whether Content Moderation is enabled, can be true or false

content_safety_labels
object | null

An array of results for the Content Moderation model, if it is enabled. See Content moderation for more information.

Example:
custom_spelling
object[] | null

Customize how words are spelled and formatted using to and from values. See Custom Spelling for more details.

disfluencies
boolean | null

Transcribe Filler Words, like "umm", in your media file; can be true or false. Supported on Universal-3.5 Pro and Universal-2.

domain
string | null

The domain-specific model applied to the transcript. When set to "medical-v1", Medical Mode was used to improve accuracy for medical terminology.

entities
object[] | null

An array of results for the Entity Detection model, if it is enabled. See Entity detection for more information.

entity_detection
boolean | null

Whether Entity Detection is enabled, can be true or false

error
string

Error message of why the transcript failed

filter_profanity
boolean | null

Whether Profanity Filtering is enabled, either true or false

format_text
boolean | null

Whether Text Formatting is enabled, either true or false

iab_categories
boolean | null

Whether Topic Detection is enabled, can be true or false

iab_categories_result
object | null

The result of the Topic Detection model, if it is enabled. See Topic Detection for more information.

Example:
keyterms_prompt
string[]

Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3.5 Pro) domain-specific words or phrases (maximum 6 words per phrase). See Keyterms Prompting for more details.

language_code

The language of your audio file. Possible values are found in Supported Languages. The default value is 'en_us'.

Available options:
en,
en_au,
en_uk,
en_us,
es,
fr,
de,
it,
pt,
nl,
af,
sq,
am,
ar,
hy,
as,
az,
ba,
eu,
be,
bn,
bs,
br,
bg,
my,
ca,
zh,
hr,
cs,
da,
et,
fo,
fi,
gl,
ka,
el,
gu,
ht,
ha,
haw,
he,
hi,
hu,
is,
id,
ja,
jw,
kn,
kk,
km,
ko,
lo,
la,
lv,
ln,
lt,
lb,
mk,
mg,
ms,
ml,
mt,
mi,
mr,
mn,
ne,
no,
nn,
oc,
pa,
ps,
fa,
pl,
ro,
ru,
sa,
sr,
sn,
sd,
si,
sk,
sl,
so,
su,
sw,
sv,
tl,
tg,
ta,
tt,
te,
th,
bo,
tr,
tk,
uk,
ur,
uz,
vi,
cy,
yi,
yo
language_codes
enum<string>[] | null

The language codes of your audio file. Used for Code switching One of the values specified must be en.

The language of your audio file. Possible values are found in Supported Languages. The default value is 'en_us'.

Available options:
en,
en_au,
en_uk,
en_us,
es,
fr,
de,
it,
pt,
nl,
af,
sq,
am,
ar,
hy,
as,
az,
ba,
eu,
be,
bn,
bs,
br,
bg,
my,
ca,
zh,
hr,
cs,
da,
et,
fo,
fi,
gl,
ka,
el,
gu,
ht,
ha,
haw,
he,
hi,
hu,
is,
id,
ja,
jw,
kn,
kk,
km,
ko,
lo,
la,
lv,
ln,
lt,
lb,
mk,
mg,
ms,
ml,
mt,
mi,
mr,
mn,
ne,
no,
nn,
oc,
pa,
ps,
fa,
pl,
ro,
ru,
sa,
sr,
sn,
sd,
si,
sk,
sl,
so,
su,
sw,
sv,
tl,
tg,
ta,
tt,
te,
th,
bo,
tr,
tk,
uk,
ur,
uz,
vi,
cy,
yi,
yo
language_detection
boolean | null

Whether Automatic language detection is enabled, either true or false

language_detection_options
object

Specify options for Automatic Language Detection.

multichannel
boolean | null

Whether Multichannel transcription was enabled in the transcription request, either true or false

prompt
string

Provide natural language prompting of up to 1,500 words of contextual information to the model. See the Prompting Guide for best practices.

Note: This parameter is only supported for the Universal-3.5 Pro model.

punctuate
boolean | null

Whether Automatic Punctuation is enabled, either true or false

redact_pii_audio
boolean | null

Whether a redacted version of the audio file was generated, either true or false. See PII redaction for more information.

redact_pii_audio_options
object

The options for PII-redacted audio, if redact_pii_audio is enabled. See PII redaction for more information.

redact_pii_audio_quality
enum<string> | null

The audio quality of the PII-redacted audio file, if redact_pii_audio is enabled. See PII redaction for more information.

Available options:
mp3,
wav
Example:

"mp3"

redact_pii_policies
enum<string>[] | null

The list of PII Redaction policies that were enabled, if PII Redaction is enabled. See PII redaction for more information.

The type of PII to redact

Available options:
account_number,
banking_information,
blood_type,
credit_card_cvv,
credit_card_expiration,
credit_card_number,
date,
date_interval,
date_of_birth,
drivers_license,
drug,
duration,
email_address,
event,
filename,
gender,
gender_sexuality,
healthcare_number,
injury,
ip_address,
language,
location,
location_address,
location_address_street,
location_city,
location_coordinate,
location_country,
location_state,
location_zip,
marital_status,
medical_condition,
medical_process,
money_amount,
nationality,
number_sequence,
occupation,
organization,
organization_medical_facility,
passport_number,
password,
person_age,
person_name,
phone_number,
physical_attribute,
political_affiliation,
religion,
sexuality,
statistics,
time,
url,
us_social_security_number,
username,
vehicle_id,
zodiac_sign
redact_pii_sub
enum<string>

The replacement logic for detected PII, can be entity_type or hash. See PII redaction for more details.

Available options:
entity_name,
hash
redact_pii_return_unredacted
boolean | null

Whether the original unredacted transcript was also returned alongside the redacted one. When true, the response includes unredacted_text, unredacted_words, and unredacted_utterances. See PII redaction for more information.

sentiment_analysis
boolean | null

Whether Sentiment Analysis is enabled, can be true or false

sentiment_analysis_results
object[] | null

An array of results for the Sentiment Analysis model, if it is enabled. See Sentiment Analysis for more information.

speaker_labels
boolean | null

Whether Speaker diarization is enabled, can be true or false

speakers_expected
integer | null

Tell the speaker label model how many speakers it should attempt to identify. See Set number of speakers expected for more details.

speech_model_used
enum<string>

The speech model that was actually used for the transcription. See Model Selection for available models.

Available options:
universal-3-5-pro,
universal-2
speech_models
enum<string>[] | null

List of speech models that were used (in priority order) to transcribe the audio. If not specified in the request, this defaults to universal-3-5-pro. See Model Selection for available models and routing behavior.

The speech model to use for the transcription. See Model Selection for available models.

Available options:
universal-3-5-pro,
universal-2
speech_threshold
number<float> | null

Defaults to null. Reject audio files that contain less than this fraction of speech. Valid values are in the range [0, 1] inclusive. See Speech Threshold for more details.

Required range: 0 <= x <= 1
speech_understanding
object

Speech understanding tasks like Translation, Speaker Identification, and Custom Formatting. See the task-specific docs for available options and configuration.

summary
string | null
deprecated

The generated summary of the media file, if Summarization is enabled. Deprecated - use LLM Gateway instead for more flexible summaries. See the updated Summarization page for details.

summary_model
string | null
deprecated

The Summarization model used to generate the summary, if Summarization is enabled. Deprecated - use LLM Gateway instead for more flexible summaries. See the updated Summarization page for details.

summary_type
string | null
deprecated

The type of summary generated, if Summarization is enabled. Deprecated - use LLM Gateway instead for more flexible summaries. See the updated Summarization page for details.

remove_audio_tags
enum<string> | null

Universal-3.5 Pro generates rich transcripts that can include inline annotations such as audio event markers and speaker cues. Set to "all" to remove all inline annotations, or "speaker" to remove only speaker cues while keeping other annotations.

Note: This parameter is only supported for the Universal-3.5 Pro model.

Available options:
all,
speaker
temperature
number | null

The temperature that was used for the model's response. See the Prompting Guide for more details.

Note: This parameter can only be used with the Universal-3.5 Pro model.

Required range: 0 <= x <= 1
text
string | null

The textual transcript of your media file

unredacted_text
string | null

The original textual transcript of your media file before PII redaction was applied. Only returned when redact_pii_return_unredacted was set to true on the transcription request, otherwise this field is omitted and the text field remains fully redacted. See PII redaction for more information.

throttled
boolean | null

True while a request is throttled and false when a request is no longer throttled

utterances
object[] | null

When multichannel or speaker_labels is enabled, a list of turn-by-turn utterance objects. See Speaker diarization and Multichannel transcription for more information.

unredacted_utterances
object[] | null

The original turn-by-turn utterance objects before PII redaction was applied. Same shape as utterances. Only returned when redact_pii_return_unredacted was set to true on the transcription request, otherwise this field is omitted and the utterances field remains fully redacted. See PII redaction for more information.

webhook_auth_header_name
string | null

The header name to be sent with the transcript completed or failed webhook requests

webhook_status_code
integer | null

The status code we received from your server when delivering the transcript completed or failed webhook request, if a webhook URL was provided

webhook_url
string<url> | null

The URL to which we send webhook requests.

words
object[] | null

An array of temporally-sequential word objects, one for each word in the transcript.

unredacted_words
object[] | null

The original temporally-sequential word objects before PII redaction was applied. Same shape as words. Only returned when redact_pii_return_unredacted was set to true on the transcription request, otherwise this field is omitted and the words field remains fully redacted. See PII redaction for more information.

custom_topics
boolean | null
deprecated

This parameter does not currently have any functionality attached to it.

speed_boost
boolean | null
deprecated

This parameter does not currently have any functionality attached to it.

topics
string[]
deprecated

This parameter does not currently have any functionality attached to it.

translated_texts
object

Translated text keyed by language code. See Translation for more details.