Cancel a job

POST /api/jobs/{jobId}/cancel

Requires renders:create.

curl -X POST "https://app.kalpana.one/api/jobs/$JOB_ID/cancel" \
  --header "x-api-key: $KALPANA_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{ "workspace": "my-workspace" }'

Response

{ "cancelled": 1, "stoppedMessages": 1 }

The response has the same shape as Cancel a batch. A pending or processing job becomes cancelled, which is final and never charged. A render already under way finishes, but its result is ignored. A job that already rendered, failed or was cancelled is not changed, and the response is { "cancelled": 0, "stoppedMessages": 0 }.

Errors