Projects

High-speed transcription of either pre-recorded or streaming audio. This feature is very fast, can understand nearly every audio format available, and is customizable. You can customize your transcript using various query parameters and apply general purpose and custom-trained AI models.

Deepgram supports over 100 different audio formats and encodings. For example, some of the most common audio formats and encodings we support include MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4A, Ogg, Opus, and WebM. However, because audio format is largely unconstrained, we always recommend to ensure compatibility by testing small sets of audio when first operating with new audio sources.

Get Projects

Retrieves basic information about the specified project.

Required account/project scope(s): project:read.

Responses

Status	Description
200 Success	Projects found.

Response Schema

projects: array

Array of project objects.
- project_id: uuid
  
  Unique identifier of the project.
- name: string
  
  Name of the project.
- company: string
  
  Name of the company associated with the project. Optional.

endpoint

GET /projects

Get Projects

# cURL

curl --request GET \
  --url https://api.deepgram.com/v1/projects \
  --header 'Authorization: Token <YOUR_DEEPGRAM_API_KEY>' \
  --header 'content-type: application/json'

# python

import http.client

conn = http.client.HTTPSConnection("api.deepgram.com")

headers = {
    'Authorization': "Token <YOUR_DEEPGRAM_API_KEY>",
    'content-type': "application/json"
    }

conn.request("GET", "/v1/projects", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

// .NET

var client = new RestClient("https://api.deepgram.com/v1/projects");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Token <YOUR_DEEPGRAM_API_KEY>");
request.AddHeader("content-type", "application/json");
IRestResponse response = client.Execute(request);

// Node.js

const http = require('https')

const options = {
  method: 'GET',
  hostname: 'api.deepgram.com',
  port: null,
  path: '/v1/projects',
  headers: {
    Authorization: 'Token <YOUR_DEEPGRAM_API_KEY>',
    'content-type': 'application/json',
  },
}

const req = http.request(options, function (res) {
  const chunks = []

  res.on('data', function (chunk) {
    chunks.push(chunk)
  })

  res.on('end', function () {
    const body = Buffer.concat(chunks)
    console.log(body.toString())
  })
})

req.end()

# PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.deepgram.com/v1/projects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Token <YOUR_DEEPGRAM_API_KEY>",
    "content-type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

# Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.deepgram.com/v1/projects")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Token <YOUR_DEEPGRAM_API_KEY>'
request["content-type"] = 'application/json'

response = http.request(request)
puts response.read_body

response

{
  "projects": [
    {
      "project_id": "uuid",
      "name": "string",
      "company": "string"
    }
  ]
}

Get Project

Query Parameters

project_id: uuid

Unique identifier of the project for which you want to retrieve information.

Responses

Status	Description
200 Success	Project found.
404 Not Found	A project with the specified ID was not found.

Response Schema

project_id: uuid

Unique identifier of the project.
name: string

Name of the project.
company: string

Name of the company associated with the project. Optional.

endpoint

GET /projects/{project_id}

Get Project

# cURL

curl --request GET \
  --url 'https://api.deepgram.com/v1/projects/{project_id}' \
  --header 'Authorization: Token <YOUR_DEEPGRAM_API_KEY>' \
  --header 'content-type: application/json'

# python

import http.client

conn = http.client.HTTPSConnection("api.deepgram.com")

headers = {
    'Authorization': "Token <YOUR_DEEPGRAM_API_KEY>",
    'content-type': "application/json"
    }

conn.request("GET", "/v1/projects/{project_id}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

// .NET

var client = new RestClient("https://api.deepgram.com/v1/projects/{project_id}");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Token <YOUR_DEEPGRAM_API_KEY>");
request.AddHeader("content-type", "application/json");
IRestResponse response = client.Execute(request);

// Node.js

const http = require('https')

const options = {
  method: 'GET',
  hostname: 'api.deepgram.com',
  port: null,
  path: '/v1/projects/{project_id}',
  headers: {
    Authorization: 'Token <YOUR_DEEPGRAM_API_KEY>',
    'content-type': 'application/json',
  },
}

const req = http.request(options, function (res) {
  const chunks = []

  res.on('data', function (chunk) {
    chunks.push(chunk)
  })

  res.on('end', function () {
    const body = Buffer.concat(chunks)
    console.log(body.toString())
  })
})

req.end()

# PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.deepgram.com/v1/projects/{project_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Token <YOUR_DEEPGRAM_API_KEY>",
    "content-type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

# Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.deepgram.com/v1/projects/{project_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Token <YOUR_DEEPGRAM_API_KEY>'
request["content-type"] = 'application/json'

response = http.request(request)
puts response.read_body

response

{
  "project_id": "uuid",
  "name": "string",
  "company": "string"
}

Update Project

Updates the specified project.

Required account scope(s): project:write. Required project scope(s): project:write:settings.

Path Parameters

project_id: uuid

Unique identifier of the project that you want to update.

Request Body Schema

name: string

Name of the project. Optional.

company: string

Name of the company associated with the project. Optional.

Responses

Status	Description
200 Success	Project updated.

Response Schema

message: string

Success message.

endpoint

PATCH /projects/{project_id}

Update Project

# cURL

curl --request PATCH \
  --url 'https://api.deepgram.com/v1/projects/{project_id}' \
  --header 'Authorization: Token <YOUR_DEEPGRAM_API_KEY>' \
  --header 'content-type: application/json' \
  --data '{"name":"string","company":"string"}'

# python

import http.client

conn = http.client.HTTPSConnection("api.deepgram.com")

payload = "{\"name\":\"string\",\"company\":\"string\"}"

headers = {
    'content-type': "application/json",
    'Authorization': "Token <YOUR_DEEPGRAM_API_KEY>"
    }

conn.request("PATCH", "/v1/projects/{project_id}", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

// .NET

var client = new RestClient("https://api.deepgram.com/v1/projects/{project_id}");
var request = new RestRequest(Method.PATCH);
request.AddHeader("content-type", "application/json");
request.AddHeader("Authorization", "Token <YOUR_DEEPGRAM_API_KEY>");
request.AddParameter("application/json", "{\"name\":\"string\",\"company\":\"string\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

// Node.js

const http = require('https')

const options = {
  method: 'PATCH',
  hostname: 'api.deepgram.com',
  port: null,
  path: '/v1/projects/{project_id}',
  headers: {
    'content-type': 'application/json',
    Authorization: 'Token <YOUR_DEEPGRAM_API_KEY>',
  },
}

const req = http.request(options, function (res) {
  const chunks = []

  res.on('data', function (chunk) {
    chunks.push(chunk)
  })

  res.on('end', function () {
    const body = Buffer.concat(chunks)
    console.log(body.toString())
  })
})

req.write(JSON.stringify({ name: 'string', company: 'string' }))
req.end()

# PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.deepgram.com/v1/projects/{project_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => "{\"name\":\"string\",\"company\":\"string\"}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Token <YOUR_DEEPGRAM_API_KEY>",
    "content-type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

# Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.deepgram.com/v1/projects/{project_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request["Authorization"] = 'Token <YOUR_DEEPGRAM_API_KEY>'
request.body = "{\"name\":\"string\",\"company\":\"string\"}"

response = http.request(request)
puts response.read_body

response

{
  "message": "string"
}

Delete Project

Deletes the specified project.

Required account scope(s): project:write. Required project scope(s): project:write:destroy.

Path Parameters

project_id: uuid

Unique identifier of the project that you want to delete.

Responses

Status	Description
200 Success	Project deleted.

endpoint

DELETE /projects/{project_id}

Delete Project

# cURL

curl --request DELETE \
  --url 'https://api.deepgram.com/v1/projects/{project_id}' \
  --header 'Authorization: Token <YOUR_DEEPGRAM_API_KEY>' \
  --header 'content-type: application/json'

# python

import http.client

conn = http.client.HTTPSConnection("api.deepgram.com")

headers = {
    'Authorization': "Token <YOUR_DEEPGRAM_API_KEY>",
    'content-type': "application/json"
    }

conn.request("DELETE", "/v1/projects/{project_id}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

// .NET

var client = new RestClient("https://api.deepgram.com/v1/projects/{project_id}");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Token <YOUR_DEEPGRAM_API_KEY>");
request.AddHeader("content-type", "application/json");
IRestResponse response = client.Execute(request);

// Node.js

const http = require('https')

const options = {
  method: 'DELETE',
  hostname: 'api.deepgram.com',
  port: null,
  path: '/v1/projects/{project_id}',
  headers: {
    Authorization: 'Token <YOUR_DEEPGRAM_API_KEY>',
    'content-type': 'application/json',
  },
}

const req = http.request(options, function (res) {
  const chunks = []

  res.on('data', function (chunk) {
    chunks.push(chunk)
  })

  res.on('end', function () {
    const body = Buffer.concat(chunks)
    console.log(body.toString())
  })
})

req.end()

# PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.deepgram.com/v1/projects/{project_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Token <YOUR_DEEPGRAM_API_KEY>",
    "content-type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

# Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.deepgram.com/v1/projects/{project_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Token <YOUR_DEEPGRAM_API_KEY>'
request["content-type"] = 'application/json'

response = http.request(request)
puts response.read_body

Projects

Get Projects

Responses

Response Schema

Get Project

Query Parameters

Responses

Response Schema

Update Project

Path Parameters

Request Body Schema

Responses

Response Schema

Delete Project

Path Parameters

Responses

Share your feedback