Create a batch

Creates and executes a batch from an uploaded dataset of requests

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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

namestringRequired

Batch name (e.g. foobar).

input_dataset_idstringRequired

ID of the dataset the batch reads inputs from.

modelstringRequired

The name of the model the batch uses.

A successful response.

batchobject

Information about the batch.

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error

1	import cohere
2
3	co = cohere.ClientV2()
4
5	batch_job = co.batches.create(
6	name="<batch_job_name>",
7	input_dataset_id="<input_dataset_id>",
8	model="<model_name>",
9	)

1	{
2	"batch": {
3	"name": "string",
4	"input_dataset_id": "string",
5	"model": "string",
6	"id": "string",
7	"creator_id": "string",
8	"org_id": "string",
9	"status": "BATCH_STATUS_UNSPECIFIED",
10	"created_at": "2024-01-15T09:30:00Z",
11	"updated_at": "2024-01-15T09:30:00Z",
12	"output_dataset_id": "string",
13	"input_tokens": "string",
14	"output_tokens": "string",
15	"num_records": 1,
16	"num_successful_records": 1,
17	"num_failed_records": 1,
18	"status_reason": "string"
19	}
20	}

1	import cohere
2
3	co = cohere.ClientV2()
4
5	batch_job = co.batches.create(
6	name="<batch_job_name>",
7	input_dataset_id="<input_dataset_id>",
8	model="<model_name>",
9	)

1	{
2	"batch": {
3	"name": "string",
4	"input_dataset_id": "string",
5	"model": "string",
6	"id": "string",
7	"creator_id": "string",
8	"org_id": "string",
9	"status": "BATCH_STATUS_UNSPECIFIED",
10	"created_at": "2024-01-15T09:30:00Z",
11	"updated_at": "2024-01-15T09:30:00Z",
12	"output_dataset_id": "string",
13	"input_tokens": "string",
14	"output_tokens": "string",
15	"num_records": 1,
16	"num_successful_records": 1,
17	"num_failed_records": 1,
18	"status_reason": "string"
19	}
20	}