Get a Project Key
GET https://api.deepgram.com/v1/projects//keys/
Retrieves information about a specified API key
Reference: https://developers.deepgram.com/reference/manage/keys/get
Authentication
Section titled “Authentication”Authorizationheader (required) (prefixed withToken) — UseAuthorization: Token <API_KEY>Example:Authorization: Token 12345abcdef
Request
Section titled “Request”Path parameters
Section titled “Path parameters”project_id(string, required) — The unique identifier of the projectkey_id(string, required) — The unique identifier of the API key
Response
Section titled “Response”A specific API key
item(GetProjectKeyV1ResponseItem, optional)
Errors
Section titled “Errors”400 Bad Request Error
Section titled “400 Bad Request Error”Invalid Request
ErrorResponse
GetProjectKeyV1ResponseItem
Section titled “GetProjectKeyV1ResponseItem”member(GetProjectKeyV1ResponseItemMember, optional)
ErrorResponseLegacyError
Section titled “ErrorResponseLegacyError”err_code(string, optional) — The error codeerr_msg(string, optional) — The error messagerequest_id(string, optional) — The request ID
ErrorResponseModernError
Section titled “ErrorResponseModernError”category(string, optional) — The category of the errormessage(string, optional) — A message about the errordetails(string, optional) — A description of the errorrequest_id(string, optional) — The unique identifier of the request
GetProjectKeyV1ResponseItemMember
Section titled “GetProjectKeyV1ResponseItemMember”member_id(string, optional)email(string, optional)first_name(string, optional)last_name(string, optional)api_key(GetProjectKeyV1ResponseItemMemberApiKey, optional)
GetProjectKeyV1ResponseItemMemberApiKey
Section titled “GetProjectKeyV1ResponseItemMemberApiKey”api_key_id(string, optional)comment(string, optional)scopes(list of string, optional)tags(list of string, optional)expiration_date(string, optional)created(string, optional)
Examples
Section titled “Examples”Response
{
"item": {
"member": {
"member_id": "1000-2000-3000-4000",
"email": "john@test.com",
"first_name": "John",
"last_name": "Doe",
"api_key": {
"api_key_id": "1000-2000-3000-4000",
"comment": "A comment",
"scopes": [
"admin"
],
"tags": [
"prod",
"west-region"
],
"expiration_date": "2021-01-01T00:00:00Z",
"created": "2021-01-01T00:00:00Z"
}
}
}
}SDK Code
import requests
url = "https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys/123456789012345678901234"
headers = {"Authorization": "Token <apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())const url = 'https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys/123456789012345678901234';
const options = {method: 'GET', headers: {Authorization: 'Token <apiKey>'}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys/123456789012345678901234"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Token <apiKey>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys/123456789012345678901234")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Token <apiKey>'
response = http.request(request)
puts response.read_bodyimport com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;
HttpResponse<String> response = Unirest.get("https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys/123456789012345678901234")
.header("Authorization", "Token <apiKey>")
.asString();<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys/123456789012345678901234', [
'headers' => [
'Authorization' => 'Token <apiKey>',
],
]);
echo $response->getBody();using RestSharp;
var client = new RestClient("https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys/123456789012345678901234");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Token <apiKey>");
IRestResponse response = client.Execute(request);import Foundation
let headers = ["Authorization": "Token <apiKey>"]
let request = NSMutableURLRequest(url: NSURL(string: "https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys/123456789012345678901234")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()