Cancel a batch

POST /api/batches/{batchId}/cancel

Requires renders:create.

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

Response

{ "cancelled": 12, "stoppedMessages": 3 }

Every pending or processing row becomes cancelled at once. That status is final and never charged. cancelled counts those rows. stoppedMessages counts the queued messages deleted before delivery; one message can carry several rows. A render already under way finishes, but its result is ignored. Rows that already rendered, failed or were cancelled are not changed, so a batch with nothing unfinished returns 0 for both.

When at least one row is cancelled, the batch run has finished and the batch.completed event carries the cancelled count.

Errors