templates

Start a new project from a pinned template

Required permission: projects:write

post/v1/templates/{id}/instantiate

Request

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

projectNamestring required
valuesobject required
mediaobject required
presetstring
brandKitIdstring

Response

A durable preparation job.

jobIdstring required
projectIdstring nullable required
status'preparing' | 'ready' | 'failed' | 'cancelled' required
stage'resolving' | 'downloading' | 'verifying' | 'importing' | 'processing' | 'attaching' | 'applying' | 'preflighting' | 'ready' required
templateRefstring required
documentSha256string nullable required
errorCodestring
errorMessagestring
createdAtstring required
updatedAtstring required

Changes

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