Get Brand Kit

Returns one brand kit with its colors, logos and fonts and the role each plays. While status is loading these are provisional; poll every 2 to 5 seconds until status is completed.

GET /v3/brand-kits/{brand_kit_id}

Get Brand Kit

cURL

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

200

{
  "data": {
    "brand_kit_id": "<string>",
    "name": "<string>",
    "status": "loading",
    "colors": [
      "<string>"
    ],
    "color_roles": {
      "primary": "<string>",
      "secondary": "<string>",
      "tertiary": "<string>",
      "accent": "<string>"
    },
    "logos": [
      {
        "logo_id": "<string>",
        "name": "<string>",
        "url": "<string>"
      }
    ],
    "logo_roles": {
      "primary": "<string>"
    },
    "fonts": [
      {
        "font_id": "<string>",
        "name": "<string>"
      }
    ],
    "font_roles": {
      "title_text": {
        "font_id": "<string>",
        "weight": 123
      },
      "body_text": {
        "font_id": "<string>",
        "weight": 123
      }
    }
  }
}

Authorizations

ApiKeyAuthBearerAuth

x-api-key · string · header · required

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

brand_kit_id · string · required

Unique brand kit identifier

Response

200

application/json

Successful response

data · BrandKitDetail · object

A single brand kit with its colors, logos and fonts.

A brand kit imported from a website is assembled in the background. While status is loading the collections and role fields are provisional and may be empty or incomplete; the import has finished contributing to them once status is completed. A kit whose import failed reports error and keeps whatever was assembled before the failure. A kit can still be edited in the HeyGen web app afterwards, so completed means the import is done, not that the kit is frozen.

Show child attributes