Transcribe audio

To use our EU server for transcription, replace api.assemblyai.com with api.eu.assemblyai.com.
Create a transcript from a media file that is accessible via a URL.

Headers

AuthorizationstringRequired

Request

Params to create a transcript
audio_urlstringRequiredformat: "url"
The URL of the audio or video file to transcribe.
audio_end_atintegerOptional
The point in time, in milliseconds, to stop transcribing in your media file
audio_start_fromintegerOptional
The point in time, in milliseconds, to begin transcribing in your media file
auto_chaptersbooleanOptionalDefaults to false

Enable Auto Chapters, can be true or false

auto_highlightsbooleanOptionalDefaults to false
Enable Key Phrases, either true or false
boost_paramenumOptional
How much to boost specified words
Allowed values:
content_safetybooleanOptionalDefaults to false

Enable Content Moderation, can be true or false

content_safety_confidenceintegerOptional>=25<=100Defaults to 50
The confidence threshold for the Content Moderation model. Values must be between 25 and 100.
custom_spellinglist of objectsOptional
Customize how words are spelled and formatted using to and from values
disfluenciesbooleanOptionalDefaults to false

Transcribe Filler Words, like “umm”, in your media file; can be true or false

entity_detectionbooleanOptionalDefaults to false

Enable Entity Detection, can be true or false

filter_profanitybooleanOptionalDefaults to false
Filter profanity from the transcribed text, can be true or false
format_textbooleanOptionalDefaults to true
Enable Text Formatting, can be true or false
iab_categoriesbooleanOptionalDefaults to false

Enable Topic Detection, can be true or false

keyterms_promptlist of stringsOptional

keyterms_prompt is only supported when the speech_model is specified as slam-1
Improve accuracy with up to 1000 domain-specific words or phrases (maximum 6 words per phrase).

language_codeenumOptional

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

language_confidence_thresholddoubleOptional
The confidence threshold for the automatically detected language. An error will be returned if the language confidence is below this threshold. Defaults to 0.
language_detectionbooleanOptionalDefaults to false

Enable Automatic language detection, either true or false.

multichannelbooleanOptionalDefaults to false

Enable Multichannel transcription, can be true or false.

punctuatebooleanOptionalDefaults to true
Enable Automatic Punctuation, can be true or false
redact_piibooleanOptionalDefaults to false
Redact PII from the transcribed text using the Redact PII model, can be true or false
redact_pii_audiobooleanOptionalDefaults to false

Generate a copy of the original media file with spoken PII “beeped” out, can be true or false. See PII redaction for more details.

redact_pii_audio_optionsobjectOptional
Specify options for PII redacted audio files.
redact_pii_audio_qualityenumOptional

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:
redact_pii_policieslist of enumsOptional

The list of PII Redaction policies to enable. See PII redaction for more details.

redact_pii_subenumOptional

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

Allowed values:
sentiment_analysisbooleanOptionalDefaults to false

Enable Sentiment Analysis, can be true or false

speaker_labelsbooleanOptionalDefaults to false

Enable Speaker diarization, can be true or false

speaker_optionsobjectOptional
Specify options for speaker diarization.
speakers_expectedintegerOptional

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

speech_modelenumOptional

The speech model to use for the transcription. When null, the universal model is used.

Allowed values:
speech_thresholddoubleOptional

Reject audio files that contain less than this fraction of speech. Valid values are in the range [0, 1] inclusive.

summarizationbooleanOptionalDefaults to false

Enable Summarization, can be true or false

summary_modelenumOptional
The model to summarize the transcript
Allowed values:
summary_typeenumOptional
The type of summary
Allowed values:
topicslist of stringsOptional
The list of custom topics
webhook_auth_header_namestringOptional
The header name to be sent with the transcript completed or failed webhook requests
webhook_auth_header_valuestringOptional
The header value to send back with the transcript completed or failed webhook requests for added security
webhook_urlstringOptionalformat: "url"

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.

custom_topicsbooleanOptionalDefaults to falseDeprecated
Enable custom topics, either true or false
dual_channelbooleanOptionalDefaults to falseDeprecated

Enable Dual Channel transcription, can be true or false.

promptstringOptionalDeprecated
This parameter does not currently have any functionality attached to it.
word_boostlist of stringsOptionalDeprecated
The list of custom vocabulary to boost transcription probability for

Response

Transcript created and queued for processing
idstringformat: "uuid"
The unique identifier of your transcript
audio_urlstringformat: "url"
The URL of the media that was transcribed
statusenum
The status of your transcript. Possible values are queued, processing, completed, or error.
Allowed values:
webhook_authboolean
Whether webhook authentication details were provided
auto_highlightsboolean
Whether Key Phrases is enabled, either true or false
redact_piiboolean

Whether PII Redaction is enabled, either true or false

summarizationboolean

Whether Summarization is enabled, either true or false

language_modelstringDeprecated
The language model that was used for the transcript
acoustic_modelstringDeprecated
The acoustic model that was used for the transcript
language_codeenum or null

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

language_detectionboolean or null

Whether Automatic language detection is enabled, either true or false

language_confidence_thresholddouble or null
The confidence threshold for the automatically detected language. An error will be returned if the language confidence is below this threshold.
language_confidencedouble or null>=0<=1

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

speech_modelenum or null

The speech model used for the transcription. When null, the universal model is used.

Allowed values:
textstring or null
The textual transcript of your media file
wordslist of objects or null

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

utteranceslist of objects or 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.

confidencedouble or null>=0<=1

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

audio_durationinteger or null
The duration of this transcript object's media file, in seconds
punctuateboolean or null
Whether Automatic Punctuation is enabled, either true or false
format_textboolean or null
Whether Text Formatting is enabled, either true or false
disfluenciesboolean or null

Transcribe Filler Words, like “umm”, in your media file; can be true or false

multichannelboolean or null

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

audio_channelsinteger or null
The number of audio channels in the audio file. This is only present when multichannel is enabled.
webhook_urlstring or nullformat: "url"

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_codeinteger or 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_auth_header_namestring or null
The header name to be sent with the transcript completed or failed webhook requests
auto_highlights_resultobject or null

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

audio_start_frominteger or null
The point in time, in milliseconds, in the file at which the transcription was started
audio_end_atinteger or null
The point in time, in milliseconds, in the file at which the transcription was terminated
boost_paramstring or null
The word boost parameter value
filter_profanityboolean or null

Whether Profanity Filtering is enabled, either true or false

redact_pii_audioboolean or null

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

redact_pii_audio_qualityenum or null

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

Allowed values:
redact_pii_policieslist of enums or null

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

redact_pii_subenum or null

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

Allowed values:
speaker_labelsboolean or null

Whether Speaker diarization is enabled, can be true or false

speakers_expectedinteger or null

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

content_safetyboolean or null

Whether Content Moderation is enabled, can be true or false

content_safety_labelsobject or null

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

iab_categoriesboolean or null

Whether Topic Detection is enabled, can be true or false

iab_categories_resultobject or null

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

custom_spellinglist of objects or null
Customize how words are spelled and formatted using to and from values
keyterms_promptlist of strings or null

Improve accuracy with up to 1000 domain-specific words or phrases (maximum 6 words per phrase).

auto_chaptersboolean or null

Whether Auto Chapters is enabled, can be true or false

chapterslist of objects or null
An array of temporally sequential chapters for the audio file
summary_typestring or null

The type of summary generated, if Summarization is enabled

summary_modelstring or null

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

summarystring or null

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

topicslist of strings or null
The list of custom topics provided if custom topics is enabled
sentiment_analysisboolean or null

Whether Sentiment Analysis is enabled, can be true or false

sentiment_analysis_resultslist of objects or null

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

entity_detectionboolean or null

Whether Entity Detection is enabled, can be true or false

entitieslist of objects or null

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

speech_thresholddouble or null

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

throttledboolean or null
True while a request is throttled and false when a request is no longer throttled
errorstring or null
Error message of why the transcript failed
dual_channelboolean or nullDeprecated

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

speed_boostboolean or nullDeprecated
Whether speed boost is enabled
word_boostlist of strings or nullDeprecated
The list of custom vocabulary to boost transcription probability for
promptstring or nullDeprecated
This parameter does not currently have any functionality attached to it.
custom_topicsboolean or nullDeprecated
Whether custom topics is enabled, either true or false

Errors