Batches

List defined batches

Lists the batches defined in AIVA.

get/v2/batches

Request

  • Base URL: https://app.aiva.works (the document declares no server; this is the origin it was published from)
  • URL: https://app.aiva.works/v2/batches
  • Auth: API key in header X-API-KEY

Query parameters

namestring

Part of the batch name, case-insensitive.

isEnabledboolean

Only enabled (true) or only disabled (false) batches.

scheduleType'Manual' | 'Recurring'

How the batch is scheduled.

pageinteger

Page number.

pageSizeinteger

Rows per page, at most 1000.

Response

Array of defined batches

idstring guid required
namestring required
labelsstring[]
scheduleType'Manual' | 'Recurring'
isEnabledboolean
createdAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.