Creates a new key in the specified project

You must create your first API Key using the Deepgram Console. After you have your first API key, you can use that to create more keys for a specified project.

Required account/project scope(s): keys:write.

Required Deepgram On-premises product scopes: onprem:product:api and onprem:product:engine.

On-prem API Keys

On-prem API keys can also be created by including the desired role in the same scopes list as the on-prem product scopes when submitting the key creation request. Refer to the "On-prem API Key" in the right pane for an example of this.

To create an On-prem API Key, you can use the following example which includes the default on-prem product scopes for a given project:

curl --request POST \
     --url \
     --header 'Authorization: Token 4af6c3d52a7846c9be507039218942601242b8cd' \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json' \
     --data '
  "comment": "My on-prem API key",
  "scopes": [

A successful response:

  "api_key_id": "cf0d0011-0eec-449c-8e6c-87caafa08922",
  "key": "f435b4824e902e31284b04a67058a1ed3b5199cf",
  "comment": "My on-prem API key",
  "scopes": [
  "created": "2023-06-29T00:33:46.443412Z"

Read more about roles and scopes.

Click Try It! to start a request and see the response here!