Skip to content
Pasqal Documentation

Create Batch

POST
/api/v1/batches

Request Body required

Schema to parse request for the creation of a batch.

object
priority
number
sequence_builder
required
string
sequence
required
emulator

Enumeration of allowed and legacy device type names

string
Allowed values: EMU_FREE EMU_SV EMU_TN EMU_C FRESNEL EMU_FRESNEL EMU_MPS
device_type
required

Enumeration of allowed and legacy device type names

string
Allowed values: EMU_FREE EMU_SV EMU_TN EMU_C FRESNEL EMU_FRESNEL EMU_MPS
configuration
complete
boolean
open
boolean
tags
Array<string>
unique items
jobs
Array<object>
default:

Pydantic schema to parse request for the creation of a job from a batch.

Safety

When we receive this data from an API endpoint, it MUST BE considered untrusted

object
runs
required
integer
variables
object
project_id
required
string format: uuid

Responses

200

Successful Response

Represents a response with either a list of items or a single item in a single page.

Generic Parameters: - A (TypeVar): The type bound to this class, which can be a single BaseModel, a list of BaseModels, or None.

Usage: - To respond with an unpaginated list of FooResponse items from an API endpoint, ensure that your function returns NonPaginatedResponse[List[FooResponse]].

- To respond with a single `FooResponse` item from an API endpoint,
  make sure that your function returns `NonPaginatedResponse[FooResponse]`
  and that Python recognizes it.
object
data

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
string format: uuid
parent_id
string format: uuid
status
required

An enumeration.

string
Allowed values: PENDING RUNNING DONE CANCELED TIMED_OUT ERROR PAUSED
complete
required
boolean
open
required
boolean
priority
required
integer
device_type
required
string
user_id
required
string
project_id
required
string format: uuid
created_at
required
string format: date-time
updated_at
required
string format: date-time
sequence_builder
required
string
jobs_count
required
integer
jobs_count_per_status
required
object
tags
required
Array<string>
configuration
object
webhook
string
start_datetime
string format: date-time
end_datetime
string format: date-time
jobs
Array<object>

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
string format: uuid
parent_id
string format: uuid
status
required

An enumeration.

string
Allowed values: PENDING RUNNING DONE ERROR CANCELED
runs
required
integer
batch_id
required
string format: uuid
project_id
required
string format: uuid
created_at
required
string format: date-time
updated_at
required
string format: date-time
start_timestamp
string format: date-time
end_timestamp
string format: date-time
variables
object
errors
Array<string>
progress
integer
<= 100
sequence
string
creation_order
required
integer
slurm_job_id
string
queue_priority
required

Values represent the queue a value will be written to, each priority represents the order of preference batches will be executed.

HIGH being the quickers MEDIUM being a lower tier LOW being the lowest tier

string
Allowed values: LOW MEDIUM HIGH

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string