Skip to content

Results are limited to the current section: Cloud services

Product news

Get Ovh Batch

GET
/api/v1/third-party-access/ovh/batches/{batch_id}
batch_id
required
Batch Id
string format: uuid

Successful Response

NonPaginatedResponse[ProducedBatchWithJobIdsAndChildIDsResponse]
object
data
ProducedBatchWithJobIdsAndChildIDsResponse

Response for a batch request that includes only its job ids.

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
Parent Id

ID of the parent batch if created from a retry.

string format: uuid
status
required

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
Sequence Builder

Serialized Pulser sequence shared by all jobs.

string
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
tags
required
Tags

User-defined labels for organizing batches.

Array<string>
unique items
configuration
required
Configuration

Deprecated. Use backend_configuration. Extra configuration for job execution.

object
backend_configuration
required
Backend Configuration

Serialized emulator backend configuration.

string
webhook
required
Webhook

URL where job results are sent via webhook.

string
start_datetime
required
Start Datetime

Timestamp when processing started on hardware.

string format: date-time
end_datetime
required
End Datetime

Timestamp when processing finished, errored, or was canceled.

string format: date-time
job_ids
required
Job Ids

IDs of all jobs in the batch.

Array<string>
child_ids
required
Child Ids

IDs of child batches created from retries.

Array<string>
queue_priority
required

Priority queue on which the batch is scheduled.

string
Allowed values: CRITICAL HIGH MEDIUM LOW FREE
Example
{
"id": "00000000-0000-0000-0000-000000000002",
"status": "DONE",
"complete": true,
"open": false,
"priority": 0,
"device_type": "FRESNEL",
"user_id": "user-123",
"project_id": "00000000-0000-0000-0000-000000000001",
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:35:00Z",
"sequence_builder": "<serialized Pulser sequence>",
"jobs_count": 2,
"jobs_count_per_status": {
"DONE": 2
},
"tags": [
"experiment-1"
],
"start_datetime": "2025-01-15T10:31:00Z",
"end_datetime": "2025-01-15T10:35:00Z",
"job_ids": [
"00000000-0000-0000-0000-000000000003",
"00000000-0000-0000-0000-000000000004"
],
"child_ids": [],
"queue_priority": "MEDIUM"
}

Validation Error

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