Create transcript

POST
/v1/speech-to-text

Transcribe an audio or video file.

Query parameters

enable_loggingbooleanOptionalDefaults to true

When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers.

Request

This endpoint expects a multipart form containing a file.
model_idstringRequired

The ID of the model to use for transcription, currently only ‘scribe_v1’ is available.

filefileRequired

The file to transcribe. All major audio and video formats are supported. The file size must be less than 1GB.

language_codestringOptional

An ISO-639-1 or ISO-639-3 language_code corresponding to the language of the audio file. Can sometimes improve transcription performance if known beforehand. Defaults to null, in this case the language is predicted automatically.

tag_audio_eventsbooleanOptionalDefaults to true

Whether to tag audio events like (laughter), (footsteps), etc. in the transcription.

num_speakersintegerOptional>=1<=32

The maximum amount of speakers talking in the uploaded file. Can help with predicting who speaks when. The maximum amount of speakers that can be predicted is 32. Defaults to null, in this case the amount of speakers is set to the maximum value the model supports.

timestamps_granularityenumOptionalDefaults to word

The granularity of the timestamps in the transcription. ‘word’ provides word-level timestamps and ‘character’ provides character-level timestamps per word.

Allowed values: nonewordcharacter
diarizebooleanOptionalDefaults to false

Whether to annotate which speaker is currently talking in the uploaded file.

biased_keywordslist of stringsOptional

A list of keywords and their biases. The keywords are the words that you want to bias the transcription towards. The biases decide how much the model should boost or suppress the keyword. The biases should be numbers between -10 and 10. The number of keywords cannot exceed 100. The length of each keyword must be less than 50 characters. Each keyword-bias pair must be separated by a colon. For example [“keyword_a:0.42”, “keyword_b:-0.5”]

Response

Successful Response

language_codestring

The detected language code (e.g. ‘eng’ for English).

language_probabilitydouble

The confidence score of the language detection (0 to 1).

textstring

The raw text of the transcription.

wordslist of objects

List of words with their timing information.

Errors

Built with