jobs

Cancel an async job

Cancel a running async job so an agent can abort a mis-priced/runaway operation without waiting out its TTL. Cancellation is durable and never meters. Already-terminal jobs are rejected (422 job_not_cancellable).

post/v1/jobs/{jobId}/cancel

Request

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

jobIdstring required

Response

Cancelled.

idstring required

Job id — pass to GET /v1/jobs/{id} / wait_job.

jobKeystring required

Deterministic identity of the work (idempotency key, e.g. verify-<sessionId>-<contentHash> — the hash covers the composition AND grading inputs). Re-enqueueing the same key returns the same job while it runs.

kindstring required

Job family, e.g. verify.

status'running' | 'succeeded' | 'failed' | 'cancelled' required

Poll until terminal (succeeded | failed | cancelled).

createdAtstring required
updatedAtstring required
completedAtstring nullable required

Changes

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