Skip to main content
POST
Create a brand

Authorizations

x-api-key
string
header
required

Rainbrand API key, for example x-api-key: bloom_sk_....

Headers

idempotency-key
string

Optional retry key, 1–255 characters after trimming. Reuse with the same request to recover the original Brand ID. Use a new key for a new creation.

Required string length: 1 - 255

Body

application/json
sources
(Website · object | Instagram · object | File · object | Temporary upload · object)[]
required

Sources to combine into a Brand Skill. At most one website and one Instagram account can be included. Files may be public HTTPS URLs or completed temporary uploads, up to 100 MiB each and 256 MiB combined.

Required array length: 1 - 30 elements
instructions
string

Optional instructions passed to the Brand Agent for this run. The Agent applies them using its existing judgment.

Maximum string length: 4000
workspaceId
string

Team workspace ID. The brand is created in that workspace and billed to its customer. Omit to create in the caller's personal workspace.

Minimum string length: 1
allowDuplicate
boolean

Allow creation when a website or Instagram source matches an existing brand in the selected workspace. Set to true only when the caller intentionally chooses to create another brand. Defaults to false.

Response

OK

data
object
required