Skip to main content
For high-volume projects, batches can optionally be used to further divide work inside a project. When organizing tasks into batches you can consider one of the following approaches:
  • Specific datasets: You can organize batches according to the source datasets you use. This approach enables precise control over the number of tasks processed from each dataset.
  • Model versions: You can organize batches according to the model versions you use internally. This approach enables precise control over the number of tasks processed from each model version (or pairs in case of an eval prokect)
  • Language: You can organize batches according to the language of the tasks.
  • Time: If your data structure will be the same throughout the lifespan of the project, you can organize batches according to the time they were created.
​
id
string
required

A unique identifier for the batch.

Example:

"batch_abc123"

​
name
string
required

The name of the batch.

Example:

"My Scale Batch"

​
project
required

Project ID or Project associated with the batch.

Example:

"project_abc123"

​
created_at
string<date-time>
required

A timestamp formatted as an ISO 8601 date-time string.

​
status
enum<string>
required

Status of the batch.

Available options:
staging,
in_progress,
completed,
paused,
cancelled
​
metadata
object
required

Custom metadata for the entity.

​
completed_at
string<date-time>

UTC timestamp when the batch was completed.

​
callback
string

Callback URL or email for the entity upon completion.

Example:

"https://example.com/callback"