List Project Keys | Deepgram's Docs

GET/v1/projects/{project_id}/keysList Project Keys

Retrieves all API keys associated with the specified project

Parameters

project_idstringpathrequired

The unique identifier of the project

statusstringquery

Only return keys with a specific status

one of "active", "expired"

Responses

objectListProjectKeysV1Response

ListProjectKeysV1Response

api_keysarray of object

Show child attributes

Show array items

api_keyobject

Show child attributes

api_key_idstring

commentstring

createdstring · date-time

scopesarray of string

Show child attributes

memberobject

Show child attributes

emailstring

member_idstring

Example response

{
  "api_keys": [
    {
      "api_key": {
        "api_key_id": "",
        "comment": "",
        "created": "",
        "scopes": [
          ""
        ]
      },
      "member": {
        "email": "string",
        "member_id": "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

statusquery parameter

curl -X GET 'https://agent.deepgram.com/v1/projects/string/keys?status=active'

const response = await fetch('https://agent.deepgram.com/v1/projects/string/keys?status=active', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://agent.deepgram.com/v1/projects/string/keys?status=active', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://agent.deepgram.com/v1/projects/string/keys?status=active")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://agent.deepgram.com/v1/projects/string/keys?status=active", nil)
	if err != nil {
		panic(err)
	}
	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?status=active");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://agent.deepgram.com/v1/projects/string/keys?status=active"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://agent.deepgram.com/v1/projects/string/keys?status=active")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
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.Get, "https://agent.deepgram.com/v1/projects/string/keys?status=active");
using var response = await client.SendAsync(request);

{
  "api_keys": [
    {
      "api_key": {
        "api_key_id": "",
        "comment": "",
        "created": "",
        "scopes": [
          ""
        ]
      },
      "member": {
        "email": "string",
        "member_id": "string"
      }
    }
  ]
}

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