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 --request GET \
--url https://api.heygen.com/v3/brand-kits/{brand_kit_id} \
--header 'x-api-key: <api-key>'
{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Retry after the duration specified in the Retry-After header.",
"param": null,
"doc_url": null
}
}
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
⌘I
Get Brand Kit
curl --request GET \
--url https://api.heygen.com/v3/brand-kits/{brand_kit_id} \
--header 'x-api-key: <api-key>'
{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Retry after the duration specified in the Retry-After header.",
"param": null,
"doc_url": null
}
}
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"HeyGen Documentation","colors":{"primary":"#03C3FF","light":"#03C3FF","dark":"#03C3FF"},"logo":{"light":"https://mintcdn.com/heygen-1fa696a7/dQ_uLJDftFYFhC7B/logo/light.png?fit=max\u0026auto=format\u0026n=dQ_uLJDftFYFhC7B\u0026q=85\u0026s=b03d2e41dde1cc0b50cd50e574f66f1c","dark":"https://mintcdn.com/heygen-1fa696a7/dQ_uLJDftFYFhC7B/logo/dark.png?fit=max\u0026auto=format\u0026n=dQ_uLJDftFYFhC7B\u0026q=85\u0026s=1bce9897c94baace249bfc9bd5ebb894"},"favicon":{"light":"https://mintcdn.com/heygen-1fa696a7/eIkZ-KhF8P1D-58U/images/fav.png?fit=max\u0026auto=format\u0026n=eIkZ-KhF8P1D-58U\u0026q=85\u0026s=974346d2956697dca817da145b0107e8","dark":"https://mintcdn.com/heygen-1fa696a7/eIkZ-KhF8P1D-58U/images/fav.png?fit=max\u0026auto=format\u0026n=eIkZ-KhF8P1D-58U\u0026q=85\u0026s=974346d2956697dca817da145b0107e8"},"navbar":{"primary":{"type":"button","label":"Get Started","href":"https://platform.heygen.com"}},"seo":{"metatags":{"robots":"index, follow"},"indexing":"navigable"},"fonts":{"heading":{"family":"ABC Solar Display","source":"https://www-static-assets.heygen.com/fonts/solar-display/ABCSolarDisplay-Bold.woff2","format":"woff2"},"body":{"family":"TT Norms Pro","source":"https://www-static-assets.heygen.com/fonts/tt-norms/TT_Norms_Pro_Normal.woff2","format":"woff2"}},"integrations":{"posthog":{"apiKey":"phc_bcoaBa4uZdMp0CzXr7QhZRRpnNGgBRRZ1GStvuJVAgJ","apiHost":"https://us.i.posthog.com"}},"contextual":{"options":["copy","view","chatgpt","claude","grok","cursor"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"heygen-1fa696a7","hasAudioNarration":false,"actualSubdomain":"heygen-1fa696a7","customDomains":[],"gitSource":{"type":"github","owner":"heygen-com","repo":"api-docs","deployBranch":"master","contentDirectory":"heygen-api","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af513c82881c20577b2e480","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":115},{"language":"default","tag":"Developer Guide","count":80},{"language":"default","tag":"Applications","count":53},{"language":"default","tag":"Video","count":21},{"language":"default","tag":"Models","count":21},{"language":"default","tag":"Brand","count":19},{"language":"default","tag":"Video Agent","count":13},{"language":"default","tag":"Video Translate","count":13},{"language":"default","tag":"Assets","count":12},{"language":"default","tag":"Avatars","count":12}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"li[id=\"https://platform.heygen.com\"]>a,.lg\\:hidden>a[href=\"https://platform.heygen.com\"]{color:#03C3FF!important;font-weight:600}li[id=\"https://platform.heygen.com\"]>a svg,.lg\\:hidden>a[href=\"https://platform.heygen.com\"] svg{color:#03C3FF!important}#hg-platform-links{position:absolute;top:0;right:calc(var(--sidebar-width, 19rem) + 24px);height:48px;display:flex;align-items:center;gap:6px;z-index:30}@media (max-width: 1023px){#hg-platform-links{display:none}}#hg-platform-links .hg-pill{display:inline-flex;align-items:center;gap:5px;height:24px;padding:0 10px;border-radius:999px;font-size:11.5px;font-weight:500;line-height:1;white-space:nowrap;text-decoration:none;color:rgb(55 65 81);border:1px solid rgb(3 7 18 / 0.1);background:rgb(3 7 18 / 0.02);transition:color 0.15s, border-color 0.15s, background 0.15s, box-shadow 0.15s}#hg-platform-links .hg-pill svg{width:12px;height:12px;fill:none;stroke:currentColor;stroke-width:2;stroke-linecap:round;stroke-linejoin:round}#hg-platform-links .hg-pill:hover{color:#0284c7;border-color:rgb(3 195 255 / 0.5);background:rgb(3 195 255 / 0.06)}#hg-platform-links .hg-pill--primary{color:#03131a;border-color:transparent;background:linear-gradient(90deg, #03C3FF, #7CF5C4);font-weight:600}#hg-platform-links .hg-pill--primary svg{fill:currentColor;stroke:none}#hg-platform-links .hg-pill--primary:hover{color:#03131a;border-color:transparent;background:linear-gradient(90deg, #03C3FF, #7CF5C4);box-shadow:0 0 0 3px rgb(3 195 255 / 0.18), 0 0 18px rgb(3 195 255 / 0.35)}html.dark #hg-platform-links .hg-pill:not(.hg-pill--primary){color:rgb(209 213 219);border-color:rgb(255 255 255 / 0.1);background:rgb(255 255 255 / 0.03)}html.dark #hg-platform-links .hg-pill:not(.hg-pill--primary):hover{color:#03C3FF;border-color:rgb(3 195 255 / 0.45);background:rgb(3 195 255 / 0.08)}@media (max-width: 1439px){#hg-platform-links .hg-pill:not(.hg-pill--primary){width:24px;padding:0;justify-content:center}#hg-platform-links .hg-pill:not(.hg-pill--primary) span{display:none}}@media (max-width: 1179px){#hg-platform-links .hg-pill:not(.hg-pill--primary){display:none}}"}],"page":{"pagePath":"reference/get-brand-kit","slug":"/reference/get-brand-kit","pageMetadata":{"title":"Get Brand Kit","description":"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`.","deprecated":null,"version":null,"sidebarTitle":"Get brand kit","openapi":"/openapi/external-api.json get /v3/brand-kits/{brand_kit_id}","href":"/reference/get-brand-kit","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns one brand kit with its colors, logos and fonts and the role each plays. While status is \", _jsx(_components.code, {\n children: \"loading\"\n }), \" these are provisional; poll every 2 to 5 seconds until status is \", _jsx(_components.code, {\n children: \"completed\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Brand Kit","description":"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`.","deprecated":null,"version":null,"sidebarTitle":"Get brand kit","openapi":"/openapi/external-api.json get /v3/brand-kits/{brand_kit_id}","href":"/reference/get-brand-kit","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/heygen-1fa696a7/5ff79916e1e2679a/platform-links.js"],"openApiReferenceData":{"operation":{"summary":"Get Brand Kit","description":"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`.","tags":["Brand"],"security":["f1d35e90-d440-48f1-b0b1-da6afd0c7fe4","10f7b2d3-5e1d-4a79-ad57-a4ea4e0f32c0"],"responses":{"200":"b2218e55-8faa-46c4-90ad-bdce5645edc0","400":"2e7a7fac-a87e-4a45-8cff-f764794eade1","401":"ed103c70-9ff7-430d-8202-a07efa18bc5b","404":"d44ec559-d587-4234-83f6-5a1e9632aee6","429":"d9c65453-0b6a-4cfd-ab5e-377636640193"},"x-mint":{"href":"/reference/get-brand-kit"},"operationId":"getBrandKit","parameters":["fa51029c-9175-43d0-953a-8bf56e32e113"],"x-heygen-required-scopes":["brand:read"],"method":"get","type":"path","servers":["28619676-a185-4308-8c18-0a2b6156ed0d"],"path":"/v3/brand-kits/{brand_kit_id}","baseUrlOptions":["https://api.heygen.com"],"title":"Get Brand Kit","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fa51029c-9175-43d0-953a-8bf56e32e113":{"name":"brand_kit_id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Unique brand kit identifier","uniqueKey":"","typeLabel":"string"},"description":"Unique brand kit identifier"}},"responses":{"b2218e55-8faa-46c4-90ad-bdce5645edc0":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"A single brand kit with its colors, logos and fonts.\n\nA brand kit imported from a website is assembled in the background. While `status` is `loading`\nthe collections and role fields are provisional and may be empty or incomplete; the import has\nfinished contributing to them once `status` is `completed`. A kit whose import failed reports\n`error` and keeps whatever was assembled before the failure. A kit can still be edited in the\nHeyGen web app afterwards, so `completed` means the import is done, not that the kit is frozen.","properties":{"brand_kit_id":{"description":"Unique brand kit identifier.","title":"Brand Kit Id","type":"string","isRequired":true,"uniqueKey":"data.brand_kit_id","typeLabel":"string"},"name":{"description":"Display name of the brand kit.","title":"Name","type":"string","isRequired":true,"uniqueKey":"data.name","typeLabel":"string"},"status":{"description":"Assembly status: 'loading' while the kit is still being built, 'completed' when it is ready, or 'error' if the import failed.","enum":["loading","completed","error"],"title":"Status","type":"string","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"colors":{"description":"Brand colors as hex values, e.g. '#FF5733'. A color playing a role may sit outside this list — see color_roles — so do not treat it as the full set of colors the kit references.","items":{"type":"string","uniqueKey":"data.colors.items.[INDEX]","typeLabel":"string"},"title":"Colors","type":"array","uniqueKey":"data.colors","typeLabel":"string[]"},"color_roles":{"oneOf":[{"type":"object","title":"BrandKitColorRoles","description":"Which color plays which part. May be absent while the kit is still loading.","properties":{"primary":{"oneOf":[{"type":"string","title":"Primary","description":"Primary brand color.","uniqueKey":"data.color_roles.oneOf.0.primary.oneOf.0","typeLabel":"string"},{"type":"null","title":"Primary","description":"Primary brand color.","uniqueKey":"data.color_roles.oneOf.0.primary.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.color_roles.oneOf.0.primary","typeLabel":"string | null"},"secondary":{"oneOf":[{"type":"string","title":"Secondary","description":"Secondary brand color.","uniqueKey":"data.color_roles.oneOf.0.secondary.oneOf.0","typeLabel":"string"},{"type":"null","title":"Secondary","description":"Secondary brand color.","uniqueKey":"data.color_roles.oneOf.0.secondary.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.color_roles.oneOf.0.secondary","typeLabel":"string | null"},"tertiary":{"oneOf":[{"type":"string","title":"Tertiary","description":"Tertiary brand color.","uniqueKey":"data.color_roles.oneOf.0.tertiary.oneOf.0","typeLabel":"string"},{"type":"null","title":"Tertiary","description":"Tertiary brand color.","uniqueKey":"data.color_roles.oneOf.0.tertiary.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.color_roles.oneOf.0.tertiary","typeLabel":"string | null"},"accent":{"oneOf":[{"type":"string","title":"Accent","description":"Accent color, used for highlights and calls to action.","uniqueKey":"data.color_roles.oneOf.0.accent.oneOf.0","typeLabel":"string"},{"type":"null","title":"Accent","description":"Accent color, used for highlights and calls to action.","uniqueKey":"data.color_roles.oneOf.0.accent.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.color_roles.oneOf.0.accent","typeLabel":"string | null"}},"uniqueKey":"data.color_roles.oneOf.0","typeLabel":"BrandKitColorRoles · object"},{"type":"null","description":"Which color plays which part. May be absent while the kit is still loading.","uniqueKey":"data.color_roles.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.color_roles","typeLabel":"BrandKitColorRoles · object | null"},"logos":{"description":"Logos belonging to the brand kit.","items":{"description":"A logo belonging to a brand kit.","properties":{"logo_id":{"description":"Unique logo identifier. The logo named by logo_roles.primary is the brand's main logo.","title":"Logo Id","type":"string","isRequired":true,"uniqueKey":"data.logos.items.[INDEX].logo_id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Name","description":"Display name of the logo.","uniqueKey":"data.logos.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"Display name of the logo.","uniqueKey":"data.logos.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.logos.items.[INDEX].name","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","title":"Url","description":"URL of the logo image. Absent if the logo has no stored file yet.","uniqueKey":"data.logos.items.[INDEX].url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Url","description":"URL of the logo image. Absent if the logo has no stored file yet.","uniqueKey":"data.logos.items.[INDEX].url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.logos.items.[INDEX].url","typeLabel":"string | null"}},"required":["logo_id"],"title":"BrandKitLogo","type":"object","uniqueKey":"data.logos.items.[INDEX]","typeLabel":"BrandKitLogo · object"},"title":"Logos","type":"array","uniqueKey":"data.logos","typeLabel":"BrandKitLogo · object[]"},"logo_roles":{"oneOf":[{"type":"object","title":"BrandKitLogoRoles","description":"Which logo is the main one. May be absent while the kit is still loading.","properties":{"primary":{"oneOf":[{"type":"string","title":"Primary","description":"Identifier of the primary logo. Names a logo_id in `logos` unless that logo has since been deleted.","uniqueKey":"data.logo_roles.oneOf.0.primary.oneOf.0","typeLabel":"string"},{"type":"null","title":"Primary","description":"Identifier of the primary logo. Names a logo_id in `logos` unless that logo has since been deleted.","uniqueKey":"data.logo_roles.oneOf.0.primary.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.logo_roles.oneOf.0.primary","typeLabel":"string | null"}},"uniqueKey":"data.logo_roles.oneOf.0","typeLabel":"BrandKitLogoRoles · object"},{"type":"null","description":"Which logo is the main one. May be absent while the kit is still loading.","uniqueKey":"data.logo_roles.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.logo_roles","typeLabel":"BrandKitLogoRoles · object | null"},"fonts":{"description":"Fonts belonging to the brand kit.","items":{"description":"A font belonging to a brand kit.","properties":{"font_id":{"description":"Unique font identifier. A font_roles entry usually names one of these, but see font_roles for when it does not.","title":"Font Id","type":"string","isRequired":true,"uniqueKey":"data.fonts.items.[INDEX].font_id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Name","description":"Font family name.","uniqueKey":"data.fonts.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"Font family name.","uniqueKey":"data.fonts.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.fonts.items.[INDEX].name","typeLabel":"string | null"}},"required":["font_id"],"title":"BrandKitFont","type":"object","uniqueKey":"data.fonts.items.[INDEX]","typeLabel":"BrandKitFont · object"},"title":"Fonts","type":"array","uniqueKey":"data.fonts","typeLabel":"BrandKitFont · object[]"},"font_roles":{"oneOf":[{"type":"object","title":"BrandKitFontRoles","description":"Which font plays which typographic part. May be absent while the kit is still loading.","properties":{"title_text":{"oneOf":[{"type":"object","title":"BrandKitFontRole","description":"Font for headings and titles.","properties":{"font_id":{"oneOf":[{"type":"string","title":"Font Id","description":"Identifier of the assigned font.","uniqueKey":"data.font_roles.oneOf.0.title_text.oneOf.0.font_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Font Id","description":"Identifier of the assigned font.","uniqueKey":"data.font_roles.oneOf.0.title_text.oneOf.0.font_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.font_roles.oneOf.0.title_text.oneOf.0.font_id","typeLabel":"string | null"},"weight":{"oneOf":[{"type":"integer","title":"Weight","description":"Font weight, e.g. 400 for regular or 700 for bold.","uniqueKey":"data.font_roles.oneOf.0.title_text.oneOf.0.weight.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Weight","description":"Font weight, e.g. 400 for regular or 700 for bold.","uniqueKey":"data.font_roles.oneOf.0.title_text.oneOf.0.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.font_roles.oneOf.0.title_text.oneOf.0.weight","typeLabel":"integer | null"}},"uniqueKey":"data.font_roles.oneOf.0.title_text.oneOf.0","typeLabel":"BrandKitFontRole · object"},{"type":"null","description":"Font for headings and titles.","uniqueKey":"data.font_roles.oneOf.0.title_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.font_roles.oneOf.0.title_text","typeLabel":"BrandKitFontRole · object | null"},"body_text":{"oneOf":[{"type":"object","title":"BrandKitFontRole","description":"Font for body copy.","properties":{"font_id":{"oneOf":[{"type":"string","title":"Font Id","description":"Identifier of the assigned font.","uniqueKey":"data.font_roles.oneOf.0.body_text.oneOf.0.font_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Font Id","description":"Identifier of the assigned font.","uniqueKey":"data.font_roles.oneOf.0.body_text.oneOf.0.font_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.font_roles.oneOf.0.body_text.oneOf.0.font_id","typeLabel":"string | null"},"weight":{"oneOf":[{"type":"integer","title":"Weight","description":"Font weight, e.g. 400 for regular or 700 for bold.","uniqueKey":"data.font_roles.oneOf.0.body_text.oneOf.0.weight.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Weight","description":"Font weight, e.g. 400 for regular or 700 for bold.","uniqueKey":"data.font_roles.oneOf.0.body_text.oneOf.0.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.font_roles.oneOf.0.body_text.oneOf.0.weight","typeLabel":"integer | null"}},"uniqueKey":"data.font_roles.oneOf.0.body_text.oneOf.0","typeLabel":"BrandKitFontRole · object"},{"type":"null","description":"Font for body copy.","uniqueKey":"data.font_roles.oneOf.0.body_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.font_roles.oneOf.0.body_text","typeLabel":"BrandKitFontRole · object | null"}},"uniqueKey":"data.font_roles.oneOf.0","typeLabel":"BrandKitFontRoles · object"},{"type":"null","description":"Which font plays which typographic part. May be absent while the kit is still loading.","uniqueKey":"data.font_roles.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.font_roles","typeLabel":"BrandKitFontRoles · object | null"}},"required":["brand_kit_id","name","status"],"title":"BrandKitDetail","type":"object","uniqueKey":"data","typeLabel":"BrandKitDetail · object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"brand_kit_id":"\u003cstring>","name":"\u003cstring>","status":"loading","colors":["\u003cstring>"],"color_roles":{"primary":"\u003cstring>","secondary":"\u003cstring>","tertiary":"\u003cstring>","accent":"\u003cstring>"},"logos":[{"logo_id":"\u003cstring>","name":"\u003cstring>","url":"\u003cstring>"}],"logo_roles":{"primary":"\u003cstring>"},"fonts":[{"font_id":"\u003cstring>","name":"\u003cstring>"}],"font_roles":{"title_text":{"font_id":"\u003cstring>","weight":123},"body_text":{"font_id":"\u003cstring>","weight":123}}}}}},"exampleType":"generated"}},"exampleType":"generated"},"2e7a7fac-a87e-4a45-8cff-f764794eade1":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid_parameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Video not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"oneOf":[{"type":"string","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.doc_url","typeLabel":"string | null"},"errors":{"type":"array","description":"Per-item error details for batch/multi-node failures (e.g. graph compilation errors by node).","items":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"unknown_node_type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Unknown node type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"},"node_id":{"type":"string","description":"Graph node id this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].node_id","typeLabel":"string"},"port":{"type":"string","description":"Port name on the node this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].port","typeLabel":"string"},"path":{"type":"string","description":"Field path within the item this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].path","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Request identifier, also returned in the X-HeyGen-Request-Id response header. Include it when contacting support.","example":"8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40","uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_parameter","message":"Video not found","param":"\u003cstring>","doc_url":"\u003cstring>","errors":[{"code":"unknown_node_type","message":"Unknown node type","node_id":"\u003cstring>","port":"\u003cstring>","path":"\u003cstring>"}],"request_id":"8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ed103c70-9ff7-430d-8202-a07efa18bc5b":{"description":"Authentication failed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid_parameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Video not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"oneOf":[{"type":"string","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.doc_url","typeLabel":"string | null"},"errors":{"type":"array","description":"Per-item error details for batch/multi-node failures (e.g. graph compilation errors by node).","items":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"unknown_node_type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Unknown node type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"},"node_id":{"type":"string","description":"Graph node id this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].node_id","typeLabel":"string"},"port":{"type":"string","description":"Port name on the node this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].port","typeLabel":"string"},"path":{"type":"string","description":"Field path within the item this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].path","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Request identifier, also returned in the X-HeyGen-Request-Id response header. Include it when contacting support.","example":"8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40","uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"unauthorized","message":"Invalid or expired API key. Verify your x-api-key header.","param":null,"doc_url":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Invalid or expired API key. Verify your x-api-key header.","param":null,"doc_url":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"d44ec559-d587-4234-83f6-5a1e9632aee6":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid_parameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Video not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"oneOf":[{"type":"string","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.doc_url","typeLabel":"string | null"},"errors":{"type":"array","description":"Per-item error details for batch/multi-node failures (e.g. graph compilation errors by node).","items":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"unknown_node_type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Unknown node type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"},"node_id":{"type":"string","description":"Graph node id this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].node_id","typeLabel":"string"},"port":{"type":"string","description":"Port name on the node this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].port","typeLabel":"string"},"path":{"type":"string","description":"Field path within the item this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].path","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Request identifier, also returned in the X-HeyGen-Request-Id response header. Include it when contacting support.","example":"8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40","uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"resource_not_found","message":"Brand kit not found.","param":null,"doc_url":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"resource_not_found","message":"Brand kit not found.","param":null,"doc_url":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"d9c65453-0b6a-4cfd-ab5e-377636640193":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid_parameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Video not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"oneOf":[{"type":"string","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.doc_url","typeLabel":"string | null"},"errors":{"type":"array","description":"Per-item error details for batch/multi-node failures (e.g. graph compilation errors by node).","items":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"unknown_node_type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Unknown node type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"},"node_id":{"type":"string","description":"Graph node id this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].node_id","typeLabel":"string"},"port":{"type":"string","description":"Port name on the node this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].port","typeLabel":"string"},"path":{"type":"string","description":"Field path within the item this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].path","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Request identifier, also returned in the X-HeyGen-Request-Id response header. Include it when contacting support.","example":"8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40","uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"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}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limit_exceeded","message":"Too many requests. Retry after the duration specified in the Retry-After header.","param":null,"doc_url":null}}}},"exampleType":"examples"}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"exampleType":"examples"}},"security":{"f1d35e90-d440-48f1-b0b1-da6afd0c7fe4":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"HeyGen API key. Obtain from your HeyGen dashboard.","scopes":[],"schemeName":"ApiKeyAuth"}},"10f7b2d3-5e1d-4a79-ad57-a4ea4e0f32c0":{"BearerAuth":{"type":"http","scheme":"bearer","description":"OAuth2 bearer token.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"28619676-a185-4308-8c18-0a2b6156ed0d":{"url":"https://api.heygen.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"HeyGen API key. Obtain from your HeyGen dashboard.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"HeyGen API key. Obtain from your HeyGen dashboard.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"OAuth2 bearer token.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"OAuth2 bearer token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi/external-api.json"},"subdomain":"heygen-1fa696a7","siteName":"HeyGen Documentation","title":"Get Brand Kit - HeyGen Documentation","relatedPagesConfig":{"enabled":true,"limit":8,"mode":"manual"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T01:17:54.846Z","originalFileLocation":"reference/get-brand-kit.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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.\">\u003cmeta data-mint-head name=\"application-name\" content=\"HeyGen Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Brand Kit - HeyGen Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"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.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"HeyGen Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://heygen-1fa696a7.mintlify.app/reference/get-brand-kit\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://heygen-1fa696a7.mintlify.site/_mintlify/api/og/v2?division=Brand\u0026amp;title=Get+Brand+Kit\u0026amp;description=Returns+one+brand+kit+with+its+colors%2C+logos+and+fonts+and+the+role+each+plays.+While+status+is+%60loading%60+these+are+provisional%3B+poll+every+2+to+5+seconds+until\u0026amp;theme=806bfcae4fd50c26d3779ac8\u0026amp;signature=b1f50b8d4bdf778e48e22719c5968eda22b7a4d99588b427176bab235db931ad\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Brand Kit - HeyGen Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://heygen-1fa696a7.mintlify.site/_mintlify/api/og/v2?division=Brand\u0026amp;title=Get+Brand+Kit\u0026amp;description=Returns+one+brand+kit+with+its+colors%2C+logos+and+fonts+and+the+role+each+plays.+While+status+is+%60loading%60+these+are+provisional%3B+poll+every+2+to+5+seconds+until\u0026amp;theme=806bfcae4fd50c26d3779ac8\u0026amp;signature=b1f50b8d4bdf778e48e22719c5968eda22b7a4d99588b427176bab235db931ad\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"HeyGen Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#03C3FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://heygen-1fa696a7.mintlify.app/reference/get-brand-kit\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/get-brand-kit.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://heygen-1fa696a7.mintlify.app/#organization\",\"name\":\"HeyGen Documentation\",\"url\":\"https://heygen-1fa696a7.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/heygen-1fa696a7/dQ_uLJDftFYFhC7B/logo/light.png?fit=max\u0026auto=format\u0026n=dQ_uLJDftFYFhC7B\u0026q=85\u0026s=b03d2e41dde1cc0b50cd50e574f66f1c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://heygen-1fa696a7.mintlify.app#website\",\"name\":\"HeyGen Documentation\",\"url\":\"https://heygen-1fa696a7.mintlify.app\",\"publisher\":{\"@id\":\"https://heygen-1fa696a7.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://heygen-1fa696a7.mintlify.app/reference/get-brand-kit#webpage\",\"url\":\"https://heygen-1fa696a7.mintlify.app/reference/get-brand-kit\",\"name\":\"Get Brand Kit\",\"description\":\"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.\",\"dateModified\":\"2026-11-12T01:17:54.846Z\",\"isPartOf\":{\"@id\":\"https://heygen-1fa696a7.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://heygen-1fa696a7.mintlify.app/reference/get-brand-kit#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://heygen-1fa696a7.mintlify.app/reference/get-brand-kit#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Brand\",\"item\":\"https://heygen-1fa696a7.mintlify.app/reference/list-brand-glossaries\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Brand Kit\",\"item\":\"https://heygen-1fa696a7.mintlify.app/reference/get-brand-kit\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://heygen-1fa696a7.mintlify.app/reference/get-brand-kit#apireference\",\"headline\":\"Get Brand Kit\",\"name\":\"Get Brand Kit\",\"description\":\"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.\",\"url\":\"https://heygen-1fa696a7.mintlify.app/reference/get-brand-kit\",\"mainEntityOfPage\":{\"@id\":\"https://heygen-1fa696a7.mintlify.app/reference/get-brand-kit#webpage\"},\"dateModified\":\"2026-11-12T01:17:54.846Z\",\"publisher\":{\"@id\":\"https://heygen-1fa696a7.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://heygen-1fa696a7.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"HeyGen Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"HeyGen Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/get-brand-kit.md","siteName":"HeyGen Documentation","nav":{"global":null,"tabs":[{"tab":"Developer Guide","pages":[{"title":"Developer Guide","href":"/docs/quick-start"}]},{"tab":"API Reference","groups":[{"group":"Video Agent","pages":[{"title":"List Video Agent Sessions","deprecated":null,"version":null,"sidebarTitle":"List video agent sessions","openapi":"/openapi/external-api.json get /v3/video-agents","href":"/reference/list-video-agent-sessions"},{"title":"Create Video Agent Session","deprecated":null,"version":null,"sidebarTitle":"Create video agent session","openapi":"/openapi/external-api.json post /v3/video-agents","href":"/reference/create-video-agent-session"},{"title":"List Video Agent Styles","deprecated":null,"version":null,"sidebarTitle":"List video agent styles","openapi":"/openapi/external-api.json get /v3/video-agents/styles","href":"/reference/list-video-agent-styles"},{"title":"Get Video Agent Session","deprecated":null,"version":null,"sidebarTitle":"Get video agent session","openapi":"/openapi/external-api.json get /v3/video-agents/{session_id}","href":"/reference/get-video-agent-session"},{"title":"Send Video Agent Message","deprecated":null,"version":null,"sidebarTitle":"Send message or request revision","openapi":"/openapi/external-api.json post /v3/video-agents/{session_id}","href":"/reference/send-message-or-request-revision"},{"title":"Get Session Resource","deprecated":null,"version":null,"sidebarTitle":"Get session resource","openapi":"/openapi/external-api.json get /v3/video-agents/{session_id}/resources/{resource_id}","href":"/reference/get-session-resource"},{"title":"List Session Videos","deprecated":null,"version":null,"sidebarTitle":"List session videos","openapi":"/openapi/external-api.json get /v3/video-agents/{session_id}/videos","href":"/reference/list-session-videos"},{"title":"Stop Video Agent Session","deprecated":null,"version":null,"sidebarTitle":"Stop video agent session","openapi":"/openapi/external-api.json post /v3/video-agents/{session_id}/stop","href":"/reference/stop-video-agent-session"}]},{"group":"Brand","pages":[{"title":"List Brand Glossaries","deprecated":null,"version":null,"sidebarTitle":"List brand glossaries","openapi":"/openapi/external-api.json get /v3/brand-glossaries","href":"/reference/list-brand-glossaries"},{"title":"Create Brand Glossary","deprecated":null,"version":null,"sidebarTitle":"Create brand glossary","openapi":"/openapi/external-api.json post /v3/brand-glossaries","href":"/reference/create-brand-glossary"},{"title":"List Brand Kits","deprecated":null,"version":null,"sidebarTitle":"List brand kits","openapi":"/openapi/external-api.json get /v3/brand-kits","href":"/reference/list-brand-kits"},{"title":"Create Brand Kit","description":"Creates a brand kit by importing logos, colors and fonts from a public website; by calling it you confirm you have the rights to use those assets. The kit assembles in the background: poll GET /v3/brand-kits/{brand_kit_id} until status is `completed`. Send an Idempotency-Key to make retries safe.","deprecated":null,"version":null,"sidebarTitle":"Create brand kit","openapi":"/openapi/external-api.json post /v3/brand-kits","href":"/reference/create-brand-kit"},{"title":"Get Brand Kit","deprecated":null,"version":null,"sidebarTitle":"Get brand kit","openapi":"/openapi/external-api.json get /v3/brand-kits/{brand_kit_id}","href":"/reference/get-brand-kit"},{"title":"Delete Brand Kit","description":"Deletes a brand kit and its colors, logos and fonts. This cannot be undone. Videos already rendered with it are unaffected. A kit shared from another workspace cannot be deleted and returns 403.","deprecated":null,"version":null,"sidebarTitle":"Delete brand kit","openapi":"/openapi/external-api.json delete /v3/brand-kits/{brand_kit_id}","href":"/reference/delete-brand-kit"},{"title":"Update Brand Kit","deprecated":null,"version":null,"sidebarTitle":"Update brand kit","openapi":"/openapi/external-api.json patch /v3/brand-kits/{brand_kit_id}","href":"/reference/update-brand-kit"},{"title":"Get Brand Glossary","deprecated":null,"version":null,"sidebarTitle":"Get brand glossary","openapi":"/openapi/external-api.json get /v3/brand-glossaries/{brand_glossary_id}","href":"/reference/get-brand-glossary"},{"title":"Delete Brand Glossary","deprecated":null,"version":null,"sidebarTitle":"Delete brand glossary","openapi":"/openapi/external-api.json delete /v3/brand-glossaries/{brand_glossary_id}","href":"/reference/delete-brand-glossary"},{"title":"Update Brand Glossary","deprecated":null,"version":null,"sidebarTitle":"Update brand glossary","openapi":"/openapi/external-api.json patch /v3/brand-glossaries/{brand_glossary_id}","href":"/reference/update-brand-glossary"}]},{"group":"Avatars","pages":[{"title":"List Avatar Groups","deprecated":null,"version":null,"sidebarTitle":"List avatar groups","openapi":"/openapi/external-api.json get /v3/avatars","href":"/reference/list-avatar-groups"},{"title":"Create Avatar","deprecated":null,"version":null,"sidebarTitle":"Create avatar","openapi":"/openapi/external-api.json post /v3/avatars","href":"/reference/create-avatar"},{"title":"Get Avatar Group","deprecated":null,"version":null,"sidebarTitle":"Get avatar group","openapi":"/openapi/external-api.json get /v3/avatars/{group_id}","href":"/reference/get-avatar-group"},{"title":"Delete Avatar Group","deprecated":null,"version":null,"sidebarTitle":"Delete avatar group","openapi":"/openapi/external-api.json delete /v3/avatars/{group_id}","href":"/reference/delete-avatar-group"},{"title":"Update Avatar Group","deprecated":null,"version":null,"sidebarTitle":"Update avatar group","openapi":"/openapi/external-api.json patch /v3/avatars/{group_id}","href":"/reference/update-avatar-group"},{"title":"Create Avatar Consent","deprecated":null,"version":null,"sidebarTitle":"Create avatar consent","openapi":"/openapi/external-api.json post /v3/avatars/{group_id}/consent","href":"/reference/create-avatar-consent"},{"title":"List Avatar Looks","deprecated":null,"version":null,"sidebarTitle":"List avatar looks","openapi":"/openapi/external-api.json get /v3/avatars/looks","href":"/reference/list-avatar-looks"},{"title":"Create Avatar Looks","deprecated":null,"version":null,"sidebarTitle":"Create avatar looks","openapi":"/openapi/external-api.json post /v3/avatars/looks","href":"/reference/create-avatar-looks"},{"title":"List Look Templates","deprecated":null,"version":null,"sidebarTitle":"List look templates","openapi":"/openapi/external-api.json get /v3/avatars/look-templates","href":"/reference/list-look-templates"},{"title":"Get Avatar Look","deprecated":null,"version":null,"sidebarTitle":"Get avatar look","openapi":"/openapi/external-api.json get /v3/avatars/looks/{look_id}","href":"/reference/get-avatar-look"},{"title":"Delete Avatar Look","deprecated":null,"version":null,"sidebarTitle":"Delete avatar look","openapi":"/openapi/external-api.json delete /v3/avatars/looks/{look_id}","href":"/reference/delete-avatar-look"},{"title":"Update Avatar Look","deprecated":null,"version":null,"sidebarTitle":"Update avatar look","openapi":"/openapi/external-api.json patch /v3/avatars/looks/{look_id}","href":"/reference/update-avatar-look"}]},{"group":"Audio","pages":[{"title":"Search audio (music or sound effects)","deprecated":null,"version":null,"sidebarTitle":"Search audio music or sound effects","openapi":"/openapi/external-api.json get /v3/audio/sounds","href":"/reference/search-audio-music-or-sound-effects"}]},{"group":"Models","pages":[{"title":"List Audio Voices","deprecated":null,"version":null,"sidebarTitle":"List audio voices","openapi":"/openapi/external-api.json get /v3/models/audio/voices","href":"/reference/list-audio-voices"},{"title":"Create or Retrain an Audio Voice","deprecated":null,"version":null,"sidebarTitle":"Create or retrain an audio voice","openapi":"/openapi/external-api.json post /v3/models/audio/voices","href":"/reference/create-or-retrain-an-audio-voice"},{"title":"Convert Speech","deprecated":null,"version":null,"sidebarTitle":"Convert model speech","openapi":"/openapi/external-api.json post /v3/models/audio/sts","href":"/reference/convert-model-speech"},{"title":"Generate Speech","deprecated":null,"version":null,"sidebarTitle":"Generate model speech","openapi":"/openapi/external-api.json post /v3/models/audio/tts","href":"/reference/generate-model-speech"},{"title":"Stream Speech","deprecated":null,"version":null,"sidebarTitle":"Stream speech","openapi":"/openapi/external-api.json post /v3/models/audio/tts/stream","href":"/reference/stream-speech"},{"title":"Create Speech Input Token","deprecated":null,"version":null,"sidebarTitle":"Create speech input token","openapi":"/openapi/external-api.json post /v3/models/audio/tts/stream-input/tokens","href":"/reference/create-speech-input-token"},{"title":"Get an Audio Voice","deprecated":null,"version":null,"sidebarTitle":"Get an audio voice","openapi":"/openapi/external-api.json get /v3/models/audio/voices/{voice_id}","href":"/reference/get-an-audio-voice"},{"title":"Delete an Audio Voice","deprecated":null,"version":null,"sidebarTitle":"Delete an audio voice","openapi":"/openapi/external-api.json delete /v3/models/audio/voices/{voice_id}","href":"/reference/delete-an-audio-voice"},{"title":"Create HeyGen Video","deprecated":null,"version":null,"sidebarTitle":"Create heygen video","openapi":"/openapi/external-api.json post /v3/models/videos","href":"/reference/create-heygen-video"},{"title":"Get HeyGen Video","deprecated":null,"version":null,"sidebarTitle":"Get heygen video","openapi":"/openapi/external-api.json get /v3/models/videos/{video_id}","href":"/reference/get-heygen-video"},{"title":"Create HeyGen Image","deprecated":null,"version":null,"sidebarTitle":"Create heygen image","openapi":"/openapi/external-api.json post /v3/models/images","href":"/reference/create-heygen-image"},{"title":"Get HeyGen Image","deprecated":null,"version":null,"sidebarTitle":"Get heygen image","openapi":"/openapi/external-api.json get /v3/models/images/{generation_id}","href":"/reference/get-heygen-image"}]},{"group":"Videos","pages":[{"title":"List Videos","deprecated":null,"version":null,"sidebarTitle":"List videos","openapi":"/openapi/external-api.json get /v3/videos","href":"/reference/list-videos"},{"title":"Create Video","deprecated":null,"version":null,"sidebarTitle":"Create video","openapi":"/openapi/external-api.json post /v3/videos","href":"/reference/create-video"},{"title":"Get Video Voice Capabilities","deprecated":null,"version":null,"sidebarTitle":"Get video voice capabilities","openapi":"/openapi/external-api.json get /v3/videos/voice-capabilities","href":"/reference/get-video-voice-capabilities"},{"title":"Get Video","deprecated":null,"version":null,"sidebarTitle":"Get video","openapi":"/openapi/external-api.json get /v3/videos/{video_id}","href":"/reference/get-video"},{"title":"Delete Video","deprecated":null,"version":null,"sidebarTitle":"Delete video","openapi":"/openapi/external-api.json delete /v3/videos/{video_id}","href":"/reference/delete-video"},{"title":"Get Video Scenes","deprecated":null,"version":null,"sidebarTitle":"Get video scenes","openapi":"/openapi/external-api.json get /v3/videos/{video_id}/scenes","href":"/reference/get-video-scenes"}]},{"group":"Templates","pages":[{"title":"List Templates","deprecated":null,"version":null,"sidebarTitle":"List templates","openapi":"/openapi/external-api.json get /v3/templates","href":"/reference/list-templates"},{"title":"Create Template from Video","deprecated":null,"version":null,"sidebarTitle":"Create template from video","openapi":"/openapi/external-api.json post /v3/templates","href":"/reference/create-template-from-video"},{"title":"Get Template","deprecated":null,"version":null,"sidebarTitle":"Get template","openapi":"/openapi/external-api.json get /v3/templates/{template_id}","href":"/reference/get-template"},{"title":"Generate Video from Template","deprecated":null,"version":null,"sidebarTitle":"Generate video from template","openapi":"/openapi/external-api.json post /v3/templates/{template_id}","href":"/reference/generate-video-from-template"},{"title":"Delete Template","deprecated":null,"version":null,"sidebarTitle":"Delete template","openapi":"/openapi/external-api.json delete /v3/templates/{template_id}","href":"/reference/delete-template"},{"title":"Update Template","deprecated":null,"version":null,"sidebarTitle":"Update template","openapi":"/openapi/external-api.json patch /v3/templates/{template_id}","href":"/reference/update-template"},{"title":"Set Template Variables","deprecated":null,"version":null,"sidebarTitle":"Set template variables","openapi":"/openapi/external-api.json put /v3/templates/{template_id}/variables","href":"/reference/set-template-variables"}]},{"group":"Video Translate","pages":[{"title":"List Video Translations","deprecated":null,"version":null,"sidebarTitle":"List video translations","openapi":"/openapi/external-api.json get /v3/video-translations","href":"/reference/list-video-translations"},{"title":"Create Video Translation","deprecated":null,"version":null,"sidebarTitle":"Create video translation","openapi":"/openapi/external-api.json post /v3/video-translations","href":"/reference/create-video-translation"},{"title":"Get Video Translation","deprecated":null,"version":null,"sidebarTitle":"Get video translation","openapi":"/openapi/external-api.json get /v3/video-translations/{video_translation_id}","href":"/reference/get-video-translation"},{"title":"Delete Video Translation","deprecated":null,"version":null,"sidebarTitle":"Delete video translation","openapi":"/openapi/external-api.json delete /v3/video-translations/{video_translation_id}","href":"/reference/delete-video-translation"},{"title":"Update Video Translation","deprecated":null,"version":null,"sidebarTitle":"Update video translation","openapi":"/openapi/external-api.json patch /v3/video-translations/{video_translation_id}","href":"/reference/update-video-translation"},{"title":"List Supported Translation Languages","deprecated":null,"version":null,"sidebarTitle":"List supported translation languages","openapi":"/openapi/external-api.json get /v3/video-translations/languages","href":"/reference/list-supported-translation-languages"},{"title":"List Proofread Sessions","deprecated":null,"version":null,"sidebarTitle":"List proofread sessions","openapi":"/openapi/external-api.json get /v3/video-translations/proofreads","href":"/reference/list-proofread-sessions"},{"title":"Create Proofread Session","deprecated":null,"version":null,"sidebarTitle":"Create proofread session","openapi":"/openapi/external-api.json post /v3/video-translations/proofreads","href":"/reference/create-proofread-session"},{"title":"Get Proofread Session","deprecated":null,"version":null,"sidebarTitle":"Get proofread session","openapi":"/openapi/external-api.json get /v3/video-translations/proofreads/{proofread_id}","href":"/reference/get-proofread-session"},{"title":"Delete Proofread Session","deprecated":null,"version":null,"sidebarTitle":"Delete proofread session","openapi":"/openapi/external-api.json delete /v3/video-translations/proofreads/{proofread_id}","href":"/reference/delete-proofread-session"},{"title":"Download Proofread SRT","deprecated":null,"version":null,"sidebarTitle":"Download proofread srt","openapi":"/openapi/external-api.json get /v3/video-translations/proofreads/{proofread_id}/srt","href":"/reference/download-proofread-srt"},{"title":"Upload Proofread SRT","deprecated":null,"version":null,"sidebarTitle":"Upload proofread srt","openapi":"/openapi/external-api.json put /v3/video-translations/proofreads/{proofread_id}/srt","href":"/reference/upload-proofread-srt"},{"title":"Generate Video from Proofread","deprecated":null,"version":null,"sidebarTitle":"Generate video from proofread","openapi":"/openapi/external-api.json post /v3/video-translations/proofreads/{proofread_id}/generate","href":"/reference/generate-video-from-proofread"}]},{"group":"Lipsync","pages":[{"title":"List Lipsyncs","deprecated":null,"version":null,"sidebarTitle":"List lipsyncs","openapi":"/openapi/external-api.json get /v3/lipsyncs","href":"/reference/list-lipsyncs"},{"title":"Create Lipsync","deprecated":null,"version":null,"sidebarTitle":"Create lipsync","openapi":"/openapi/external-api.json post /v3/lipsyncs","href":"/reference/create-lipsync"},{"title":"Get Lipsync","deprecated":null,"version":null,"sidebarTitle":"Get lipsync","openapi":"/openapi/external-api.json get /v3/lipsyncs/{lipsync_id}","href":"/reference/get-lipsync"},{"title":"Delete Lipsync","deprecated":null,"version":null,"sidebarTitle":"Delete lipsync","openapi":"/openapi/external-api.json delete /v3/lipsyncs/{lipsync_id}","href":"/reference/delete-lipsync"},{"title":"Update Lipsync","deprecated":null,"version":null,"sidebarTitle":"Update lipsync","openapi":"/openapi/external-api.json patch /v3/lipsyncs/{lipsync_id}","href":"/reference/update-lipsync"}]},{"group":"HyperFrames","pages":[{"title":"List HyperFrames Renders","deprecated":null,"version":null,"sidebarTitle":"List hyperframes renders","openapi":"/openapi/external-api.json get /v3/hyperframes/renders","href":"/reference/list-hyperframes-renders"},{"title":"Create HyperFrames Render","deprecated":null,"version":null,"sidebarTitle":"Create hyperframes render","openapi":"/openapi/external-api.json post /v3/hyperframes/renders","href":"/reference/create-hyperframes-render"},{"title":"Get HyperFrames Render","deprecated":null,"version":null,"sidebarTitle":"Get hyperframes render","openapi":"/openapi/external-api.json get /v3/hyperframes/renders/{render_id}","href":"/reference/get-hyperframes-render"},{"title":"Delete HyperFrames Render","deprecated":null,"version":null,"sidebarTitle":"Delete hyperframes render","openapi":"/openapi/external-api.json delete /v3/hyperframes/renders/{render_id}","href":"/reference/delete-hyperframes-render"}]},{"group":"User","pages":[{"title":"Get Current User","deprecated":null,"version":null,"sidebarTitle":"Get current user","openapi":"/openapi/external-api.json get /v3/users/me","href":"/reference/get-current-user"}]},{"group":"API Keys","pages":[{"title":"Get Current API Key","deprecated":null,"version":null,"sidebarTitle":"Get current api key","openapi":"/openapi/external-api.json get /v3/api_keys/self","href":"/reference/get-current-api-key"}]},{"group":"Webhooks","pages":[{"title":"List Webhook Event Types","deprecated":null,"version":null,"sidebarTitle":"List webhook event types","openapi":"/openapi/external-api.json get /v3/webhooks/event-types","href":"/reference/list-webhook-event-types"},{"title":"List Webhook Endpoints","deprecated":null,"version":null,"sidebarTitle":"List webhook endpoints","openapi":"/openapi/external-api.json get /v3/webhooks/endpoints","href":"/reference/list-webhook-endpoints"},{"title":"Create Webhook Endpoint","deprecated":null,"version":null,"sidebarTitle":"Create webhook endpoint","openapi":"/openapi/external-api.json post /v3/webhooks/endpoints","href":"/reference/create-webhook-endpoint"},{"title":"Delete Webhook Endpoint","deprecated":null,"version":null,"sidebarTitle":"Delete webhook endpoint","openapi":"/openapi/external-api.json delete /v3/webhooks/endpoints/{endpoint_id}","href":"/reference/delete-webhook-endpoint"},{"title":"Update Webhook Endpoint","deprecated":null,"version":null,"sidebarTitle":"Update webhook endpoint","openapi":"/openapi/external-api.json patch /v3/webhooks/endpoints/{endpoint_id}","href":"/reference/update-webhook-endpoint"},{"title":"Rotate Webhook Signing Secret","deprecated":null,"version":null,"sidebarTitle":"Rotate webhook signing secret","openapi":"/openapi/external-api.json post /v3/webhooks/endpoints/{endpoint_id}/rotate-secret","href":"/reference/rotate-webhook-signing-secret"},{"title":"List Webhook Events","deprecated":null,"version":null,"sidebarTitle":"List webhook events","openapi":"/openapi/external-api.json get /v3/webhooks/events","href":"/reference/list-webhook-events"}]},{"group":"Folders","pages":[{"title":"Create Folder","deprecated":null,"version":null,"sidebarTitle":"Create folder","openapi":"/openapi/external-api.json post /v3/folders","href":"/reference/create-folder"},{"title":"Get Folder","deprecated":null,"version":null,"sidebarTitle":"Get folder","openapi":"/openapi/external-api.json get /v3/folders/{folder_id}","href":"/reference/get-folder"}]},{"group":"Assets","pages":[{"title":"Upload Asset","deprecated":null,"version":null,"sidebarTitle":"Upload asset","openapi":"/openapi/external-api.json post /v3/assets","href":"/reference/upload-asset"},{"title":"Get Asset","deprecated":null,"version":null,"sidebarTitle":"Get asset","openapi":"/openapi/external-api.json get /v3/assets/{asset_id}","href":"/reference/get-asset"},{"title":"Delete Asset","deprecated":null,"version":null,"sidebarTitle":"Delete asset","openapi":"/openapi/external-api.json delete /v3/assets/{asset_id}","href":"/reference/delete-asset"},{"title":"Create Asset Upload","deprecated":null,"version":null,"sidebarTitle":"Create asset upload","openapi":"/openapi/external-api.json post /v3/assets/direct-uploads","href":"/reference/create-asset-upload"},{"title":"Complete Asset Upload","deprecated":null,"version":null,"sidebarTitle":"Complete asset upload","openapi":"/openapi/external-api.json post /v3/assets/{asset_id}/complete","href":"/reference/complete-asset-upload"},{"title":"List Uploaded Asset Parts","deprecated":null,"version":null,"sidebarTitle":"List uploaded asset parts","openapi":"/openapi/external-api.json get /v3/assets/{asset_id}/parts","href":"/reference/list-uploaded-asset-parts"},{"title":"Get Asset Upload Part URLs","deprecated":null,"version":null,"sidebarTitle":"Get asset upload part urls","openapi":"/openapi/external-api.json post /v3/assets/{asset_id}/parts","href":"/reference/get-asset-upload-part-urls"},{"title":"Abort Asset Upload Parts","deprecated":null,"version":null,"sidebarTitle":"Abort asset upload parts","openapi":"/openapi/external-api.json delete /v3/assets/{asset_id}/parts","href":"/reference/abort-asset-upload-parts"}]},{"group":"AI Clipping","pages":[{"title":"Get AI Clipping","deprecated":null,"version":null,"sidebarTitle":"Get ai clipping","openapi":"/openapi/external-api.json get /v3/ai-clipping/{job_id}","href":"/reference/get-ai-clipping"},{"title":"Delete AI Clipping","deprecated":null,"version":null,"sidebarTitle":"Delete ai clipping","openapi":"/openapi/external-api.json delete /v3/ai-clipping/{job_id}","href":"/reference/delete-ai-clipping"},{"title":"List AI Clipping","deprecated":null,"version":null,"sidebarTitle":"List ai clipping","openapi":"/openapi/external-api.json get /v3/ai-clipping","href":"/reference/list-ai-clipping"},{"title":"Create AI Clipping","deprecated":null,"version":null,"sidebarTitle":"Create ai clipping","openapi":"/openapi/external-api.json post /v3/ai-clipping","href":"/reference/create-ai-clipping"}]},{"group":"Filler Word Removal","pages":[{"title":"Create Filler Word Removal","deprecated":null,"version":null,"sidebarTitle":"Create filler word removal","openapi":"/openapi/external-api.json post /v3/filler-word-removals","href":"/reference/create-filler-word-removal"},{"title":"Get Filler Word Removal","deprecated":null,"version":null,"sidebarTitle":"Get filler word removal","openapi":"/openapi/external-api.json get /v3/filler-word-removals/{filler_word_removal_id}","href":"/reference/get-filler-word-removal"}]},{"group":"Batches","pages":[{"title":"Create Video Batch","deprecated":null,"version":null,"sidebarTitle":"Create video batch","openapi":"/openapi/external-api.json post /v3/videos/batches","href":"/reference/create-video-batch"},{"title":"Get Video Batch","deprecated":null,"version":null,"sidebarTitle":"Get video batch","openapi":"/openapi/external-api.json get /v3/videos/batches/{batch_id}","href":"/reference/get-video-batch"},{"title":"Bulk Video Statuses","deprecated":null,"version":null,"sidebarTitle":"Bulk video statuses","openapi":"/openapi/external-api.json get /v3/videos/statuses","href":"/reference/bulk-video-statuses"}]},{"group":"Video Translation Batches","pages":[{"title":"Create Video Translation Batch","deprecated":null,"version":null,"sidebarTitle":"Create video translation batch","openapi":"/openapi/external-api.json post /v3/video-translations/batches","href":"/reference/create-video-translation-batch"},{"title":"Get Video Translation Batch","deprecated":null,"version":null,"sidebarTitle":"Get video translation batch","openapi":"/openapi/external-api.json get /v3/video-translations/batches/{batch_id}","href":"/reference/get-video-translation-batch"},{"title":"Bulk Video Translation Statuses","deprecated":null,"version":null,"sidebarTitle":"Bulk video translation statuses","openapi":"/openapi/external-api.json get /v3/video-translations/statuses","href":"/reference/bulk-video-translation-statuses"}]},{"group":"Lipsync Batches","pages":[{"title":"Create Lipsync Batch","deprecated":null,"version":null,"sidebarTitle":"Create lipsync batch","openapi":"/openapi/external-api.json post /v3/lipsyncs/batches","href":"/reference/create-lipsync-batch"},{"title":"Get Lipsync Batch","deprecated":null,"version":null,"sidebarTitle":"Get lipsync batch","openapi":"/openapi/external-api.json get /v3/lipsyncs/batches/{batch_id}","href":"/reference/get-lipsync-batch"},{"title":"Bulk Lipsync Statuses","deprecated":null,"version":null,"sidebarTitle":"Bulk lipsync statuses","openapi":"/openapi/external-api.json get /v3/lipsyncs/statuses","href":"/reference/bulk-lipsync-statuses"}]},{"group":"Asset Batches","pages":[{"title":"Create Asset Upload Batch","deprecated":null,"version":null,"sidebarTitle":"Create asset upload batch","openapi":"/openapi/external-api.json post /v3/assets/direct-uploads/batches","href":"/reference/create-asset-upload-batch"},{"title":"Complete Asset Upload Batch","deprecated":null,"version":null,"sidebarTitle":"Complete asset upload batch","openapi":"/openapi/external-api.json post /v3/assets/complete/batches","href":"/reference/complete-asset-upload-batch"},{"title":"Get Asset Batch","deprecated":null,"version":null,"sidebarTitle":"Get asset batch","openapi":"/openapi/external-api.json get /v3/assets/batches/{batch_id}","href":"/reference/get-asset-batch"},{"title":"Bulk Asset Statuses","deprecated":null,"version":null,"sidebarTitle":"Bulk asset statuses","openapi":"/openapi/external-api.json get /v3/assets/statuses","href":"/reference/bulk-asset-statuses"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"Skills","pages":[{"title":"Skills","href":"/skills/overview"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Get help","pages":[{"title":"Get help","href":"/docs/discord"}]}]},"basePath":"","title":"Get Brand Kit - HeyGen Documentation","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-C4GwDT3_.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}