Create a Project Key | Deepgram's Docs

POST/v1/projects/{project_id}/keysCreate a Project Key

Creates a new API key with specified settings for the project

Parameters

project_idstringpathrequired

The unique identifier of the project

Request body

API key settings

application/json

valueCreateKeyV1Request

CreateKeyV1Request

oneOf · 2 options

Option 1value

Any type

Option 2value

Any type

Example request

null

Responses

objectCreateKeyV1Response

CreateKeyV1Response

API key created

api_key_idstring

The unique identifier of the API key

commentstring

A comment for the API key

expiration_datestring · date-time

The expiration date of the API key

keystring

The API key

scopesarray of string

The scopes for the API key

Show child attributes

tagsarray of string

The tags for the API key

Show child attributes

Example response

{
  "api_key_id": "string",
  "comment": "string",
  "expiration_date": "2026-06-09T00:00:00Z",
  "key": "string",
  "scopes": [
    "string"
  ],
  "tags": [
    "string"
  ]
}

valueErrorResponse

ErrorResponse

oneOf · 3 options

Option 1stringErrorResponseTextError

ErrorResponseTextError

Option 2objectErrorResponseLegacyError

ErrorResponseLegacyError

err_codestring

The error code

err_msgstring

The error message

request_idstring

The request ID

Option 3objectErrorResponseModernError

ErrorResponseModernError

categorystring

The category of the error

detailsstring

A description of the error

messagestring

A message about the error

request_idstring

The unique identifier of the request

Example response

{
  "err_code": "string",
  "err_msg": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

curl -X POST 'https://agent.deepgram.com/v1/projects/string/keys' \
  -H 'Content-Type: application/json' \
  -d 'null'

const response = await fetch('https://agent.deepgram.com/v1/projects/string/keys', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify(null),
});
const data = await response.json();

const response = await fetch('https://agent.deepgram.com/v1/projects/string/keys', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "null" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://agent.deepgram.com/v1/projects/string/keys",
    headers={"Content-Type": "application/json"},
    data='null',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`null`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://agent.deepgram.com/v1/projects/string/keys", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://agent.deepgram.com/v1/projects/string/keys");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "null");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://agent.deepgram.com/v1/projects/string/keys"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("null"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://agent.deepgram.com/v1/projects/string/keys")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "null"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://agent.deepgram.com/v1/projects/string/keys");
request.Content = new StringContent("null", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "api_key_id": "string",
  "comment": "string",
  "expiration_date": "2026-06-09T00:00:00Z",
  "key": "string",
  "scopes": [
    "string"
  ],
  "tags": [
    "string"
  ]
}

{
  "err_code": "string",
  "err_msg": "string",
  "request_id": "string"
}