List Brand Glossaries

curl --request GET \
  --url https://api.heygen.com/v3/brand-glossaries \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "brand_glossary_id": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_token": "<string>"
}

Brand

List Brand Glossaries

List brand glossaries (custom term mappings, a.k.a. brand voices) in the authenticated user’s workspace. A brand glossary enforces custom term translations during video translation — for example, translating “Reformer” as Pilates equipment instead of as a political activist. Brand glossaries are created and edited in the HeyGen web app under Brand Kit; this endpoint is read-only for discovery.

Pass the returned brand_glossary_id (or the legacy alias brand_voice_id) on POST /v2/video_translate to apply the glossary during translation.

GET

brand-glossaries

curl --request GET \
  --url https://api.heygen.com/v3/brand-glossaries \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "brand_glossary_id": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_token": "<string>"
}

Authorizations

x-api-key

string

header

required

HeyGen API key. Obtain from your HeyGen dashboard.

Query Parameters

limit

integer

default:10

Maximum number of brand glossaries to return (1-100). Default 10.

Required range: 1 <= x <= 100

token

string

Opaque pagination cursor from a previous response's next_token. Omit for the first page.

Response

Successful response

data

BrandGlossaryItem · object[]

Show child attributes

has_more

boolean

Whether more pages are available

next_token

string | null

Opaque cursor for the next page

Stop video agent session List brand kits

⌘I