Token-based Authentication | Deepgram's Docs

POST/v1/auth/grantToken-based Authentication

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.

Request body

Time to live settings

application/json

objectGrantV1Request

GrantV1Request

ttl_secondsnumber · double

Time to live in seconds for the token. Defaults to 30 seconds.

maximum 3600 · minimum 1

Example request

{
  "ttl_seconds": 0
}

Responses

objectGrantV1Response

GrantV1Response

access_tokenstringrequired

JSON Web Token (JWT)

expires_innumber · double

Time in seconds until the JWT expires

Example response

{
  "access_token": "",
  "expires_in": 0
}

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

curl -X POST 'https://agent.deepgram.com/v1/auth/grant' \
  -H 'Content-Type: application/json' \
  -d '{"ttl_seconds":0}'

const response = await fetch('https://agent.deepgram.com/v1/auth/grant', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"ttl_seconds":0}),
});
const data = await response.json();

const response = await fetch('https://agent.deepgram.com/v1/auth/grant', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"ttl_seconds\":0}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://agent.deepgram.com/v1/auth/grant",
    headers={"Content-Type": "application/json"},
    data='{"ttl_seconds":0}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"ttl_seconds":0}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://agent.deepgram.com/v1/auth/grant", 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/auth/grant");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"ttl_seconds\":0}");
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/auth/grant"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"ttl_seconds\":0}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://agent.deepgram.com/v1/auth/grant")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"ttl_seconds\":0}"
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/auth/grant");
request.Content = new StringContent("{\"ttl_seconds\":0}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "access_token": "",
  "expires_in": 0
}

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