compose

Cancel an in-flight compose job

Cancel a running compose so an agent (or a cost guard) can abort a mis-priced or runaway ensemble without waiting out its budget or TTL. Cancellation is confirmed before the job becomes terminal; the compose.cancelled event is then emitted and any linked charge is released. Already-terminal jobs are rejected (422 compose_not_cancellable).

post/v1/projects/{id}/compose/jobs/{composeJobId}/cancel

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/projects/{id}/compose/jobs/{composeJobId}/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: projects:write)
    • API key in header PAYMENT-SIGNATURE

Path parameters

idstring required
composeJobIdstring required

Response

Cancelled.

composeJobIdstring required
projectIdstring required
status'queued' | 'running' | 'awaiting_input' | 'complete' | 'failed' | 'cancelled' required
reconciliationRequiredboolean
errorstring nullable required
listUsdnumber
startedAtnumber required
completedAtnumber nullable required

Changes

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