REST API

Retrieves the available think models that can be used for AI agent processing

Returns all agent configurations for the specified project. Configurations are returned in their uninterpolated form—template variable placeholders appear as-is rather than with their substituted values.

Creates a new reusable agent configuration. The `config` field must be a valid JSON string representing the `agent` block of a Settings message. The returned `agent_id` can be passed in place of the full `agent` object in future Settings messages.

Returns the specified agent configuration in its uninterpolated form

Updates the metadata associated with an agent configuration. The config itself is immutable—to change the configuration, delete the existing agent and create a new one.

Deletes the specified agent configuration. Deleting an agent configuration can cause a production outage if your service references this agent UUID. Migrate all active sessions to a new configuration before deleting.

Returns all template variables for the specified project

Creates a new template variable. Variables follow the `DG_<VARIABLE_NAME>` naming format and can substitute any JSON value in an agent configuration.

Returns the specified template variable

Updates the value of an existing template variable

Deletes the specified template variable

Transcribe audio and video using Deepgram's speech-to-text REST API

Convert text into natural-sounding speech using Deepgram's TTS REST API

Analyze text content using Deepgrams text analysis API

Retrieves basic information about the projects associated with the API key

Retrieves information about the specified project

Updates the name or other properties of an existing project

Deletes the specified project

Removes the authenticated account from the specific project

Returns metadata on all the latest models that a specific project has access to, including non-public models

Returns metadata for a specific model

Returns metadata on all the latest public models. To retrieve custom models, use Get Project Models.

Returns metadata for a specific public model

Retrieves all API keys associated with the specified project

Creates a new API key with specified settings for the project

Retrieves information about a specified API key

Deletes an API key for a specific project

Retrieves a list of members for a given project

Removes a member from the project using their unique member ID

Retrieves a list of scopes for a specific member

Updates the scopes for a specific member

Generates a list of invites for a specific project

Generates an invite for a specific project

Deletes an invite for a specific project

Generates a list of requests for a specific project

Retrieves a specific request for a specific project

Retrieves the usage for a specific project. Use Get Project Usage Breakdown for a more comprehensive usage summary.

Lists the features, models, tags, languages, and processing method used for requests in the specified project

Retrieves the usage breakdown for a specific project, with various filter options by API feature or by groupings. Setting a feature (e.g. diarize) to true includes requests that used that feature, while false excludes requests that used it. Multiple true filters are combined with OR logic, while false filters use AND logic.

Generates a list of outstanding balances for the specified project

Retrieves details about the specified balance

Retrieves the billing summary for a specific project, with various filter options or by grouping options.

Lists the accessors, deployment types, tags, and line items used for billing data in the specified time period. Use this endpoint if you want to filter your results from the Billing Breakdown endpoint and want to know what filters are available.

Returns the original purchased amount on an order transaction

Lists sets of distribution credentials for the specified project

Creates a set of distribution credentials for the specified project

Returns a set of distribution credentials for the specified project

Deletes a set of distribution credentials for the specified project

Generates a temporary JSON Web Token (JWT) with a 30-second (by default) TTL and usage::write permission for core voice APIs, requiring an API key with Member or higher authorization. Tokens created with this endpoint will not work with the Manage APIs.

Synthesize a complete block of text into a single audio response using Deepgram's Flux TTS batch (REST) API. Use this for pre-rendering fixed audio (IVR prompts, notifications, narration) where the whole text is known up front and you don't need incremental playback or interruption.