REST API
REST API endpoints from Deepgram
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
REST API endpoints from Deepgram
Endpoints 50
models
- GETList Agent Think Models
https://agent.deepgram.com/v1/agent/settings/think/modelsRetrieves the available think models that can be used for AI agent processing - GETList Project Models
/v1/projects/:project_id/models?include_outdated=trueReturns metadata on all the latest models that a specific project has access to, including non-public models - GETGet a Project Model
/v1/projects/:project_id/models/:model_idReturns metadata for a specific model - GETList Models
/v1/models?include_outdated=trueReturns metadata on all the latest public models. To retrieve custom models, use Get Project Models. - GETGet a specific Model
/v1/models/:model_idReturns metadata for a specific public model
configurations
- GETList Agent Configurations
/v1/projects/:project_id/agentsReturns all agent configurations for the specified project. Configurations are returned in their uninterpolated form—template variable placeholders appear… - POSTCreate an Agent Configuration
/v1/projects/:project_id/agentsCreates a new reusable agent configuration. The config field must be a valid JSON string representing the agent block of a Settings message. The returned… - GETGet an Agent Configuration
/v1/projects/:project_id/agents/:agent_idReturns the specified agent configuration in its uninterpolated form - PUTUpdate Agent Metadata
/v1/projects/:project_id/agents/:agent_idUpdates the metadata associated with an agent configuration. The config itself is immutable—to change the configuration, delete the existing agent and create… - DELETEDelete an Agent Configuration
/v1/projects/:project_id/agents/:agent_idDeletes the specified agent configuration. Deleting an agent configuration can cause a production outage if your service references this agent UUID. Migrate…
variables
- GETList Agent Variables
/v1/projects/:project_id/agent-variablesReturns all template variables for the specified project - POSTCreate an Agent Variable
/v1/projects/:project_id/agent-variablesCreates a new template variable. Variables follow the DG_<VARIABLE_NAME> naming format and can substitute any JSON value in an agent configuration. - GETGet an Agent Variable
/v1/projects/:project_id/agent-variables/:variable_idReturns the specified template variable - DELETEDelete an Agent Variable
/v1/projects/:project_id/agent-variables/:variable_idDeletes the specified template variable - PATCHUpdate an Agent Variable
/v1/projects/:project_id/agent-variables/:variable_idUpdates the value of an existing template variable
media
- POSTTranscribe and analyze pre-recorded audio and video
/v1/listen?callback=string&callback_method=POST&extra=string&sentiment=false&summarize=v2&tag=string&topics=false&custom_topic=string&custom_topic_mode=extended&intents=false&custom_intent=string&custom_intent_mode=extended&detect_entities=false&detect_language=false&diarize=false&diarize_model=latest&dictation=false&encoding=linear16&filler_words=false&keyterm=string&keywords=string&language=en&language_hint=string&measurements=false&model=nova-3&multichannel=false&numerals=false¶graphs=false&profanity_filter=false&punctuate=false&redact=string&redact_usage=false&replace=string&search=string&smart_format=false&utterances=false&utt_split=0.8&version=latest&mip_opt_out=falseTranscribe audio and video using Deepgram's speech-to-text REST API
audio
- POSTText to Speech transformation
/v1/speak?callback=string&callback_method=POST&mip_opt_out=false&tag=string&bit_rate=32000&container=none&encoding=linear16&model=aura-asteria-en&sample_rate=8000&speed=1Convert text into natural-sounding speech using Deepgram's TTS REST API - POSTFlux Text to Speech (batch)
/v2/speak?callback=string&callback_method=POST&mip_opt_out=false&tag=string&bit_rate=8000&container=none&encoding=linear16&expressivity=-2&model=string&normalize_volume=true&sample_rate=8000&speed=1&priority=lowSynthesize 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…
text
- POSTAnalyze text content
/v1/read?callback=string&callback_method=POST&sentiment=false&summarize=v2&tag=string&topics=false&custom_topic=string&custom_topic_mode=extended&intents=false&custom_intent=string&custom_intent_mode=extended&language=enAnalyze text content using Deepgrams text analysis API
projects
- GETList Projects
/v1/projectsRetrieves basic information about the projects associated with the API key - GETGet a Project
/v1/projects/:project_id?limit=10&page=0.0Retrieves information about the specified project - DELETEDelete a Project
/v1/projects/:project_idDeletes the specified project - PATCHUpdate a Project
/v1/projects/:project_idUpdates the name or other properties of an existing project - DELETELeave a Project
/v1/projects/:project_id/leaveRemoves the authenticated account from the specific project
keys
- GETList Project Keys
/v1/projects/:project_id/keys?status=activeRetrieves all API keys associated with the specified project - POSTCreate a Project Key
/v1/projects/:project_id/keysCreates a new API key with specified settings for the project - GETGet a Project Key
/v1/projects/:project_id/keys/:key_idRetrieves information about a specified API key - DELETEDelete a Project Key
/v1/projects/:project_id/keys/:key_idDeletes an API key for a specific project
members
- GETList Project Members
/v1/projects/:project_id/membersRetrieves a list of members for a given project - DELETEDelete a Project Member
/v1/projects/:project_id/members/:member_idRemoves a member from the project using their unique member ID
scopes
- GETList Project Member Scopes
/v1/projects/:project_id/members/:member_id/scopesRetrieves a list of scopes for a specific member - PUTUpdate Project Member Scopes
/v1/projects/:project_id/members/:member_id/scopesUpdates the scopes for a specific member
invites
- GETList Project Invites
/v1/projects/:project_id/invitesGenerates a list of invites for a specific project - POSTCreate a Project Invite
/v1/projects/:project_id/invitesGenerates an invite for a specific project - DELETEDelete a Project Invite
/v1/projects/:project_id/invites/:emailDeletes an invite for a specific project
requests
- GETList Project Requests
/v1/projects/:project_id/requests?start=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&limit=10&page=0.0&accessor=string&request_id=string&deployment=hosted&endpoint=listen&method=sync&status=succeededGenerates a list of requests for a specific project - GETGet a Project Request
/v1/projects/:project_id/requests/:request_idRetrieves a specific request for a specific project
usage
- GETGet Project Usage
/v1/projects/:project_id/usage?start=2024-01-01&end=2024-01-01&accessor=string&alternatives=true&callback_method=true&callback=true&channels=true&custom_intent_mode=true&custom_intent=true&custom_topic_mode=true&custom_topic=true&deployment=hosted&detect_entities=true&detect_language=true&diarize=true&dictation=true&encoding=true&endpoint=listen&extra=true&filler_words=true&intents=true&keyterm=true&keywords=true&language=true&measurements=true&method=sync&model=string&multichannel=true&numerals=true¶graphs=true&profanity_filter=true&punctuate=true&redact=true&replace=true&sample_rate=true&search=true&sentiment=true&smart_format=true&summarize=true&tag=string&topics=true&utt_split=true&utterances=true&version=trueDeprecated. Retrieves the usage for a specific project. Use Get Project Usage Breakdown for a more comprehensive usage summary.
fields
- GETList Project Usage Fields
/v1/projects/:project_id/usage/fields?start=2024-01-01&end=2024-01-01Lists the features, models, tags, languages, and processing method used for requests in the specified project - GETList Project Billing Fields
/v1/projects/:project_id/billing/fields?start=2024-01-01&end=2024-01-01Lists 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…
breakdown
- GETGet Project Usage Breakdown
/v1/projects/:project_id/usage/breakdown?start=2024-01-01&end=2024-01-01&grouping=accessor&accessor=string&alternatives=true&callback_method=true&callback=true&channels=true&custom_intent_mode=true&custom_intent=true&custom_topic_mode=true&custom_topic=true&deployment=hosted&detect_entities=true&detect_language=true&diarize=true&dictation=true&encoding=true&endpoint=listen&extra=true&filler_words=true&intents=true&keyterm=true&keywords=true&language=true&measurements=true&method=sync&model=string&multichannel=true&numerals=true¶graphs=true&profanity_filter=true&punctuate=true&redact=true&replace=true&sample_rate=true&search=true&sentiment=true&smart_format=true&summarize=true&tag=string&topics=true&utt_split=true&utterances=true&version=trueRetrieves 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… - GETGet Project Billing Breakdown
/v1/projects/:project_id/billing/breakdown?start=2024-01-01&end=2024-01-01&accessor=string&deployment=hosted&tag=string&line_item=string&grouping=accessorRetrieves the billing summary for a specific project, with various filter options or by grouping options.
balances
- GETGet Project Balances
/v1/projects/:project_id/balancesGenerates a list of outstanding balances for the specified project - GETGet a Project Balance
/v1/projects/:project_id/balances/:balance_idRetrieves details about the specified balance
purchases
- GETList Project Purchases
/v1/projects/:project_id/purchases?limit=10Returns the original purchased amount on an order transaction
distributionCredentials
- GETList Project Self-Hosted Distribution Credentials
/v1/projects/:project_id/self-hosted/distribution/credentialsLists sets of distribution credentials for the specified project - POSTCreate a Project Self-Hosted Distribution Credential
/v1/projects/:project_id/self-hosted/distribution/credentials?scopes=self-hosted:products&provider=quayCreates a set of distribution credentials for the specified project - GETGet a Project Self-Hosted Distribution Credential
/v1/projects/:project_id/self-hosted/distribution/credentials/:distribution_credentials_idReturns a set of distribution credentials for the specified project - DELETEDelete a Project Self-Hosted Distribution Credential
/v1/projects/:project_id/self-hosted/distribution/credentials/:distribution_credentials_idDeletes a set of distribution credentials for the specified project
tokens
- POSTToken-based Authentication
/v1/auth/grantGenerates 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…
API details
- Base URL
https://api.deepgram.com- Authentication
- An API key in the Authorization header
A bearer token in the Authorization header - Operations
- 50 operations on 36 pathsGET 28POST 10DELETE 8PUT 2PATCH 2
1 marked deprecated - Main resources
- configurations 5models 5projects 5variables 5distributionCredentials 4keys 4invites 3audio 2balances 2breakdown 2
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- Deepgram's published OpenAPI description (deepgram/deepgram-api-specs) (CC-BY-4.0)
How to test the REST API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the REST API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List Agent Think Models” (GET https://agent.deepgram.com/v1/agent/settings/think/models), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the REST API?
REST API endpoints from Deepgram It is listed under AI & machine learning and has 50 endpoints.
Who publishes the REST API?
It is listed from Deepgram's public API description (an OpenAPI document), not published by Deepgram on Swastik Codes. Anyone who controls deepgram.com can claim the profile by adding a DNS TXT record.
What is the base URL of the REST API?
Requests go to https://api.deepgram.com. Endpoint paths are added to this base URL.
How do I authenticate with the REST API?
It accepts 2 methods: an API key in the Authorization header; A bearer token in the Authorization header.
How many endpoints does the REST API have?
50 operations on 36 paths (28 GET, 10 POST, 8 DELETE, 2 PUT, 2 PATCH). The largest groups are configurations, models, projects, variables.
Is forking the REST API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.