Skip to main content
PUT
cURL

Documentation by X-Pilot

Required scope: brand_kits:write. Manage API keys · Authentication and recovery
An application sends a scoped API key to the X-Pilot REST API and receives an HTTP status and JSON response.
REST requests use a scoped API key. Keys, credits and usage are managed in the App console.

Authorizations

Authorization
string
header
required

Scoped X-Pilot API key

Path Parameters

brand_kit_id
string
required

An owned brand kit ID.

Body

application/json
brand_name
string

Brand name, 1–120 characters.

Maximum string length: 120
Example:

"Acme"

http(s) logo URL, preferably returned by POST /v1/assets.

Maximum string length: 2048
content_style_description
string

Tone and style guidance for scripts, up to 20,000 characters.

Maximum string length: 20000
theme_color
object

Theme colors. Keys: primary, secondary, accent, background, text, textSecondary, success, warning, error, surface, surfaceLight, shadow. Values: #rgb, #rrggbb, #rrggbbaa or rgb()/rgba(); null clears a color.

Example:

Response

Success