Skip to main content

Create a batch

POST/v2/batchesCreate a batch

Creates and executes a batch from an uploaded dataset of requests

Parameters

X-Client-Namestringheader

The name of the project that is making the request.

Request body

required

Information about the batch. Must contain name, input_dataset_id, and model. Output-only fields are ignored.

application/json

objectBatch

This resource represents a batch job.

created_atstring · date-time

read-only. Creation timestamp.

creator_idstring

read-only. User ID of the creator.

idstring

read-only. Batch ID.

input_dataset_idstringrequired

ID of the dataset the batch reads inputs from.

input_tokensstring · int64

read-only. The total number of input tokens in the batch.

modelstringrequired

The name of the model the batch uses.

namestringrequired

Batch name (e.g. `foobar`).

num_failed_recordsinteger · int32

read-only. The current number of failed records in the batch.

num_recordsinteger · int32

read-only. The total number of records in the batch.

num_successful_recordsinteger · int32

read-only. The current number of successful records in the batch.

org_idstring

read-only. Organization ID.

output_dataset_idstring

output_tokensstring · int64

read-only. The total number of output tokens in the batch.

statusstring

The possible stages of a batch life-cycle. - BATCH_STATUS_UNSPECIFIED: Unspecified status. - BATCH_STATUS_QUEUED: The batch has been queued. - BATCH_STATUS_IN_PROGRESS: The batch is in-progress. - BATCH_STATUS_CANCELING: The batch is being canceled. - BATCH_STATUS_COMPLETED: The batch has been completed. - BATCH_STATUS_FAILED: The batch has failed. - BATCH_STATUS_CANCELED: The batch has been canceled.

one of "BATCH_STATUS_UNSPECIFIED", "BATCH_STATUS_QUEUED", "BATCH_STATUS_IN_PROGRESS", "BATCH_STATUS_CANCELING", "BATCH_STATUS_COMPLETED", "BATCH_STATUS_FAILED", "BATCH_STATUS_CANCELED" · default "BATCH_STATUS_UNSPECIFIED"

status_reasonstring

read-only. More details about the reason for the status of a batch job.

updated_atstring · date-time

read-only. Latest update timestamp.

Example request

{
  "input_dataset_id": "string",
  "model": "string",
  "name": "string"
}

Responses

objectCreateBatchResponse

Response to request to create a batch.

batchobjectrequired

This resource represents a batch job.

Show child attributes

created_atstring · date-time

read-only. Creation timestamp.

creator_idstring

read-only. User ID of the creator.

idstring

read-only. Batch ID.

input_dataset_idstringrequired

ID of the dataset the batch reads inputs from.

input_tokensstring · int64

read-only. The total number of input tokens in the batch.

modelstringrequired

The name of the model the batch uses.

namestringrequired

Batch name (e.g. `foobar`).

num_failed_recordsinteger · int32

read-only. The current number of failed records in the batch.

num_recordsinteger · int32

read-only. The total number of records in the batch.

num_successful_recordsinteger · int32

read-only. The current number of successful records in the batch.

org_idstring

read-only. Organization ID.

output_dataset_idstring

output_tokensstring · int64

read-only. The total number of output tokens in the batch.

statusstring

The possible stages of a batch life-cycle. - BATCH_STATUS_UNSPECIFIED: Unspecified status. - BATCH_STATUS_QUEUED: The batch has been queued. - BATCH_STATUS_IN_PROGRESS: The batch is in-progress. - BATCH_STATUS_CANCELING: The batch is being canceled. - BATCH_STATUS_COMPLETED: The batch has been completed. - BATCH_STATUS_FAILED: The batch has failed. - BATCH_STATUS_CANCELED: The batch has been canceled.

one of "BATCH_STATUS_UNSPECIFIED", "BATCH_STATUS_QUEUED", "BATCH_STATUS_IN_PROGRESS", "BATCH_STATUS_CANCELING", "BATCH_STATUS_COMPLETED", "BATCH_STATUS_FAILED", "BATCH_STATUS_CANCELED" · default "BATCH_STATUS_UNSPECIFIED"

status_reasonstring

read-only. More details about the reason for the status of a batch job.

updated_atstring · date-time

read-only. Latest update timestamp.

Example response

{
  "batch": {
    "created_at": "2026-06-09T00:00:00Z",
    "creator_id": "string",
    "id": "string",
    "input_dataset_id": "string",
    "input_tokens": "string",
    "model": "string",
    "name": "string",
    "num_failed_records": 0,
    "num_records": 0,
    "num_successful_records": 0,
    "org_id": "string",
    "output_dataset_id": "string",
    "output_tokens": "string",
    "status": "BATCH_STATUS_UNSPECIFIED",
    "status_reason": "string",
    "updated_at": "2026-06-09T00:00:00Z"
  }
}

objectBatchError

Error is the response for any unsuccessful event.

messagestring

A developer-facing error message.

Example response

{
  "message": "string"
}

objectBatchError

Error is the response for any unsuccessful event.

messagestring

A developer-facing error message.

Example response

{
  "message": "string"
}

objectBatchError

Error is the response for any unsuccessful event.

messagestring

A developer-facing error message.

Example response

{
  "message": "string"
}

objectBatchError

Error is the response for any unsuccessful event.

messagestring

A developer-facing error message.

Example response

{
  "message": "string"
}

objectBatchError

Error is the response for any unsuccessful event.

messagestring

A developer-facing error message.

Example response

{
  "message": "string"
}

objectBatchError

Error is the response for any unsuccessful event.

messagestring

A developer-facing error message.

Example response

{
  "message": "string"
}

Examples

X-Client-Nameheader parameter

curl -X POST 'https://api.cohere.com/v2/batches' \
  -H 'Content-Type: application/json' \
  -d '{"input_dataset_id":"string","model":"string","name":"string"}'

const response = await fetch('https://api.cohere.com/v2/batches', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"input_dataset_id":"string","model":"string","name":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.cohere.com/v2/batches', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"input_dataset_id\":\"string\",\"model\":\"string\",\"name\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.cohere.com/v2/batches",
    headers={"Content-Type": "application/json"},
    data='{"input_dataset_id":"string","model":"string","name":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"input_dataset_id":"string","model":"string","name":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.cohere.com/v2/batches", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.cohere.com/v2/batches");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"input_dataset_id\":\"string\",\"model\":\"string\",\"name\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.cohere.com/v2/batches"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"input_dataset_id\":\"string\",\"model\":\"string\",\"name\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.cohere.com/v2/batches")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"input_dataset_id\":\"string\",\"model\":\"string\",\"name\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.cohere.com/v2/batches");
request.Content = new StringContent("{\"input_dataset_id\":\"string\",\"model\":\"string\",\"name\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "batch": {
    "created_at": "2026-06-09T00:00:00Z",
    "creator_id": "string",
    "id": "string",
    "input_dataset_id": "string",
    "input_tokens": "string",
    "model": "string",
    "name": "string",
    "num_failed_records": 0,
    "num_records": 0,
    "num_successful_records": 0,
    "org_id": "string",
    "output_dataset_id": "string",
    "output_tokens": "string",
    "status": "BATCH_STATUS_UNSPECIFIED",
    "status_reason": "string",
    "updated_at": "2026-06-09T00:00:00Z"
  }
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}