Skip to main content
POST
Build a full brand image (name, description, style, logos) from a website or an uploaded image.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Build a full brand image from a website or an uploaded image

Request body for building a full brand image (name, description, style, logos) from a website or an uploaded image

companyId
string
required

Company ID

websiteUrl
string

Website URL to build the brand from (defaults to the company website when neither websiteUrl nor imageDataUri is given)

imageDataUri
string

An uploaded image as a data: URI, to build the brand from instead of a website. Provide exactly one of websiteUrl or imageDataUri.

Response

Draft brand image created; poll it for buildStatus

Success response with ID

id
string

Created/updated resource ID

msg
string

Success message