Transcript

Method	Endpoint	Description
POST	/v2/transcript	Create a transcript using the parameters described below.
GET	/v2/transcript/:id	Fetch the transcript object you created, using its id.
GET	/v2/transcript/:id/sentences	Optionally, after your transcript is complete, get the sentences using its id.
GET	/v2/transcript/:id/paragraphs	Optionally, after your transcript is complete, get the paragraphs using its id.
GET	/v2/transcript/:id/redacted-audio	If you enable PII redaction, get the redacted audio, as described in the Create a redacted audio file section.
GET	/v2/transcript/:id/:subtitle_format	Export your completed transcripts in SRT (srt) or VTT (vtt) format, which can be used for subtitles and closed captions in videos.

The Transcript Object

Attribute	Type	Description
id	string	The unique identifier of your transcription
status	string	The status of your transcription. queued, processing, completed, or error
language_code	string	The language of your audio file. The default value is en_us.
audio_url	string	The URL of your media file to transcribe
text	string	The text transcription of your media file
words	array	A list of all the individual words transcribed
utterances	array	When dual_channel or speaker_labels is enabled, a list of turn-by-turn utterances
confidence	float	The confidence our model has in the transcribed text, between 0.0 and 1.0
audio_duration	float	The duration of your media file, in seconds
punctuate	boolean	Enable Automatic Punctuation, can be true or false
format_text	boolean	Enable Text Formatting, can be true or false
dual_channel	boolean	Enable Dual Channel transcription, can be true or false
webhook_url	string	The URL we should send webhooks to when your transcript is complete
webhook_auth_header_name	string	Defaults to null. Optionally allows a user to specify a header name and value to send back with a webhook call for added security.
webhook_auth_header_value	string	Defaults to null. Optionally allows a user to specify a header name and value to send back with a webhook call for added security.
webhook_status_code	string	The status code we received from your server when delivering your webhook
auto_highlights_result	array	The list of results when enabling Automatic Transcript Highlights
audio_start_from	integer	The point in time, in milliseconds, to begin transcription from in your media file
audio_end_at	integer	The point in time, in milliseconds, to stop transcribing in your media file
word_boost	array	A list of custom vocabulary to boost accuracy for
boost_param	string	The weight to apply to words/phrases in the word_boost array; can be "low", "default", or "high"
filter_profanity	boolean	Filter profanity from the transcribed text, can be true or false
redact_pii	boolean	Redact PII from the transcribed text, can be true or false
redact_pii_audio	boolean	Generate a copy of the original media file with spoken PII "beeped" out, can be true or false
redact_pii_policies	array	The list of PII Redaction policies to enable
redact_pii_sub	string	The replacement logic for detected PII, can be "entity_type" or "hash"
speaker_labels	boolean	Enable Speaker Diarization, can be true or false
speakers_expected	integer	Defaults to null. Tells the speaker label model how many speakers it should attempt to identify, up to 10.
content_safety	boolean	Enable Content Moderation, can be true or false
iab_categories	boolean	Enable Topic Detection, can be true or false
content_safety_labels	array	The list of results when content_safety is true
iab_categories_result	array	The list of results when iab_categories is true
custom_spelling	array	Customize how words are spelled and formatted using to and from values
disfluencies	boolean	Transcribe Filler Words, like "umm", in your media file; can be true or false
sentiment_analysis	boolean	Enable Sentiment Analysis, can be true or false
auto_chapters	boolean	Enable Auto Chapters, can be true or false
chapters	array	When Auto Chapters is enabled, the list of Auto Chapters results
sentiment_analysis_results	array	When Sentiment Analysis is enabled, the list of Sentiment Analysis results
entity_detection	boolean	Enable Entity Detection, can be true or false
entities	array	When Entity Detection is enabled, the list of detected Entities
throttled	boolean	True while a request is throttled and false when a request is no longer throttled

Create a transcript

Parameter	Type	Description	Required
audio_url	string	The URL of your media file to transcribe	Yes
language_code	string	The language of your audio file. Possible values are found in Supported Languages. The default value is en_us.
punctuate	boolean	Enable Automatic Punctuation, can be true or false
format_text	boolean	Enable Text Formatting, can be true or false
dual_channel	boolean	Enable Dual Channel transcription, can be true or false
webhook_url	string	The URL we should send webhooks to when your transcript is complete
webhook_auth_header_name	string	Defaults to null. Optionally allows a user to specify a header name and value to send back with a webhook call for added security.
webhook_auth_header_value	string	Defaults to null. Optionally allows a user to specify a header name and value to send back with a webhook call for added security.
audio_start_from	integer	The point in time, in milliseconds, to begin transcription from in your media file
audio_end_at	integer	The point in time, in milliseconds, to stop transcribing in your media file
word_boost	array	A list of custom vocabulary to boost accuracy for
boost_param	string	The weight to apply to words/phrases in the word_boost array; can be "low", "default", or "high"
filter_profanity	boolean	Filter profanity from the transcribed text, can be true or false
redact_pii	boolean	Redact PII from the transcribed text, can be true or false
redact_pii_audio	boolean	Generate a copy of the original media file with spoken PII "beeped" out, can be true or false
redact_pii_audio_quality	string	Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav.
redact_pii_policies	array	The list of PII Redaction policies to enable
redact_pii_sub	string	The replacement logic for detected PII, can be "entity_type" or "hash"
speaker_labels	boolean	Enable Speaker Diarization, can be true or false
speakers_expected	integer	Defaults to null. Tells the speaker label model how many speakers it should attempt to identify, up to 10.
content_safety	boolean	Enable Content Moderation, can be true or false
iab_categories	boolean	Enable Topic Detection, can be true or false
custom_spelling	array	Customize how words are spelled and formatted using to and from values
disfluencies	boolean	Transcribe Filler Words, like "umm", in your media file; can be true or false
sentiment_analysis	boolean	Enable Sentiment Analysis, can be true or false
auto_chapters	boolean	Enable Auto Chapters, can be true or false
entity_detection	boolean	Enable Entity Detection, can be true or false