Create a Project Invite | Deepgram's Docs

POST/v1/projects/{project_id}/invitesCreate a Project Invite

Generates an invite for a specific project

Parameters

project_idstringpathrequired

The unique identifier of the project

Request body

email to invite to the project

application/json

objectCreateProjectInviteV1Request

CreateProjectInviteV1Request

Request body for creating a project invite

emailstringrequired

The email address of the invitee

scopestringrequired

The scope of the invitee

Example request

{
  "email": "string",
  "scope": "string"
}

Responses

objectCreateProjectInviteV1Response

CreateProjectInviteV1Response

messagestring

confirmation message

Example response

{
  "message": "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

curl -X POST 'https://agent.deepgram.com/v1/projects/string/invites' \
  -H 'Content-Type: application/json' \
  -d '{"email":"string","scope":"string"}'

const response = await fetch('https://agent.deepgram.com/v1/projects/string/invites', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"email":"string","scope":"string"}),
});
const data = await response.json();

const response = await fetch('https://agent.deepgram.com/v1/projects/string/invites', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"email\":\"string\",\"scope\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://agent.deepgram.com/v1/projects/string/invites",
    headers={"Content-Type": "application/json"},
    data='{"email":"string","scope":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"email":"string","scope":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://agent.deepgram.com/v1/projects/string/invites", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	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/invites");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"email\":\"string\",\"scope\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://agent.deepgram.com/v1/projects/string/invites"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"email\":\"string\",\"scope\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://agent.deepgram.com/v1/projects/string/invites")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"email\":\"string\",\"scope\":\"string\"}"
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.Post, "https://agent.deepgram.com/v1/projects/string/invites");
request.Content = new StringContent("{\"email\":\"string\",\"scope\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "message": "string"
}

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