templates

Cancel a template render

Before the render job exists the workflow is cancelled and the row closed; after, the render job's own cancel runs and the row mirrors it.

post/v1/templates/{id}/renders/{renderId}/cancel

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/templates/{id}/renders/{renderId}/cancel
  • 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: renders:write)
    • API key in header PAYMENT-SIGNATURE

Path parameters

idstring required
renderIdstring required

Response

The render, cancelled.

idstring required
status'preparing' | 'rendering' | 'complete' | 'failed' | 'cancelled' | 'revoked' required
templateIdstring required
versioninteger required
presetstring
brandKitIdstring
shareUrlstring nullable required
posterUrlstring nullable required
renderIdstring nullable required
errorCodestring
errorMessagestring
expiresAtstring
createdAtstring required
updatedAtstring required

Changes

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