Generate theme

A palette from a sentence, or from the customer's own website.

posthttps://api.integrable.cloud/api/agents/{agent_id}/theme/generate

Authentication: Bearer token
Retries: Idempotency-Key
Body: application/json
Version: 2026-09-03

Returns the theme without saving it unless apply is set. A colour scheme is the most visible thing about a widget and the cheapest to disagree with, so the default is to propose rather than to change - the tenant sees it in the preview and decides.

The palette is contrast-corrected before it is returned, not validated and rejected. Failing this request because a model chose a slightly too-light grey would leave the customer with an error about a hex code they never picked; correcting it and telling them what changed is the useful version of the same rule. See theme_service.readable_theme.

Path parameters#

agent_idstringrequired

Headers#

Idempotency-Keystring
A unique key of your choosing, so this request can be retried safely. The first request with a given key executes; every replay returns that first response unchanged, with Idempotent-Replay: true set.
Generate one key per action, not per session - reusing a key with a different body is refused with 422 rather than silently replaying the wrong answer. Keys are remembered for 24 hours. A request that failed releases its key, so a retry after fixing the payload runs normally.
Up to 255 characters

Request body#

application/json · required

ThemeGenerateRequest

applyboolean
Default: false
promptstring | null
Up to 2000 characters
website_urlstring | null

Responses#

200OKapplication/json
object
5 response headers
RateLimit-Limit
Requests permitted in the current window.
RateLimit-Remaining
Requests left in the current window. Back off before it reaches 0.
RateLimit-Reset
Seconds until the current window resets.
X-API-Version
The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.
X-Request-ID
Quote this in a support request to identify the call.
422Validation error
The shared error envelope, served as application/problem+json with error.code set to validation_error. Its details name each field that failed and why.

Request · curl

curl -X POST "https://api.integrable.cloud/api/agents/$AGENT_ID/theme/generate" \
  -H "Authorization: Bearer $INTEGRABLE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "apply": false
  }'

Set INTEGRABLE_API_KEY and the path variables first. The TypeScript and Python SDKs take the same fields.

Errors#

Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:

validation_error · 422 — The payload was well-formed JSON but failed schema validation.
unauthenticated · 401 — The request carried no API key, or one the API could not verify.
forbidden · 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.
idempotency_key_reused · 422 — This `Idempotency-Key` was used before, for a request with a different body.
rate_limited · 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-agent limit on top.

More Agents endpoints#

Something unclear or missing? Tell us and we’ll fix it.