Skip to main content
Deepgram logo
  • Category: audio & speech
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 17
  • Triggers: 0
  • Slug: DEEPGRAM
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Tools

Slug: DEEPGRAM_GET_MODELRetrieve metadata for a specific Deepgram model by its UUID. Returns detailed model information including name, architecture, supported languages, version, and capabilities. Works for both STT (speech-to-text) and TTS (text-to-speech) models.Instant: Supported on the latest version.Instant pricing: $0 per request

Input Parameters

string
required
The specific UUID of the model to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_GET_MODELSRetrieve metadata on all public Deepgram models (speech-to-text and text-to-speech). Returns comprehensive model information including supported languages, architectures, versions, and capabilities. Set include_outdated to True to include deprecated versions.Instant: Supported on the latest version.Instant pricing: $0 per request

Input Parameters

boolean
If true, include all versions of every model; otherwise only the latest.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_GET_PROJECT_BALANCERetrieve one balance for a Deepgram project in its native units.

Input Parameters

string
required
Unique identifier of the project balance
string
required
Unique identifier of the Deepgram project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_GET_PROJECT_BILLING_BREAKDOWNGet a project’s billing breakdown for an optional date range, preserving provider-reported amounts and units.

Input Parameters

string
End of the billing range in YYYY-MM-DD or ISO 8601 format.
string
Start of the billing range in YYYY-MM-DD or ISO 8601 format.
string
required
Unique identifier of the Deepgram project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_GET_PROJECT_REQUESTRetrieve one request log for a Deepgram project by ID.

Input Parameters

string
required
Unique identifier of the Deepgram project.
string
required
Unique identifier of the project request log.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_GET_PROJECTSList Deepgram projects accessible to the API key. Projects missing an ID or name are omitted from the returned list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_GET_PROJECT_USAGE_BREAKDOWNGet project usage grouped by provider usage fields, preserving native units.

Input Parameters

string
End of the usage range in YYYY-MM-DD or ISO 8601 format.
string
Start of the usage range in YYYY-MM-DD or ISO 8601 format.
string
required
Unique identifier of the Deepgram project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_GET_PROJECT_USAGE_SUMMARYRetrieve aggregated project usage statistics, including speech durations, requests, channels, confidence and relevance, with usage breakdowns by model, accessor and tag. A 404 response is returned as an all-zero summary with an empty breakdown.

Input Parameters

string
End date for the usage summary range. Accepts YYYY-MM-DD or ISO 8601 format (e.g., ‘2024-01-31’ or ‘2024-01-31T23:59:59Z’)
string
Filter usage by request tag. Returns only usage from requests tagged with this value
string
Filter usage by Deepgram model name (e.g., ‘nova-2’, ‘general’, ‘whisper’). Returns only usage from requests that used this model
string
Start date for the usage summary range. Accepts YYYY-MM-DD or ISO 8601 format (e.g., ‘2024-01-01’ or ‘2024-01-01T00:00:00Z’)
string
required
Unique identifier of the Deepgram project
string
Filter usage by API key or user accessor ID. Returns only usage attributed to this specific accessor

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_LIST_PROJECT_BALANCESList all balances for a Deepgram project without converting their native amounts or units.

Input Parameters

string
required
Unique identifier of the Deepgram project whose balances to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_LIST_PROJECT_BILLING_FIELDSReturn the fields available for project billing breakdowns.

Input Parameters

string
End of the billing range in YYYY-MM-DD or ISO 8601 format.
string
Start of the billing range in YYYY-MM-DD or ISO 8601 format.
string
required
Unique identifier of the Deepgram project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_LIST_PROJECT_PURCHASESList purchases for a Deepgram project without converting native values.

Input Parameters

integer
Maximum number of purchases to return.
string
required
Unique identifier of the Deepgram project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_LIST_PROJECT_REQUESTSList request logs for a Deepgram project with date and page controls.

Input Parameters

string
End of the request-log range in ISO 8601 format.
integer
Zero-based page number to retrieve.
integer
Maximum number of request logs to return.
string
Start of the request-log range in ISO 8601 format.
string
required
Unique identifier of the Deepgram project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_LIST_PROJECT_SCOPESReturn a static list of Deepgram permission scope types and their descriptions. The list is the same for every supplied project ID.

Input Parameters

string
required
Unique identifier of the Deepgram project to list scopes for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_LIST_PROJECT_USAGE_FIELDSReturn the fields available for project usage breakdowns.

Input Parameters

string
End of the usage range in YYYY-MM-DD or ISO 8601 format.
string
Start of the usage range in YYYY-MM-DD or ISO 8601 format.
string
required
Unique identifier of the Deepgram project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_LIST_THINK_MODELSTool to list available think models for AI agent processing and voice agent configuration. Use when you need to see which think models are available for voice agents.Instant: Supported on the latest version.Instant pricing: $0 per request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_SPEECH_TO_TEXT_PRE_RECORDEDTranscribe pre-recorded audio from a publicly accessible URL, returning the primary transcript in the first channel and alternative. Managed access is limited to Nova-3 English mono PCM WAV audio up to 60 seconds and 8 MiB, without paid add-ons; other options require a Deepgram account.Instant: Supported on the latest version.Instant pricing: $0.004 per audio minute for prerecorded Nova-3 English transcriptionDiscount: 10

Input Parameters

string
Enhanced tier for higher-accuracy recognition. Requires your own Deepgram key.
string
Deepgram model to use (e.g., ‘nova-3’, ‘general’, ‘phonecall’). Without your own Deepgram key, only ‘nova-3’ is supported and is used when omitted.
boolean
Enable speaker diarization if true. Requires your own Deepgram key.
array
List of keyterms to boost in the transcript. Supported by Nova-3 and Flux models only. Use simple terms without intensifiers (e.g., ‘invoice’, ‘payment terms’). For other models, use ‘keywords’ instead. Requires your own Deepgram key.
string
Specific model version to use. Requires your own Deepgram key.
array
List of keywords to boost in the transcript. Supported by Nova-2, Nova-1, Enhanced, and Base models. Format: ‘keyword:intensifier’ (e.g., ‘invoice:5’). For Nova-3 or Flux models, use ‘keyterm’ instead. Requires your own Deepgram key.
string
Language code for transcription (e.g., ‘en-US’). Without your own Deepgram key, only ‘en’ or ‘en-US’ is supported and ‘en’ is used when omitted.
string
required
Public URL of the audio file to transcribe. Must be a direct, publicly downloadable media file URL — not a preview page, auth-gated link, or expiring/short-lived URL.
boolean
Automatically punctuate transcript.
integer
Number of alternative transcripts to return.
string ("audio/wav" | "audio/mp3" | "audio/mpeg" | "audio/flac" | "audio/webm")
required
MIME type of the audio file. Without your own Deepgram key, only ‘audio/wav’ is supported.
boolean
Apply smart formatting (capitalization/punctuation).
boolean
Automatically detect language if true. Prefer explicit language over this when the audio language is known; auto-detection reduces accuracy for non-English content. Requires your own Deepgram key.
boolean
Return interim results if true. Requires your own Deepgram key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEPGRAM_TEXT_TO_SPEECH_RESTConvert text to speech and return base64-encoded audio with its content type. Managed access uses Aura-2 Thalia English and accepts up to 1,000 characters without voice, version, language, speed or pitch overrides.Instant: Supported on the latest version.Instant pricing: $0.03 per 1,000 Aura-2 charactersDiscount: 10

Input Parameters

string
required
The text to be synthesized into speech.
string
Deepgram TTS model to use (e.g., ‘aura-2-thalia-en’). Without your own Deepgram key, only ‘aura-2-thalia-en’ is supported and is used when omitted; other models such as ‘aura-asteria-en’ need your own Deepgram key.
number
Pitch adjustment multiplier (0.5–2.0).
number
Speech rate multiplier (0.25–4.0).
string
Desired voice within the selected model.
string
Model version identifier.
string
Audio encoding type (e.g., ‘linear16’, ‘mp3’).
string
Language code for synthesis (e.g., ‘en-US’).
string
Container format for audio (e.g., ‘wav’, ‘mp3’).
integer
Desired sample rate for output audio in Hz (e.g., 16000).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not