List Project Requests

GET https://api.deepgram.com/v1/projects//requests

Generates a list of requests for a specific project

Reference: https://developers.deepgram.com/reference/manage/requests/list

Authentication

Authorization header (required) (prefixed with Token ) — Use Authorization: Token <API_KEY> Example: Authorization: Token 12345abcdef

Request

Path parameters

project_id (string, required) — The unique identifier of the project

Query parameters

start (string, optional) — Start date of the requested date range. Formats accepted are YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, or YYYY-MM-DDTHH:MM:SS+HH:MM
end (string, optional) — End date of the requested date range. Formats accepted are YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, or YYYY-MM-DDTHH:MM:SS+HH:MM
limit (double, optional, default: 10) — Number of results to return per page. Default 10. Range [1,1000]
page (double, optional) — Navigate and return the results to retrieve specific portions of information of the response
accessor (string, optional) — Filter for requests where a specific accessor was used
request_id (string, optional) — Filter for a specific request id
deployment (enum, optional) — Filter for requests where a specific deployment was used
- Allowed values: hosted, beta, self-hosted
endpoint (enum, optional) — Filter for requests where a specific endpoint was used
- Allowed values: listen, read, speak, agent
method (enum, optional) — Filter for requests where a specific method was used
- Allowed values: sync, async, streaming
status (enum, optional) — Filter for requests that succeeded (status code < 300) or failed (status code >=400)
- Allowed values: succeeded, failed

Response

200

A list of requests for a specific project

page (double, optional) — The page number of the paginated response
limit (double, optional) — The number of results per page
requests (list of ProjectRequestResponse, optional)

Errors

400 Bad Request Error

Invalid Request

ErrorResponse

Types

ProjectRequestResponse

A single request

request_id (string, optional) — The unique identifier of the request
project_uuid (string, optional) — The unique identifier of the project
created (string, optional) — The date and time the request was created
path (string, optional) — The API path of the request
api_key_id (string, optional) — The unique identifier of the API key
response (ProjectRequestResponseResponse, optional) — The response of the request
code (double, optional) — The response code of the request
deployment (string, optional) — The deployment type
callback (string, optional) — The callback URL for the request

ErrorResponseLegacyError

err_code (string, optional) — The error code
err_msg (string, optional) — The error message
request_id (string, optional) — The request ID

ErrorResponseModernError

category (string, optional) — The category of the error
message (string, optional) — A message about the error
details (string, optional) — A description of the error
request_id (string, optional) — The unique identifier of the request

ProjectRequestResponseResponse

The response of the request

Examples

Response

JSON

{
  "page": 0,
  "limit": 10,
  "requests": [
    {
      "request_id": "a3f1c9d2-4b7e-4f9a-8c3d-2e5f7b9a1c0d",
      "project_uuid": "12345678-90ab-cdef-1234-567890abcdef",
      "created": "2024-01-15T09:48:20.000Z",
      "path": "/v1/listen?",
      "api_key_id": "b1e2c3d4-5678-90ab-cdef-1234567890ab",
      "response": {
        "code": 200,
        "completed": "2024-01-15T09:48:21.000Z",
        "deployment": "hosted:us",
        "details": {
          "channels": 1,
          "config": {},
          "duration": 30,
          "features": [],
          "metadata": {},
          "method": "sync",
          "models": [
            "1a2b3c4d-5e6f-4a8b-9c0d-1e2f3a4b5c6d"
          ],
          "streams": 1,
          "tags": [],
          "tier": "base",
          "total_audio": 30,
          "usd": 0.0075
        },
        "token_details": []
      },
      "callback": null
    }
  ]
}

SDK Code

Python

import requests

url = "https://api.deepgram.com/v1/projects/12345678-90ab-cdef-1234-567890abcdef/requests"

headers = {"Authorization": "Token <apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())

JavaScript

const url = 'https://api.deepgram.com/v1/projects/12345678-90ab-cdef-1234-567890abcdef/requests';
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/12345678-90ab-cdef-1234-567890abcdef/requests"

	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))

}

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.deepgram.com/v1/projects/12345678-90ab-cdef-1234-567890abcdef/requests")

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_body

Java

import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.deepgram.com/v1/projects/12345678-90ab-cdef-1234-567890abcdef/requests")
  .header("Authorization", "Token <apiKey>")
  .asString();

PHP

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.deepgram.com/v1/projects/12345678-90ab-cdef-1234-567890abcdef/requests', [
  'headers' => [
    'Authorization' => 'Token <apiKey>',
  ],
]);

echo $response->getBody();

using RestSharp;

var client = new RestClient("https://api.deepgram.com/v1/projects/12345678-90ab-cdef-1234-567890abcdef/requests");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Token <apiKey>");
IRestResponse response = client.Execute(request);

Swift

import Foundation

let headers = ["Authorization": "Token <apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.deepgram.com/v1/projects/12345678-90ab-cdef-1234-567890abcdef/requests")! 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()

Search documentation

Self-Hosted Deployments