Skip to content

Results are limited to the current section: Cloud services

Product news

Cancel Job

PATCH
/api/v2/jobs/{job_id}/cancel

Cancel a specific job. Only the job owner can perform this operation.

The job must be in a cancelable state (PENDING or RUNNING). If the job is already running on hardware, cancellation may not take effect immediately.

Returns: The canceled job with its updated status.

job_id
required
Job Id
string format: uuid

Successful Response

NonPaginatedResponse[ProducedPartialJobResponse]
object
data
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
Parent Id

ID of the original job if created from a retry (rebatch).

string format: uuid
status
required

Current job status.

string
Allowed values: PENDING RUNNING DONE ERROR CANCELED CANCELING
runs
required
Runs

Number of times the pulse sequence is repeated.

integer
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
Start Timestamp

Timestamp when the QPU or emulator started processing.

string format: date-time
end_timestamp
required
End Timestamp

Timestamp when the QPU or emulator finished, errored, or canceled the job.

string format: date-time
variables
required
Variables

Variable assignments used to build the pulse sequence.

object
errors
required
Errors

Errors returned during job execution.

Array<string>
progress
required
Progress

Job progress percentage (0-100).

integer
<= 100
sequence
required
Sequence

The built pulse sequence for the job.

string
creation_order
required
Creation Order

Position in the creation order within the batch.

integer
Example
{
"id": "00000000-0000-0000-0000-000000000003",
"status": "DONE",
"runs": 100,
"batch_id": "00000000-0000-0000-0000-000000000002",
"project_id": "00000000-0000-0000-0000-000000000001",
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:35:00Z",
"start_timestamp": "2025-01-15T10:31:00Z",
"end_timestamp": "2025-01-15T10:35:00Z",
"variables": {
"omega": 5
},
"progress": 100,
"creation_order": 1
}

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string