API ReferenceBrand kits
Create a brand kit from several sources
Starts reading up to 6 sources in any mix — a website, pasted text, a PDF brand book, a connected channel, uploaded images — into one draft brand kit. Upload PDFs and images first (POST /v1/media/uploads) and pass their media ids. Returns 202 with the import and its estimate; reading takes about a minute — poll GET /v1/brand-kits/imports/{id} until status is ready, review the draft (each value says which source it came from; colorConflicts lists where sources disagree), then POST …/save. Pass brandKitId to add the sources (e.g. a new brand book PDF) to an existing kit instead: the ready import then has target (what would change; the kit’s own values win by default) and save updates that kit, optionally replacing its current brand book (replaceBrandBook). Spends AI credits: up to estimate.creditsMax is held and only what is really used is charged. PDF, text, channel and image sources need a paid plan or a trial.
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/imports" \ -H "Content-Type: application/json" \ -d '{ "sources": [ { "kind": "website" } ] }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "queued", "sources": [ { "kind": "website", "label": "Brand book.pdf", "state": "waiting", "error": "string" } ], "draft": { "name": { "value": "string", "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ], "options": [ { "value": "string", "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ] } ] }, "colors": [ { "hex": "#5F8EFD", "role": "primary", "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ] } ], "colorConflicts": [ { "role": "primary", "options": [ { "hex": "#515DEF", "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ] } ] } ], "fonts": { "heading": { "family": "Anton", "weight": 700, "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ], "options": [ { "family": "Anton", "weight": 700, "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ] } ] }, "subheading": { "family": "Anton", "weight": 700, "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ], "options": [ { "family": "Anton", "weight": 700, "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ] } ] }, "body": { "family": "Anton", "weight": 700, "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ], "options": [ { "family": "Anton", "weight": 700, "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ] } ] } }, "fontUploads": [ { "family": "Circular Std", "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ] } ], "logos": [ { "mediaId": "5a8ffac5-2288-485d-b463-90c3cd9941ad", "url": "string", "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ] } ], "voice": { "value": "string", "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ], "options": [ { "value": "string", "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ] } ] }, "voiceSamples": [ { "text": "string", "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ] } ], "guidelines": { "value": "string", "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ] }, "doNots": [ { "text": "string", "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ] } ], "examples": [ { "mediaId": "5a8ffac5-2288-485d-b463-90c3cd9941ad", "postId": "1d33c5d7-f0cb-41cc-a647-907f16832fc3", "sources": [ { "index": 0, "kind": "website", "label": "Brand book.pdf", "detail": "p.3" } ] } ], "examplesCount": 8, "warnings": [ "string" ] }, "creditsReserved": 45, "creditsUsed": 31, "error": "string", "brandKitId": "0d0050df-b55b-4bc4-9157-db98df0f07d0", "targetBrandKitId": "37cd2e00-cd59-451a-a807-f46d0b6f5445", "target": { "brandKitId": "0d0050df-b55b-4bc4-9157-db98df0f07d0", "brandKitName": "JobCanDo", "hasLogo": true, "colors": { "kit": [ "#5F8EFD" ], "found": [ "string" ], "added": [ "string" ] }, "fonts": { "heading": { "kit": { "family": "Poppins", "weight": 700 }, "found": { "family": "Poppins", "weight": 700 } }, "subheading": { "kit": { "family": "Poppins", "weight": 700 }, "found": { "family": "Poppins", "weight": 700 } }, "body": { "kit": { "family": "Poppins", "weight": 700 }, "found": { "family": "Poppins", "weight": 700 } } }, "voice": { "kit": "string", "found": "string" }, "guidelines": { "kit": "string", "found": "string" }, "defaults": { "colors": "kit", "fonts": { "body": "found" }, "voice": "kit", "guidelines": "kit" }, "brandBooks": [ { "importId": "84402506-7f34-4409-8ec1-a4e0ffb6b608", "mediaId": "5a8ffac5-2288-485d-b463-90c3cd9941ad", "name": "Brand guidelines.pdf", "images": 6, "addedAt": "2019-08-24T14:15:22Z" } ] }, "expiresAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "estimate": { "sources": [ { "kind": "website", "label": "brewhaus.coffee", "creditsMax": 12 } ], "creditsMax": 45, "creditsAvailable": 1840 }}Empty
Empty
Empty
Empty
Empty