Cancel Jobs Batch V1

Cancel up to 50 jobs in one call. Per-row outcomes — already-terminal jobs (succeeded/failed/cancelled) or unknown ids are reported in their own row without…

POST /api/v1/jobs/cancel-batch

cURL

curl --request POST \
  --url 'https://api.computer.stateset.app/api/v1/jobs/cancel-batch' \
  --header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "job_ids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "reason": "Two-person tent, green — replacement for damaged pole set."
}'

200

{
  "cancelled": 1,
  "skipped": 1,
  "results": [
    {
      "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "cancelled": false,
      "error": "string"
    }
  ]
}

Cancel up to 50 jobs in one call.

Per-row outcomes — already-terminal jobs (succeeded/failed/cancelled) or unknown ids are reported in their own row without blocking the others. Single Redis sentinel write per cancellable row.

Request body

CancelBatchRequest

job_ids · string (uuid)[] · required

List of job UUIDs to cancel (1..50). Already-terminal jobs surface as per-row errors without blocking the rest.

reason · string,null

Optional reason applied to every cancelled row. Stamped on job.error like the single-job cancel endpoint.

Response

CancelBatchResponse

cancelled · integer · required

skipped · integer · required

results · CancelBatchItemResult[] · required

Show CancelBatchItemResult

job_id · string · required

cancelled · boolean · required

error · string,null

Status codes

Code	Meaning
200	Successful Response
422	Validation Error

cURL

curl --request POST \
  --url 'https://api.computer.stateset.app/api/v1/jobs/cancel-batch' \
  --header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "job_ids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "reason": "Two-person tent, green — replacement for damaged pole set."
}'

200

{
  "cancelled": 1,
  "skipped": 1,
  "results": [
    {
      "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "cancelled": false,
      "error": "string"
    }
  ]
}