API ReferenceBrand kits
Read a brand from its website
Reads the website and suggests a name, colours, fonts and logos. Nothing is saved: pass what you want to keep to POST /v1/brand-kits (import the logo with POST /v1/media first). Uses the workspace's connected Brandfetch account when there is one (no credits), else AI (a few credits; paid plans and trials).
Authorization
api-key AuthorizationBearer <token>
Workspace API key (nim_live_...)
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/brand-kits/import" \ -H "Content-Type: application/json" \ -d '{ "website": "brewhaus.coffee" }'{ "domain": "brewhaus.coffee", "name": "Brewhaus", "colors": [ "#F0530F", "#1B1815" ], "fonts": { "heading": { "family": "Inter", "weight": 700 }, "subheading": { "family": "Inter", "weight": 700 }, "body": { "family": "Inter", "weight": 700 } }, "fontCandidates": [ "string" ], "suggestedLogoUrl": "string", "logos": [ { "url": "string", "type": "logo", "theme": "light", "format": "png" } ], "creditsCharged": 3}Empty
Empty
Empty
Empty