Authenticating
Learn how to authenticate with Deepgram's API.
Deepgram's API uses API keys to authenticate requests. You can view and manage your API keys in the Deepgram Console or through the Deepgram API.
Your API keys grant many privileges, so be sure to keep them secure. Do not share your secret API keys in publicly accessible areas such as GitHub or client-side code.
For best results, use different API keys for testing and production. To help filter usage, you can also use different API keys for different consumers or teams at your organization.
If you still need an API key, you can sign up to Deepgram today for free!
Authenticating with the API Key
Once you have created an API key, you can use it as credentials to call Deepgram's API.
Send requests to the API with an Authorization
header that references your project's API key:
Authorization: Token YOUR_DEEPGRAM_API_KEY
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests made without authentication will also fail.
Test Request
A quick test to see if your key is validating correctly, is to make a request to the /auth/token
endpoint on our API. This will return an invalid credentials
error if your key is invalid, and a JSON
response with details about your key if it's valid.
curl https://api.deepgram.com/v1/auth/token \
-H "Authorization: Token dc43fc74612ec2cb065315663f25c34a958aa895"
Additional Keys
To create additional API keys, be sure that the API key you are using to authenticate your request has been assigned either the administrator
role or the following permissions: keys:read
, keys:write
.
Make sure you are sending API requests over HTTPS. Calls made over plain HTTP will fail. API requests made without authentication will also fail.
Updated 8 months ago