Nimply Developers
API ReferenceBrand kits

Save a brand import as a brand kit

POST
/v1/brand-kits/imports/{id}/save

Creates the kit from the ready draft with your picks (name, a colour per conflicting role, fonts, voice) and logo choice — or, for an import that adds to a kit (targetBrandKitId), updates that kit: per field apply keeps the kit's value (the default where it has one) or uses the one found, the kit keeps its logo unless logo is sent, and replaceBrandBook: true replaces its current brand book. The don'ts become rules of the kit's learned look and the example designs are added to it. With learn: true (and at least 3 examples) learning the look starts too — that spends AI credits; poll GET /v1/brand-kits/{brandKitId}/style. The plan sets how many kits a workspace can have.

AuthorizationBearer <token>

Workspace API key (nim_live_...)

In: header

Path Parameters

id*string
Formatuuid

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/497f6eca-6276-4993-bfeb-53cbbbba6f08/save" \  -H "Content-Type: application/json" \  -d '{}'
{  "brandKitId": "0d0050df-b55b-4bc4-9157-db98df0f07d0",  "updated": true,  "changed": [    "fonts",    "guidelines"  ],  "replacedBrandBooks": 1,  "examples": 8,  "learningStarted": true,  "creditsReserved": 40,  "notes": [    "string"  ]}
Empty
Empty
Empty
Empty
Empty