Get Batch Endpoint

GET

/v1/batches/{batch_id}

curl --request GET \
  --url 'http://localhost:8080/v1/batches/example?include_jobs=true&jobs_limit=200&include_deleted=false'

• Local docker compose stack (default)

Parameters

Path Parameters

batch_id

required

Batch Id

string

Query Parameters

include_jobs

Include Jobs

boolean

default: true

jobs_limit

Jobs Limit

integer

default: 200 >= 1 <= 500

include_deleted

Include Deleted

boolean

Responses

200

Successful Response

Media type application/json

Response Get Batch Endpoint V1 Batches Batch Id Get

object

key

additional properties

any

Example ^generated

{}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

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