brand-kits

Extract brand tokens from a website URL

Queue brand-token extraction from a website URL — ASYNC: returns a 202 job receipt; poll GET /v1/jobs/{jobId} (or MCP wait_job kind=brand_kit_extract) for the tokens (colors, fonts, title, description) on the succeeded result. The service inspects the site under a 20-second limit and does NOT persist a kit (pass the result to POST /brand-kits). A blocked (private-network), non-2xx, non-HTML, or slow URL degrades to EMPTY token arrays on a SUCCEEDED terminal rather than erroring; succeeded extractions are reused for 5 minutes per URL.

post/v1/brand-kits/extract

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/brand-kits/extract
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.cueframe.ai/api/auth/mcp/authorize, token URL https://api.cueframe.ai/api/auth/mcp/token, scopes: projects:write)
    • API key in header PAYMENT-SIGNATURE

Request body

urlstring uri required

Response

Extraction job queued.

jobIdstring required

Poll GET /v1/jobs/{jobId} / wait_job until terminal.

jobKeystring required

Deterministic identity of the work (content hash of every input the result depends on). Re-enqueueing the same key returns the same job while it runs; a failed key revives as a fresh attempt.

kindstring required

Job family, e.g. verify | preview | brand_kit_extract.

status'running' | 'succeeded' | 'cancelled' required

running on a fresh/deduped enqueue; succeeded when an identical request already completed. Cancelled is part of the shared status vocabulary; identical cancelled work revives to running.

Changes

No recorded changes to this operation across all 1 revision of this API.