Request a website theme
POST/theme-generations
Asks the AI theme builder for a website theme. kind: generate (the
default) builds a new theme from brief; kind: revise changes the
latest theme as instruction says. Scope website_themes:write.
The build runs in the background: the answer is 202 with the
generation queued. Poll GET /theme-generations/{id}, or subscribe
a webhook endpoint to theme_generation.* (started, succeeded,
failed). A build does not go live by itself: a successful one
produces a draft version, which goes live only when you call
POST /theme-versions/{version}/publish.
Refusals: 403 theme_builder_not_enabled (the dealer has not turned
on the bespoke themes preview in Administration > Feature previews in
the DMS), 403 plan_not_entitled (a paid plan is needed)
and 429 theme_generation_quota_exceeded (this month's generations
are used up; not a rate limit, so retrying soon will not help).
Request
Responses
- 202
- 401
- 403
- 422
- 429
The theme generation.
Response Headers
This request's id. Quote it to support.
Requests allowed per minute for this key.
Requests left in the current minute.
true when this is the stored response to an earlier request with the same Idempotency-Key.
No key, or one that cannot be used. Codes: missing_api_key,
invalid_api_key, api_key_revoked, api_key_expired,
key_owner_inactive.
Response Headers
This request's id. Quote it to support.
Bearer.
The key may not do this. Codes: insufficient_scope,
scope_not_permitted_for_owner, plan_not_entitled,
secret_key_required, publishable_key_required,
secret_key_in_browser, origin_not_allowed, ip_not_allowed,
branch_move_not_permitted, plan_stock_cap_reached,
sandbox_stock_cap_reached, not_available_in_sandbox,
theme_builder_not_enabled.
Response Headers
This request's id. Quote it to support.
The request was not valid. Code validation_failed, with errors
keyed by field; also body_not_received (a multipart body that
never arrived), webhook_endpoint_limit_reached,
vehicle_not_created, request_refused and
theme_publish_blocked (with errors.routes and errors.findings).
Response Headers
This request's id. Quote it to support.
Too many requests. Code rate_limited; wait Retry-After seconds. On POST /theme-generations, also theme_generation_quota_exceeded, when the dealer's monthly theme generations are used up (no Retry-After).
Response Headers
This request's id. Quote it to support.
Requests allowed per minute for this key.
Requests left in the current minute.
Seconds to wait before retrying.