---
title: "Retrieve a batch"
method: GET
path: "/v2/batches/{id}"
tags: ["batches"]
---

# Retrieve a batch

`GET /v2/batches/{id}`

## Request

- Base URL: `https://api.cohere.com`
- URL: `https://api.cohere.com/v2/batches/{id}`
- Auth: HTTP bearer

Retrieves a batch

## Path parameters

- `id` string, required

## Headers

- `X-Client-Name` string

## Response `200`

A successful response.

- GetBatchResponse: Response to a request to get a batch.
  - `batch` Batch, required: This resource represents a batch job.
    - `id` string: read-only. Batch ID.
    - `name` string, required: Batch name (e.g. `foobar`).
    - `creator_id` string: read-only. User ID of the creator.
    - `org_id` string: read-only. Organization ID.
    - `status` 'BATCH_STATUS_UNSPECIFIED' | 'BATCH_STATUS_QUEUED' | 'BATCH_STATUS_IN_PROGRESS' | 'BATCH_STATUS_CANCELING' | 'BATCH_STATUS_COMPLETED' | 'BATCH_STATUS_FAILED' | 'BATCH_STATUS_CANCELED': 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.
    - `created_at` string, date-time: read-only. Creation timestamp.
    - `updated_at` string, date-time: read-only. Latest update timestamp.
    - `input_dataset_id` string, required: ID of the dataset the batch reads inputs from.
    - `output_dataset_id` string
    - `input_tokens` string, int64: read-only. The total number of input tokens in the batch.
    - `output_tokens` string, int64: read-only. The total number of output tokens in the batch.
    - `model` string, required: The name of the model the batch uses.
    - `num_records` integer: read-only. The total number of records in the batch.
    - `num_successful_records` integer: read-only. The current number of successful records in the batch.
    - `num_failed_records` integer: read-only. The current number of failed records in the batch.
    - `status_reason` string: read-only. More details about the reason for the status of a batch job.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error
- `503`: Status Service Unavailable

---

[API](https://skmtc.dev/cohere-ai/apis/cohere-api.md) · [All operations](https://skmtc.dev/cohere-ai/apis/cohere-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cohere-ai/apis/cohere-api/revisions/8e538a293bd3?raw)