Transcripts

Delete transcript

DEL
Delete the transcript. Deleting does not delete the resource itself, but removes the data from the resource and marks it as deleted.

Path parameters

transcript_idstringRequired
ID of the transcript

Response

This endpoint returns an object
id
string
The unique identifier of your transcript
language_model
string
The language model that was used for the transcript
acoustic_model
string
The acoustic model that was used for the transcript
status
enum
The status of your transcript. Possible values are queued, processing, completed, or error.
Allowed values: queuedprocessingcompletederror
audio_url
string
The URL of the media that was transcribed
webhook_auth
boolean
Whether webhook authentication details were provided
auto_highlights
boolean
Whether Key Phrases is enabled, either true or false
redact_pii
boolean

Whether PII Redaction is enabled, either true or false

summarization
boolean

Whether Summarization is enabled, either true or false

language_code
enumOptional

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

text
stringOptional
The textual transcript of your media file
words
list of objectsOptional

An array of temporally-sequential word objects, one for each word in the transcript. See Speech recognition for more information.

utterances
list of objectsOptional

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

confidence
doubleOptional
The confidence score for the transcript, between 0.0 (low confidence) and 1.0 (high confidence)
audio_duration
integerOptional
The duration of this transcript object's media file, in seconds
punctuate
booleanOptional
Whether Automatic Punctuation is enabled, either true or false
format_text
booleanOptional
Whether Text Formatting is enabled, either true or false
dual_channel
booleanOptional

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

speech_model
enumOptional
The speech model to use for the transcription.
Allowed values: bestnanoconformer-2
webhook_url
stringOptional

The URL to which we send webhook requests. We sends two different types of webhook requests. One request when a transcript is completed or failed, and one request when the redacted audio is ready if redact_pii_audio is enabled.

webhook_status_code
integerOptional
The status code we received from your server when delivering the transcript completed or failed webhook request, if a webhook URL was provided
webhook_auth_header_name
stringOptional
The header name to be sent with the transcript completed or failed webhook requests
speed_boost
booleanOptional
Whether speed boost is enabled
auto_highlights_result
objectOptional

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

audio_start_from
integerOptional
The point in time, in milliseconds, in the file at which the transcription was started
audio_end_at
integerOptional
The point in time, in milliseconds, in the file at which the transcription was terminated
word_boost
list of stringsOptional
The list of custom vocabulary to boost transcription probability for
boost_param
stringOptional
The word boost parameter value
filter_profanity
booleanOptional

Whether Profanity Filtering is enabled, either true or false

redact_pii_audio
booleanOptional

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

redact_pii_audio_quality
enumOptional

Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See PII redaction for more details.

Allowed values: mp3wav
redact_pii_policies
list of enumsOptional

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

redact_pii_sub
enumOptional

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

Allowed values: entity_namehash
speaker_labels
booleanOptional

Whether Speaker diarization is enabled, can be true or false

speakers_expected
integerOptional

Tell the speaker label model how many speakers it should attempt to identify, up to 10. See Speaker diarization for more details.

content_safety
booleanOptional

Whether Content Moderation is enabled, can be true or false

content_safety_labels
objectOptional

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

iab_categories
booleanOptional

Whether Topic Detection is enabled, can be true or false

iab_categories_result
objectOptional

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

language_detection
booleanOptional

Whether Automatic language detection is enabled, either true or false

custom_spelling
list of objectsOptional
Customize how words are spelled and formatted using to and from values
auto_chapters
booleanOptional

Whether Auto Chapters is enabled, can be true or false

chapters
list of objectsOptional
An array of temporally sequential chapters for the audio file
summary_type
stringOptional

The type of summary generated, if Summarization is enabled

summary_model
stringOptional

The Summarization model used to generate the summary, if Summarization is enabled

summary
stringOptional

The generated summary of the media file, if Summarization is enabled

custom_topics
booleanOptional
Whether custom topics is enabled, either true or false
topics
list of stringsOptional
The list of custom topics provided if custom topics is enabled
disfluencies
booleanOptional
Transcribe Filler Words, like "umm", in your media file; can be true or false
sentiment_analysis
booleanOptional

Whether Sentiment Analysis is enabled, can be true or false

sentiment_analysis_results
list of objectsOptional

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

entity_detection
booleanOptional

Whether Entity Detection is enabled, can be true or false

entities
list of objectsOptional

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

speech_threshold
doubleOptional
Defaults to null. Reject audio files that contain less than this fraction of speech. Valid values are in the range [0, 1] inclusive.
throttled
booleanOptional
True while a request is throttled and false when a request is no longer throttled
error
stringOptional
Error message of why the transcript failed