Brand

Create Brand Glossary

Creates a brand glossary. Pass the returned brand_glossary_id when creating a video or translation to apply it. name must be unique in the workspace, ignoring case; a duplicate returns 409. Term lists are optional and can be added later with PATCH. pronunciation_language and target_language accept scope ‘all’ or scope ‘specific’ with a base language code such as ‘fr’; omission means all languages and null is invalid. Duplicate term/rule-type/language combinations return 409; distinct languages for the same term are allowed. The response includes language fields for specific-language rules. Temporary access-evaluation failures return 503; retry the request.

POST

brand-glossaries

curl --request POST \
  --url https://api.heygen.com/v3/brand-glossaries \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "terms": [],
  "do_not_translate_terms": [],
  "forced_translations": []
}
'

import requests

url = "https://api.heygen.com/v3/brand-glossaries"

payload = {
    "name": "<string>",
    "terms": [],
    "do_not_translate_terms": [],
    "forced_translations": []
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    terms: [],
    do_not_translate_terms: [],
    forced_translations: []
  })
};

fetch('https://api.heygen.com/v3/brand-glossaries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.heygen.com/v3/brand-glossaries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'terms' => [
        
    ],
    'do_not_translate_terms' => [
        
    ],
    'forced_translations' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.heygen.com/v3/brand-glossaries"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"terms\": [],\n  \"do_not_translate_terms\": [],\n  \"forced_translations\": []\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.heygen.com/v3/brand-glossaries")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"terms\": [],\n  \"do_not_translate_terms\": [],\n  \"forced_translations\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/brand-glossaries")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"terms\": [],\n  \"do_not_translate_terms\": [],\n  \"forced_translations\": []\n}"

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

{
  "data": {
    "brand_glossary_id": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "terms": [
      {
        "term": "<string>",
        "pronunciation": "<string>",
        "pronunciation_language": {
          "scope": "all"
        },
        "ipa": "<string>"
      }
    ],
    "do_not_translate_terms": null,
    "forced_translations": null
  }
}

Authorizations

x-api-key

string

header

required

HeyGen API key. Obtain from your HeyGen dashboard.

Headers

Idempotency-Key

string

Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 request_in_progress. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.

Required string length: 1 - 255

Pattern: ^[A-Za-z0-9_\-:.]{1,255}$

Body

application/json

Request body for POST /v3/brand-glossaries.

name

string

required

Display name for the glossary. Surrounding whitespace is removed, and the trimmed name must be 1-64 characters and unique within your workspace, compared without regard to case.

Required string length: 1 - 64

terms

BrandGlossaryTermWrite · object[]

Term-to-pronunciation mappings. Omit it, or pass an empty array, to create a glossary you fill in later.

One glossary entry as accepted on POST / PATCH: a written term and how it should be spoken.

BrandGlossaryTermWrite
BrandGlossaryTermWrite

Show child attributes

do_not_translate_terms

DoNotTranslateEntryWrite · object[]

Terms to keep untranslated when this glossary is used by a translation feature. Omit it, or pass an empty array, to add none.

Show child attributes

forced_translations

ForcedTranslationEntryWrite · object[]

Force Translate rules: terms translated into an exact replacement when this glossary is used by a translation feature. Omit it, or pass an empty array, to add none. If a term also appears in do_not_translate_terms, Don't Translate takes precedence without deleting its Force Translate rules.

Show child attributes

Response

Created.

data

BrandGlossaryDetail · object

A single brand glossary with its full term list (GET /v3/brand-glossaries/{id}).

Show child attributes

⌘I

Create Brand Glossary

curl --request POST \
  --url https://api.heygen.com/v3/brand-glossaries \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "terms": [],
  "do_not_translate_terms": [],
  "forced_translations": []
}
'

import requests

url = "https://api.heygen.com/v3/brand-glossaries"

payload = {
    "name": "<string>",
    "terms": [],
    "do_not_translate_terms": [],
    "forced_translations": []
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    terms: [],
    do_not_translate_terms: [],
    forced_translations: []
  })
};

fetch('https://api.heygen.com/v3/brand-glossaries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.heygen.com/v3/brand-glossaries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'terms' => [
        
    ],
    'do_not_translate_terms' => [
        
    ],
    'forced_translations' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.heygen.com/v3/brand-glossaries"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"terms\": [],\n  \"do_not_translate_terms\": [],\n  \"forced_translations\": []\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.heygen.com/v3/brand-glossaries")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"terms\": [],\n  \"do_not_translate_terms\": [],\n  \"forced_translations\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/brand-glossaries")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"terms\": [],\n  \"do_not_translate_terms\": [],\n  \"forced_translations\": []\n}"

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

{
  "data": {
    "brand_glossary_id": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "terms": [
      {
        "term": "<string>",
        "pronunciation": "<string>",
        "pronunciation_language": {
          "scope": "all"
        },
        "ipa": "<string>"
      }
    ],
    "do_not_translate_terms": null,
    "forced_translations": null
  }
}

Video Agent

Brand

Avatars

Audio

Models

Videos

Templates

Video Translate

Lipsync

HyperFrames

User

API Keys

Webhooks

Folders

Assets

AI Clipping

Filler Word Removal

Batches

Video Translation Batches

Lipsync Batches

Asset Batches

Create Brand Glossary

Authorizations

Headers

Body

Response