Create a Project Invite

POST https://api.deepgram.com/v1/projects//invites Content-Type: application/json

Generates an invite for a specific project

Reference: https://developers.deepgram.com/reference/manage/invites/create

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

Body (application/json)

This endpoint expects a CreateProjectInviteV1Request.

email (string, required) — The email address of the invitee
scope (string, required) — The scope of the invitee

Response

200

The invite was successfully generated

message (string, optional) — confirmation message

Errors

400 Bad Request Error

Invalid Request

ErrorResponse

Types

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

Examples

Request

JSON

{
  "email": "jane.doe@example.com",
  "scope": "read:transcripts write:projects"
}

Response

JSON

{
  "message": "Invite successfully generated and sent to jane.doe@example.com"
}

SDK Code

Python

import requests

url = "https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/invites"

payload = {
    "email": "jane.doe@example.com",
    "scope": "read:transcripts write:projects"
}
headers = {
    "Authorization": "Token <apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

JavaScript

const url = 'https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/invites';
const options = {
  method: 'POST',
  headers: {Authorization: 'Token <apiKey>', 'Content-Type': 'application/json'},
  body: '{"email":"jane.doe@example.com","scope":"read:transcripts write:projects"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/invites"

	payload := strings.NewReader("{\n  \"email\": \"jane.doe@example.com\",\n  \"scope\": \"read:transcripts write:projects\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Token <apiKey>")
	req.Header.Add("Content-Type", "application/json")

	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/123456-7890-1234-5678-901234/invites")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Token <apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"jane.doe@example.com\",\n  \"scope\": \"read:transcripts write:projects\"\n}"

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.post("https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/invites")
  .header("Authorization", "Token <apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jane.doe@example.com\",\n  \"scope\": \"read:transcripts write:projects\"\n}")
  .asString();

PHP

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/invites', [
  'body' => '{
  "email": "jane.doe@example.com",
  "scope": "read:transcripts write:projects"
}',
  'headers' => [
    'Authorization' => 'Token <apiKey>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

using RestSharp;

var client = new RestClient("https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/invites");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Token <apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"email\": \"jane.doe@example.com\",\n  \"scope\": \"read:transcripts write:projects\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Swift

import Foundation

let headers = [
  "Authorization": "Token <apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "email": "jane.doe@example.com",
  "scope": "read:transcripts write:projects"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/invites")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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