Authorization
header · string · obligatoire
Use `Authorization: Token <API_KEY>`
Example: `Authorization: Token 12345abcdef`
url
body · string · obligatoire
callback
query · string · facultatif
URL to which we'll make the callback request
callback_method
query · string · facultatif
HTTP method by which the callback request will be made
par défaut "POST"2 valeurs d’énumération
Valeurs
POSTPUT
custom_intent
query · string | array · facultatif
Custom intents you want the model to detect within your input audio if present
custom_intent_mode
query · string · facultatif
Sets how the model will interpret intents submitted to the `custom_intent` param. When `strict`, the model will only return intents submitted using the `custom_intent` param. When `extended`, the model will return its own detected intents in the `custom_intent` param.
par défaut "extended"2 valeurs d’énumération
Valeurs
extendedstrict
custom_topic
query · string | array · facultatif
Custom topics you want the model to detect within your input audio or text if present Submit up to `100`.
custom_topic_mode
query · string · facultatif
Sets how the model will interpret strings submitted to the `custom_topic` param. When `strict`, the model will only return topics submitted using the `custom_topic` param. When `extended`, the model will return its own detected topics in addition to those submitted using the `custom_topic` param
par défaut "extended"2 valeurs d’énumération
Valeurs
extendedstrict
detect_entities
query · boolean · facultatif
Identifies and extracts key entities from content in submitted audio
par défaut false
detect_language
query · boolean | array · facultatif
Identifies the dominant language spoken in submitted audio
diarize
query · boolean · facultatif
Deprecated: use `diarize_model` instead. Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0.
par défaut false
diarize_model
query · string · facultatif
Select and enable a specific diarization model version. Specifying this parameter enables diarization and selects the model — you do not need to also set the deprecated `diarize=true` parameter. For batch, supported values are `latest` (currently v2), `v1`, and `v2`. For streaming, supported values are `latest` (currently v1) and `v1`; `v2` returns a validation error on streaming requests.
3 valeurs d’énumération
Valeurs
latestv1v2
dictation
query · boolean · facultatif
Dictation mode for controlling formatting with dictated speech
par défaut false
encoding
query · string · facultatif
Specify the expected encoding of your submitted audio
8 valeurs d’énumération
Valeurs
linear16flacmulawamr-nbamr-wbopusspeexg729
extra
query · string | array · facultatif
Arbitrary key-value pairs that are attached to the API response for usage in downstream processing
filler_words
query · boolean · facultatif
Filler Words can help transcribe interruptions in your audio, like "uh" and "um"
par défaut false
intents
query · boolean · facultatif
Recognizes speaker intent throughout a transcript or text
par défaut false
keyterm
query · array · facultatif
Key term prompting can boost or suppress specialized terminology and brands. Only compatible with Nova-3
keywords
query · string | array · facultatif
Keywords can boost or suppress specialized terminology and brands
language
query · string · facultatif
The [BCP-47 language tag](https://tools.ietf.org/html/bcp47) that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available
par défaut "en"
measurements
query · boolean · facultatif
Spoken measurements will be converted to their corresponding abbreviations
par défaut false
mip_opt_out
query · boolean · facultatif
Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip
par défaut false
model
query · string | string · facultatif
AI model used to process submitted audio
29 valeurs d’énumération
Valeurs
nova-3nova-3-generalnova-3-medicalnova-2nova-2-generalnova-2-meetingnova-2-financenova-2-conversationalainova-2-voicemailnova-2-videonova-2-medicalnova-2-drivethrunova-2-automotivenovanova-generalnova-phonecallnova-medicalenhancedenhanced-generalenhanced-meetingenhanced-phonecallenhanced-financebasemeetingphonecallfinanceconversationalaivoicemailvideo
multichannel
query · boolean · facultatif
Transcribe each audio channel independently
par défaut false
numerals
query · boolean · facultatif
Numerals converts numbers from written format to numerical format
par défaut false
paragraphs
query · boolean · facultatif
Splits audio into paragraphs to improve transcript readability
par défaut false
profanity_filter
query · boolean · facultatif
Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely
par défaut false
punctuate
query · boolean · facultatif
Add punctuation and capitalization to the transcript
par défaut false
redact
query · string | array · facultatif
Redaction removes sensitive information from your transcripts
replace
query · string | array · facultatif
Search for terms or phrases in submitted audio and replaces them
search
query · string | array · facultatif
Search for terms or phrases in submitted audio
sentiment
query · boolean · facultatif
Recognizes the sentiment throughout a transcript or text
par défaut false
smart_format
query · boolean · facultatif
Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability
par défaut false
summarize
query · string | boolean · facultatif
Summarize content. For Listen API, supports string version option. For Read API, accepts boolean only.
1 valeur d’énumération
Valeurs
v2
tag
query · string | array · facultatif
Label your requests for the purpose of identification during usage reporting
topics
query · boolean · facultatif
Detect topics throughout a transcript or text
par défaut false
utt_split
query · number · facultatif
Seconds to wait before detecting a pause between words in submitted audio
par défaut 0.8
utterances
query · boolean · facultatif
Segments speech into meaningful semantic units
par défaut false
version
query · string | string · facultatif
Version of an AI model to use
1 valeur d’énumération
Valeurs
latest