Create a batch

Before you create jobs, you need to create a batch to put those jobs in.

A batch is a collection of jobs. We recommend using batches to group datasets you use internally, or to group jobs which are part of a weekly submission.

post
A BATCH

https://api.playment.io/v1/projects/:project_id/batch
This endpoint allows you to create a batch
Request
Response
Request
Path Parameters
project_id
required
string
ID of the project in which you want to create the batch
Headers
x-api-key
required
string
API key for authentication
Body Parameters
name
required
string
Name of the batch
description
optional
string
Help others understand what this batch consists of
Response
200: OK
{
"success": True,
"data":{
"batch_id": "c9970ee2-6979-46f1-95db-eee0176294a8"
}
}

The batch_id received in the response can be used to organize the jobs being created via the job creation API.

You can see the newly created batch inside the project in the GT Studio Jarvis dashboard.