projects

Update a project

Required permission: projects:write

patch/v1/projects/{id}

Request

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

namestring
descriptionstring
brandKitIdstring

Response

Project updated.

idstring required
namestring required
descriptionstring nullable required
brandKitIdstring nullable required
activeCompositionIdstring nullable required
webUrlstring nullable required

A browser URL that opens THIS project, or null when CueFrame exposes no web view for a project. Null today: the console serves account surfaces (keys, usage, billing) and has no per-project page, so there is no link to give. Do NOT synthesise one — a guessed console path 404s. Show the user rendered output (create_render → outputUrl) or a preview still instead. This field becoming non-null is the signal that a real project view exists.

createdAtstring required

Changes

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