> ## 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.

# Get Brand Glossary

> 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.



## OpenAPI

````yaml /openapi/external-api.json get /v3/brand-glossaries/{brand_glossary_id}
openapi: 3.1.0
info:
  title: HeyGen External API
  version: 1.0.0
  description: >-
    HeyGen's external API for programmatic AI video creation. See
    https://docs.heygen.com for full documentation.
  contact:
    name: HeyGen Product Infra
    url: https://heygen.com
servers:
  - url: https://api.heygen.com
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Video
    description: >-
      Create videos from a prompt or an avatar, then list, fetch, deliver and
      delete them
  - name: Avatar
    description: >-
      Create avatars and looks, record consent, and generate with the Avatar 6
      model
  - name: Voice
    description: Text to speech, speech to speech, and voice cloning
  - name: Audio
    description: Music, sound effects, transcription, stem separation and audio analysis
  - name: Image
    description: Generate images
  - name: Video editing
    description: >-
      Translate, lipsync, clip, analyze and remove filler words or backgrounds
      from existing videos
  - name: Video Agent
    description: Create videos from a prompt with an agent that plans, writes and edits
  - name: Templates
    description: Generate videos from reusable templates by replacing their variables
  - name: HyperFrames
    description: Render HyperFrames compositions into video
  - name: Brand
    description: >-
      Brand kits (colors, fonts, logos) and brand glossaries (term translations
      and pronunciations)
  - name: Assets and folders
    description: Upload files and organize them in folders
  - name: Batches
    description: Submit and track videos, translations, lipsyncs and uploads in bulk
  - name: Webhooks
    description: Manage webhook endpoints and events
  - name: Feedback
    description: Tell HeyGen how a generated result turned out
  - name: Account and usage
    description: Your account, the current API key, request logs and usage
paths:
  /v3/brand-glossaries/{brand_glossary_id}:
    get:
      tags:
        - Brand
      summary: Get Brand Glossary
      description: >-
        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.
      operationId: getBrandGlossary
      parameters:
        - name: brand_glossary_id
          in: path
          required: true
          schema:
            type: string
          description: Unique brand glossary identifier
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/BrandGlossaryDetail'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: unauthorized
                  message: Invalid or expired API key. Verify your x-api-key header.
                  param: null
                  doc_url: null
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: resource_not_found
                  message: Brand glossary not found.
                  param: null
                  doc_url: null
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Retry after the duration specified in the
                    Retry-After header.
                  param: null
                  doc_url: null
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
        '503':
          description: >-
            Temporarily unavailable — the request did not complete and is safe
            to retry.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: service_unavailable
                  message: >-
                    Brand glossary access is temporarily unavailable. Please
                    retry the request.
                  param: null
                  doc_url: null
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    BrandGlossaryDetail:
      description: >-
        A single brand glossary with its full term list (GET
        /v3/brand-glossaries/{id}).
      properties:
        brand_glossary_id:
          description: >-
            Unique brand glossary ID. Pass it as `brand_glossary_id` when
            creating a video or translation to apply this glossary.
          title: Brand Glossary Id
          type: string
        name:
          description: Display name of the brand glossary.
          title: Name
          type: string
        created_at:
          description: Creation timestamp (UTC).
          format: date-time
          title: Created At
          type: string
        updated_at:
          description: Last update timestamp (UTC).
          format: date-time
          title: Updated At
          type: string
        terms:
          description: >-
            Every term mapping in this glossary. Empty when the glossary has no
            terms yet, in which case applying it has no effect.
          items:
            $ref: '#/components/schemas/BrandGlossaryTerm'
          title: Terms
          type: array
        do_not_translate_terms:
          default: null
          description: Don't Translate rules in this glossary. Omitted when it has none.
          items:
            $ref: '#/components/schemas/DoNotTranslateEntry'
          title: Do Not Translate Terms
          type: array
        forced_translations:
          default: null
          description: >-
            Force Translate rules in this glossary. Omitted when it has none. If
            a term also appears in `do_not_translate_terms`, Don't Translate
            takes precedence without deleting its Force Translate rules.
          items:
            $ref: '#/components/schemas/ForcedTranslationEntry'
          title: Forced Translations
          type: array
      required:
        - brand_glossary_id
        - name
        - created_at
        - updated_at
        - terms
      title: BrandGlossaryDetail
      type: object
      x-mcp-exclude-unset: true
    StandardAPIError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: invalid_parameter
        message:
          type: string
          description: Human-readable error message
          example: Video not found
        param:
          type:
            - string
            - 'null'
          description: Which request field caused the error
        doc_url:
          type:
            - string
            - 'null'
          description: Link to error documentation
        errors:
          type: array
          description: >-
            Per-item error details for batch/multi-node failures (e.g. graph
            compilation errors by node).
          items:
            $ref: '#/components/schemas/StandardAPIErrorDetail'
        request_id:
          type: string
          description: >-
            Request identifier, also returned in the X-HeyGen-Request-Id
            response header. Include it when contacting support.
          example: 8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40
      required:
        - code
        - message
    BrandGlossaryTerm:
      description: 'One glossary entry: a written term and how it should be spoken.'
      properties:
        term:
          description: The term as written in a script, matched case-insensitively.
          title: Term
          type: string
        pronunciation:
          description: >-
            Respelling handed to the speech synthesizer in place of `term` (for
            example 'hey-jen' for 'HeyGen'). Affects generated audio only —
            captions and subtitles keep the original `term` spelling.
          title: Pronunciation
          type: string
        pronunciation_language:
          default: null
          description: >-
            Language in which this pronunciation applies. Omit or use scope
            'all' for all languages; null is invalid. Use scope 'specific' with
            a base language code such as 'fr', not a locale such as 'fr-FR'. A
            language-specific rule overrides an all-languages rule. Responses
            omit this field for all-languages rules.
          discriminator:
            mapping:
              all: '#/components/schemas/AllBrandGlossaryLanguages'
              specific: '#/components/schemas/SpecificBrandGlossaryLanguage'
            propertyName: scope
          oneOf:
            - $ref: '#/components/schemas/AllBrandGlossaryLanguages'
            - $ref: '#/components/schemas/SpecificBrandGlossaryLanguage'
          title: Pronunciation Language
        ipa:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Stored IPA pronunciation. Returned only when glossary IPA access is
            enabled.
          title: Ipa
      required:
        - term
        - pronunciation
      title: BrandGlossaryTerm
      type: object
    DoNotTranslateEntry:
      description: >-
        One Don't Translate rule: a term kept untranslated when content is
        translated.
      properties:
        term:
          description: >-
            A term to keep untranslated. When this glossary is used by a
            translation feature, each occurrence of the term — matched
            case-insensitively — is kept untranslated in every target language.
          title: Term
          type: string
      required:
        - term
      title: DoNotTranslateEntry
      type: object
    ForcedTranslationEntry:
      description: >-
        One Force Translate rule: a term and the exact translation that replaces
        it.
      properties:
        term:
          description: The term to replace, matched in the source text case-insensitively.
          title: Term
          type: string
        translation:
          description: >-
            The exact text used in place of `term` in the translated output for
            the selected target language scope. Inserted verbatim: grammatical
            inflection (case, gender, number) is not adapted to the surrounding
            sentence.
          title: Translation
          type: string
        target_language:
          default: null
          description: >-
            Target language in which this translation applies. Omit or use scope
            'all' for all languages; null is invalid. Use scope 'specific' with
            a base language code such as 'fr', not a locale such as 'fr-FR'. A
            language-specific rule overrides an all-languages rule. Responses
            omit this field for all-languages rules.
          discriminator:
            mapping:
              all: '#/components/schemas/AllBrandGlossaryLanguages'
              specific: '#/components/schemas/SpecificBrandGlossaryLanguage'
            propertyName: scope
          oneOf:
            - $ref: '#/components/schemas/AllBrandGlossaryLanguages'
            - $ref: '#/components/schemas/SpecificBrandGlossaryLanguage'
          title: Target Language
      required:
        - term
        - translation
      title: ForcedTranslationEntry
      type: object
    StandardAPIErrorDetail:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: unknown_node_type
        message:
          type: string
          description: Human-readable error message
          example: Unknown node type
        node_id:
          type: string
          description: Graph node id this error pertains to, if applicable
        port:
          type: string
          description: Port name on the node this error pertains to, if applicable
        path:
          type: string
          description: Field path within the item this error pertains to, if applicable
      required:
        - code
        - message
    AllBrandGlossaryLanguages:
      additionalProperties: false
      description: Apply the rule in every language.
      properties:
        scope:
          const: all
          description: Apply this rule in every language.
          title: Scope
          type: string
      required:
        - scope
      title: AllBrandGlossaryLanguages
      type: object
    SpecificBrandGlossaryLanguage:
      additionalProperties: false
      description: Apply the rule in one language.
      properties:
        scope:
          const: specific
          description: Apply this rule only in the specified language.
          title: Scope
          type: string
        code:
          description: >-
            Language code, such as 'en' or 'fr'. Locale codes such as 'en-US'
            are not accepted.
          maxLength: 32
          title: Code
          type: string
      required:
        - scope
        - code
      title: SpecificBrandGlossaryLanguage
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: HeyGen API key. Obtain from your HeyGen dashboard.
    BearerAuth:
      type: http
      scheme: bearer
      description: OAuth2 bearer token.

````

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