Brand Kits

Create a brand kit over the API by importing a website’s colors, fonts, and logos, then pass its brand_kit_id to Video Agent so every generated video ships on-brand.

A brand kit is a saved set of brand colors, fonts, and logos. Pass its brand_kit_id to the Video Agent and the agent applies it to everything it builds: scene backgrounds, text treatments, chart palettes, and logo placement. Output ships on-brand without describing your brand in the prompt.

Author a kit in the HeyGen app under Brand Kit, or import one from a public website over the API. Either way you get a brand_kit_id, and a kit created over the API stays editable in the app.

A brand kit governs how a video looks. To control how your terms are spoken, pair it with a brand glossary, as described in On Brand.

API reference: Create Brand Kit · Get Brand Kit · List Brand Kits · Update Brand Kit · Delete Brand Kit · Create Session · Send Message

Quickstart

Import a kit from your website:

curl -X POST "https://api.heygen.com/v3/brand-kits" \
  -H "X-Api-Key: $HEYGEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://www.acme.com", "name": "Acme Corp" }'

Pass the returned brand_kit_id to the Video Agent. The ID works right away, while the import finishes:

curl -X POST "https://api.heygen.com/v3/video-agents" \
  -H "X-Api-Key: $HEYGEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Create a 45-second explainer about our Q3 product launch.",
    "brand_kit_id": "3f9a1c47b8e24d5fa0c61e8b7d24f6a1"
  }'

Import a kit

From a website, then wait for the import.

Manage kits

List, correct roles, and delete.

Apply a kit

Brand Video Agent output and re-brand sessions.

Errors

Status	Code	Meaning
400	invalid_parameter	On an import, "URL is not supported": use a public page reachable without a login. On an update, "Provide at least one field to update." means the body arrived empty.
403	forbidden	Your workspace settings do not allow creating brand kits.
403	resource_access_denied	The kit was shared in from another workspace, which holds updates and deletion. It is still readable and usable.
404	resource_not_found	No brand kit with that ID in the authenticated workspace.
409	request_in_progress	A request with this Idempotency-Key is still running. Retry shortly.
409	brand_kit_not_ready	A role edit reached a kit whose status is loading or error. Renaming works at any time.
429	rate_limit_exceeded	Retry after the duration in the Retry-After header.