evidence

Render one component preview

Queue a preview of ONE org-installed native (version 4) component: a PNG of its middle frame, rendered by the same HyperFrames runtime as the production render. Returns a jobId — wait_job(kind='preview') for the image. Compile/runtime failures land on the job terminal with the sanitized author-fixable message.

post/v1/projects/{id}/component-preview

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/projects/{id}/component-preview
  • 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

Path parameters

idstring required

Request body

componentIdstring required
paramsobject
assetsobject

Component asset-slot name to org mediaId. Every required manifest slot must be bound.

widthinteger

Exact width of a supported composition format. Width and height must match one aspect ratio/resolution pair; omitted values use the project format.

heightinteger

Exact height paired with width for a supported composition format.

durationInFramesinteger

Preview frame count. When omitted, uses the component's declared duration; required if the component has none.

Example request

{
  "componentId": "cmp_lower_third",
  "params": {
    "title": "Q3 revenue",
    "subtitle": "up 40%"
  }
}

Response

Preview 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.