HEheygen
Brand

Get Brand Glossary

Changed on

Returns one brand glossary with its full term list. Pronunciations affect generated audio only, not captions. Translation rules (do_not_translate_terms, forced_translations) apply only to translation features; a list is omitted from the response when it is empty. Language-specific entries include pronunciation_language or target_language; all-languages entries omit those fields. Specific-language rules override all-languages rules, and Don't Translate takes precedence over Force Translate without deleting it. Tone settings are not returned here. Temporary access-evaluation failures return 503; retry the request.

get/v3/brand-glossaries/{brand_glossary_id}

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/brand-glossaries/{brand_glossary_id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

brand_glossary_idstring required

Unique brand glossary identifier

Response

Successful response

Changes