Get Batch Status

GET

/api/v1/batches/{batch_id}/status

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

Retrieve the id, status and jobs count per status of a batch.

Authorizations

• HTTPBearer

Parameters

Path Parameters

batch_id

required

Batch Id

string format: uuid

Responses

200

Successful Response

Media typeapplication/json

NonPaginatedResponse[ProducedBatchStatusResponse]

object

data

Any of:

ProducedBatchStatusResponse

ProducedBatchStatusResponse

object

id

required

Id

Unique identifier for the batch.

string format: uuid

status

required

BatchStatus

Current batch status.

string

Allowed values: PENDING RUNNING DONE CANCELED CANCELING TIMED_OUT ERROR PAUSED

jobs_count_per_status

required

Jobs Count Per Status

Number of jobs grouped by status.

object

key

additional properties

integer

null

null

Example

{
  "data": {
    "status": "PENDING"
  }
}

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"
    }
  ]
}