Retrieve a batch

Retrieves a batch

AuthorizationBearer

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

idstringRequired

The batch ID.

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	{
2	"batch": {
3	"name": "my-batch",
4	"input_dataset_id": "my-requests-dataset",
5	"model": "batch-command",
6	"id": "9439e0e3-49a4-4336-93e3-485fc420bc18",
7	"creator_id": "b5e1ffb9-49a1-4653-9927-94083316309d",
8	"org_id": "62603116-1750-4c04-b1b6-9d5046764bc4",
9	"status": "BATCH_STATUS_IN_PROGRESS",
10	"created_at": "2024-01-15T09:30:00Z",
11	"updated_at": "2024-01-15T09:30:00Z",
12	"output_dataset_id": "my-batch-output-c2waz1",
13	"input_tokens": "0",
14	"output_tokens": "0",
15	"num_records": 5000,
16	"num_successful_records": 8,
17	"num_failed_records": 0
18	}
19	}

1	{
2	"batch": {
3	"name": "my-batch",
4	"input_dataset_id": "my-requests-dataset",
5	"model": "batch-command",
6	"id": "9439e0e3-49a4-4336-93e3-485fc420bc18",
7	"creator_id": "b5e1ffb9-49a1-4653-9927-94083316309d",
8	"org_id": "62603116-1750-4c04-b1b6-9d5046764bc4",
9	"status": "BATCH_STATUS_IN_PROGRESS",
10	"created_at": "2024-01-15T09:30:00Z",
11	"updated_at": "2024-01-15T09:30:00Z",
12	"output_dataset_id": "my-batch-output-c2waz1",
13	"input_tokens": "0",
14	"output_tokens": "0",
15	"num_records": 5000,
16	"num_successful_records": 8,
17	"num_failed_records": 0
18	}
19	}

1	import cohere
2
3	co = cohere.ClientV2()
4
5	batch_job = co.batches.retrieve("<batch_job_id>")