> For the complete documentation index, see [llms.txt](https://annotationdocs.telusinternational.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://annotationdocs.telusinternational.com/basic-operations/create-a-batch.md).

# 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

<mark style="color:green;">`POST`</mark> `https://api.playment.io/v1/projects/:project_id/batch`

This endpoint allows you to create a batch

#### Path Parameters

| Name        | Type   | Description                                             |
| ----------- | ------ | ------------------------------------------------------- |
| project\_id | string | ID of the project in which you want to create the batch |

#### Headers

| Name      | Type   | Description                |
| --------- | ------ | -------------------------- |
| x-api-key | string | API key for authentication |

#### Request Body

| Name        | Type   | Description                                        |
| ----------- | ------ | -------------------------------------------------- |
| name        | string | Name of the batch                                  |
| description | string | Help others understand what this batch consists of |

{% tabs %}
{% tab title="200 " %}

```javascript
{
    "success": True,
    "data":{
        "batch_id": "c9970ee2-6979-46f1-95db-eee0176294a8"
    }
}
```

{% endtab %}
{% endtabs %}

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.

![](/files/-MV007Nx5C3ahVeN6EBN)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://annotationdocs.telusinternational.com/basic-operations/create-a-batch.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.