> ## Documentation Index
> Fetch the complete documentation index at: https://docs.novita.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List batch

Displays a list of all available batch jobs.

## Request Headers

**Content-Type** `string` *required*

Enum: `application/json`

**Authorization** `string` *required*

Bearer authentication format, for example: Bearer \{\{API Key}}.

## Response

**data** `object[]` *required*

An array of batch job objects.

**Batch Object Properties**

**id** `string` *required*

A unique identifier for the batch job.

**object** `string` *required*

The object type, which is always `batch`.

**endpoint** `string` *required*

The API endpoint that the batch job is using for processing requests.

**input\_file\_id** `string` *required*

The ID of the input file containing the batch requests.

**output\_file\_id** `string` *required*

The ID of the output file containing the batch results. Empty until the batch is completed.

**error\_file\_id** `string` *required*

The ID of the error file containing any errors that occurred during batch processing. Empty until errors occur.

**completion\_window** `string` *required*

The time window for batch completion. Currently fixed at `48h`.

**in\_progress\_at** `string | null`

The timestamp when the batch started processing. Null if not yet started.

**expires\_at** `string | null`

The timestamp when the batch will expire. Null if not set.

**finalizing\_at** `string | null`

The timestamp when the batch started finalizing. Null if not yet finalizing.

**completed\_at** `string | null`

The timestamp when the batch was completed. Null if not yet completed.

**failed\_at** `string | null`

The timestamp when the batch failed. Null if not failed.

**expired\_at** `string | null`

The timestamp when the batch expired. Null if not expired.

**cancelling\_at** `string | null`

The timestamp when the batch started cancelling. Null if not cancelling.

**cancelled\_at** `string | null`

The timestamp when the batch was cancelled. Null if not cancelled.

**status** `string` *required*

The current status of the batch job.

Available statuses:

* `VALIDATING` - The input file is being validated before the batch can begin
* `PROGRESS` - Batch is in progress
* `COMPLETED` - Batch processing completed successfully
* `FAILED` - Batch processing failed
* `EXPIRED` - Batch exceeded deadline
* `CANCELLING` - Batch is being cancelled
* `CANCELLED` - Batch was cancelled

**errors** `string`

Error messages if any errors occurred during batch processing.

**version** `integer` *required*

The version number of the batch job.

**created\_at** `string` *required*

The timestamp when the batch job was created.

**updated\_at** `string | null`

The timestamp when the batch job was last updated. Null if never updated.

**created\_by** `string` *required*

The unique identifier of the user who created the batch job.

**created\_by\_key\_id** `string` *required*

The API key ID used to create the batch job.

**remark** `string`

Optional remark or note for the batch job.

**total** `integer` *required*

The total number of requests in the batch.

**completed** `integer` *required*

The number of completed requests in the batch.

**failed** `integer` *required*

The number of failed requests in the batch.

**metadata** `object | null`

Additional metadata associated with the batch job. Null if no metadata is provided.

**request\_counts** `object` *required*

Detailed request count information.

**properties**

**total** `integer` *required*

The total number of requests in the batch.

**completed** `integer` *required*

The number of successfully completed requests.

**failed** `integer` *required*

The number of failed requests.

**first\_id** `string` *required*

The ID of the first batch in the list.

**has\_more** `boolean` *required*

Indicates whether there are more batches available beyond this list.

**last\_id** `string` *required*

The ID of the last batch in the list.

**object** `string` *required*

The object type, which is always `list`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.