> ## Documentation Index
> Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Brand Glossary

> Control how HeyGen says and translates your custom terms. A brand glossary holds respelling or IPA pronunciations, do-not-translate terms, and forced translations; pass its brand_glossary_id on videos and translations.

![](https://mintcdn.com/heygen-1fa696a7/hfMXXwJzjE7vBSYZ/images/theme/research.webp?fit=max\&auto=format\&n=hfMXXwJzjE7vBSYZ\&q=85\&s=3e4c2594813dcfd56985f3d63e3ba321)

A brand glossary holds your terms and how HeyGen should treat them: how the voice pronounces them, and whether translation keeps or replaces them. Pass its `brand_glossary_id` on a video or translation request to apply it.

Each workspace has one glossary, and it holds rules for any number of languages. Author it in the HeyGen app under **Brand Kit** or over the API; edits in either place show up in the other.

> [!NOTE]
>
> **API reference:** [Create Brand Glossary](https://heygen-1fa696a7.mintlify.site/reference/create-brand-glossary.md) · [Update Brand Glossary](https://heygen-1fa696a7.mintlify.site/reference/update-brand-glossary.md) · [Get Brand Glossary](https://heygen-1fa696a7.mintlify.site/reference/get-brand-glossary.md) · [List Brand Glossaries](https://heygen-1fa696a7.mintlify.site/reference/list-brand-glossaries.md) · [Delete Brand Glossary](https://heygen-1fa696a7.mintlify.site/reference/delete-brand-glossary.md)

## What a glossary holds

| List | Applies in | Effect |
| - | - | - |
| [`terms`](https://heygen-1fa696a7.mintlify.site/docs/brand-glossary/pronunciations) | Generation: [Studio](https://heygen-1fa696a7.mintlify.site/studio-videos.md), [Templates](https://heygen-1fa696a7.mintlify.site/templates.md), `avatar` and `image` videos, [Video Agent](https://heygen-1fa696a7.mintlify.site/docs/video-agent.md) | The voice says the `pronunciation` or `ipa` instead of `term`. Captions keep the original spelling. |
| [`do_not_translate_terms`](https://heygen-1fa696a7.mintlify.site/docs/brand-glossary/translation-rules) | Translation: [video translation](https://heygen-1fa696a7.mintlify.site/docs/video-translate.md) over the API, and a Studio or Video Agent draft translated in the HeyGen app | `term` stays untranslated in every target language. |
| [`forced_translations`](https://heygen-1fa696a7.mintlify.site/docs/brand-glossary/translation-rules) | Translation, as above | `term` becomes its exact `translation`. |

Matching is case-insensitive. Any rule in `terms` or `forced_translations` can apply to all languages or to one.

## Quickstart

Find the workspace glossary, or create it if there is none:

```bash theme={null}
curl "https://api.heygen.com/v3/brand-glossaries" \
  -H "X-Api-Key: $HEYGEN_API_KEY"
```

```bash theme={null}
curl -X POST "https://api.heygen.com/v3/brand-glossaries" \
  -H "X-Api-Key: $HEYGEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Product Names",
    "terms": [{ "term": "HeyGen", "pronunciation": "hey-jen" }]
  }'
```

Then pass its ID on a video:

```bash theme={null}
curl -X POST "https://api.heygen.com/v3/videos" \
  -H "X-Api-Key: $HEYGEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "avatar",
    "brand_glossary_id": "8c2d5e91a47b4f3c8d1e6a9b2f5c7d40",
    "avatar_id": "YOUR_AVATAR_ID",
    "engine": { "type": "heygen-avatar-6" },
    "script": "Welcome to HeyGen.",
    "voice_id": "YOUR_VOICE_ID"
  }'
```

> [card] [Pronunciations](https://heygen-1fa696a7.mintlify.site/docs/brand-glossary/pronunciations.md)
>
> Respellings, IPA, and per-language pronunciations.

> [card] [Translation rules](https://heygen-1fa696a7.mintlify.site/docs/brand-glossary/translation-rules.md)
>
> Keep terms untranslated or force an exact translation.

> [card] [Manage a glossary](https://heygen-1fa696a7.mintlify.site/docs/brand-glossary/manage.md)
>
> Create, update, read, and delete over the API.

> [card] [Apply a glossary](https://heygen-1fa696a7.mintlify.site/docs/brand-glossary/apply.md)
>
> Use it on videos, templates, Video Agent, and translations.

## Errors

Glossary-specific meanings are below; [Error codes](https://heygen-1fa696a7.mintlify.site/docs/error-codes.md) covers the rest.

| Status | Code | Meaning |
| - | - | - |
| `400` | `invalid_parameter` | A field is out of range, `ipa` was sent by an account without IPA, or more than 10 entries need a generated respelling. `param` names the field. |
| `403` | `ai_vendor_access_restricted` | The workspace's AI vendor policy blocks respelling generation. Send `pronunciation` with each `ipa`. |
| `409` | `conflict` | The workspace already has a glossary, a glossary with this name already exists, a term is repeated for the same language within one list, or the glossary changed during the update. Read it again and retry. |
| `503` | `service_unavailable` | Temporary, including a failed respelling generation. Nothing was saved. Retry shortly. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.