Authorization
header · string · 必須
Use `Authorization: Token <API_KEY>`
Example: `Authorization: Token 12345abcdef`
callback
query · string · 任意
URL to which we'll make the callback request
callback_method
query · string · 任意
HTTP method by which the callback request will be made
デフォルト "POST"2個の列挙値
値
POSTPUT
custom_intent
query · string | array · 任意
Custom intents you want the model to detect within your input audio if present
custom_intent_mode
query · string · 任意
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.
デフォルト "extended"2個の列挙値
値
extendedstrict
custom_topic
query · string | array · 任意
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 · 任意
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
デフォルト "extended"2個の列挙値
値
extendedstrict
detect_entities
query · boolean · 任意
Identifies and extracts key entities from content in submitted audio
デフォルト false
detect_language
query · boolean | array · 任意
Identifies the dominant language spoken in submitted audio
diarize
query · boolean · 任意
Deprecated: use `diarize_model` instead. Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0.
デフォルト false
diarize_model
query · string · 任意
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個の列挙値
値
latestv1v2
dictation
query · boolean · 任意
Dictation mode for controlling formatting with dictated speech
デフォルト false
encoding
query · string · 任意
Specify the expected encoding of your submitted audio
8個の列挙値
値
linear16flacmulawamr-nbamr-wbopusspeexg729
extra
query · string | array · 任意
Arbitrary key-value pairs that are attached to the API response for usage in downstream processing
filler_words
query · boolean · 任意
Filler Words can help transcribe interruptions in your audio, like "uh" and "um"
デフォルト false
intents
query · boolean · 任意
Recognizes speaker intent throughout a transcript or text
デフォルト false
keyterm
query · array · 任意
Key term prompting can boost or suppress specialized terminology and brands. Only compatible with Nova-3
keywords
query · string | array · 任意
Keywords can boost or suppress specialized terminology and brands
language
query · string · 任意
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
デフォルト "en"
measurements
query · boolean · 任意
Spoken measurements will be converted to their corresponding abbreviations
デフォルト false
mip_opt_out
query · boolean · 任意
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
デフォルト false
model
query · string | string · 任意
AI model used to process submitted audio
29個の列挙値
値
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 · 任意
Transcribe each audio channel independently
デフォルト false
numerals
query · boolean · 任意
Numerals converts numbers from written format to numerical format
デフォルト false
paragraphs
query · boolean · 任意
Splits audio into paragraphs to improve transcript readability
デフォルト false
profanity_filter
query · boolean · 任意
Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely
デフォルト false
punctuate
query · boolean · 任意
Add punctuation and capitalization to the transcript
デフォルト false
redact
query · string | array · 任意
Redaction removes sensitive information from your transcripts
replace
query · string | array · 任意
Search for terms or phrases in submitted audio and replaces them
search
query · string | array · 任意
Search for terms or phrases in submitted audio
sentiment
query · boolean · 任意
Recognizes the sentiment throughout a transcript or text
デフォルト false
smart_format
query · boolean · 任意
Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability
デフォルト false
summarize
query · string | boolean · 任意
Summarize content. For Listen API, supports string version option. For Read API, accepts boolean only.
1個の列挙値
値
v2
tag
query · string | array · 任意
Label your requests for the purpose of identification during usage reporting
topics
query · boolean · 任意
Detect topics throughout a transcript or text
デフォルト false
utt_split
query · number · 任意
Seconds to wait before detecting a pause between words in submitted audio
デフォルト 0.8
utterances
query · boolean · 任意
Segments speech into meaningful semantic units
デフォルト false
version
query · string | string · 任意
Version of an AI model to use
1個の列挙値
値
latest