Cancel Batch

PATCH

/api/v2/batches/{batch__id}/cancel

curl --request PATCH \
  --url https://example.com/api/v2/batches/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel \
  --header 'Authorization: Bearer <token>'

Cancel an entire batch and all its pending jobs. Only the batch owner can perform this operation.

Jobs that are already running may complete before the cancellation takes effect. The batch status will transition to CANCELED. This operation is irreversible.

Returns: The canceled batch with its updated status and partial job data.

Authorizations

• HTTPBearer

Parameters

Path Parameters

batch__id

required

Batch Id

string format: uuid

Responses

200

Successful Response

Media typeapplication/json

NonPaginatedResponse[ProducedBatchWithPartialJobsResponse]

object

data

Any of:

ProducedBatchWithPartialJobsResponse

ProducedBatchWithPartialJobsResponse

Response for a batch request which includes its jobs data but without the results.

This schema defines all the fields that can be publicly shared by the API.

object

id

required

Id

Unique identifier for the batch.

string format: uuid

parent_id

required

Any of:

string

string format: uuid

null

null

status

required

BatchStatus

Current batch status.

string

Allowed values: PENDING RUNNING DONE CANCELED CANCELING TIMED_OUT ERROR PAUSED

complete

required

Complete

Deprecated. Use open instead. Indicates whether the batch is still accepting additional jobs. False means the batch is open; True means it is closed.

boolean

open

required

Open

Whether the batch is open and accepting additional jobs.

boolean

priority

required

Priority

Deprecated. Priority of the batch.

integer

device_type

required

Device Type

Target device type for the batch.

string

user_id

required

User Id

ID of the user who created the batch.

string

project_id

required

Project Id

ID of the project this batch belongs to.

string format: uuid

created_at

required

Created At

Timestamp when the batch was created.

string format: date-time

updated_at

required

Updated At

Timestamp of the last batch update.

string format: date-time

sequence_builder

required

Any of:

string

string

null

null

jobs_count

required

Jobs Count

Total number of jobs in the batch.

integer

jobs_count_per_status

required

Jobs Count Per Status

Number of jobs grouped by status.

object

key

additional properties

any

tags

required

Tags

User-defined labels for organizing batches.

Array<string>

unique items

configuration

required

Any of:

object

object

key

additional properties

any

null

null

backend_configuration

required

Any of:

string

string

null

null

webhook

required

Any of:

string

string

null

null

start_datetime

required

Any of:

string

string format: date-time

null

null

end_datetime

required

Any of:

string

string format: date-time

null

null

jobs

required

Any of:

Array<object>

Array<object>

ProducedPartialJobResponse

Response to a request for a job.

This schema defines all the fields that can be publicly shared by the API and do not require significant computational resources. For example, 'logs_links' or 'results link'.

object

id

required

Id

Unique identifier for the job.

string format: uuid

parent_id

required

Any of:

string

string format: uuid

null

null

status

required

JobStatus

Current job status.

string

Allowed values: PENDING RUNNING DONE ERROR CANCELED CANCELING

runs

required

Any of:

integer

integer

null

null

batch_id

required

Batch Id

ID of the batch this job belongs to.

string format: uuid

project_id

required

Project Id

ID of the project this job belongs to.

string format: uuid

created_at

required

Created At

Timestamp when the job was created.

string format: date-time

updated_at

required

Updated At

Timestamp of the last job update.

string format: date-time

start_timestamp

required

Any of:

string

string format: date-time

null

null

end_timestamp

required

Any of:

string

string format: date-time

null

null

variables

required

Any of:

object

object

key

additional properties

any

null

null

errors

required

Any of:

Array<string>

Array<string>

null

null

progress

required

Any of:

integer

integer

<= 100

null

null

sequence

required

Any of:

string

string

null

null

creation_order

required

Creation Order

Position in the creation order within the batch.

integer

null

null

queue_priority

required

QueuePriority

Priority queue on which the batch is scheduled.

string

Allowed values: CRITICAL HIGH MEDIUM LOW FREE

null

null

Example

{
  "data": {
    "complete": false,
    "created_at": "2025-01-15T10:30:00Z",
    "device_type": "FRESNEL",
    "id": "00000000-0000-0000-0000-000000000002",
    "jobs": [
      {
        "batch_id": "00000000-0000-0000-0000-000000000002",
        "created_at": "2025-01-15T10:30:00Z",
        "creation_order": 0,
        "id": "00000000-0000-0000-0000-000000000003",
        "progress": 0,
        "project_id": "00000000-0000-0000-0000-000000000001",
        "runs": 100,
        "status": "PENDING",
        "updated_at": "2025-01-15T10:30:00Z",
        "variables": {
          "omega": 5
        }
      }
    ],
    "jobs_count": 1,
    "jobs_count_per_status": {
      "PENDING": 1
    },
    "open": true,
    "priority": 0,
    "project_id": "00000000-0000-0000-0000-000000000001",
    "queue_priority": "MEDIUM",
    "sequence_builder": "<serialized Pulser sequence>",
    "status": "PENDING",
    "tags": [],
    "updated_at": "2025-01-15T10:30:00Z",
    "user_id": "user-123"
  }
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}