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.

A BATCH

POST https://api.playment.io/v1/projects/:project_id/batch

This endpoint allows you to create a batch

Path Parameters

NameTypeDescription

project_id

string

ID of the project in which you want to create the batch

Headers

NameTypeDescription

x-api-key

string

API key for authentication

Request Body

NameTypeDescription

name

string

Name of the batch

description

string

Help others understand what this batch consists of

{
    "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.

Last updated