---
title: "Get a classification batch"
method: GET
path: "/classifications/batch/{batchId}"
tags: ["Classification"]
---

# Get a classification batch

`GET /classifications/batch/{batchId}`

## Request

- Base URL: `https://api.tarifflo.com/api/v2`
- URL: `https://api.tarifflo.com/api/v2/classifications/batch/{batchId}`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

The batch's status and one page (1000 rows, `page` from 0) of its results once it completes.

Requires the API key scope `classifications`.

## Path parameters

- `batchId` string, required

## Query parameters

- `page` string

## Response `200`

Successful response

- object
  - `batchId` string, required
  - `credits` object, required: What the job has reserved, used and refunded so far, in credits.
    - `action` 'rate_lookup' | 'adcvd_screen' | 'pga_applicability' | 'code_classified' | 'export_control' | 'origin_determination' | 'entry_filed' | 'entry_prepared' | 'document_ocr' | 'document_extract' | 'document_sort' | 'product_enrich' | 'entry_review' | 'rationale_document' | 'audit_parse' | 'data_export', nullable, required
    - `reserved` number, required
    - `used` number, required
    - `refunded` number, required
  - `status` string, required
  - `state` string, required: SUBMITTED, RUNNING, COMPLETED or FAILED; results appear once COMPLETED.
  - `expectedCount` number, required
  - `shardsSettled` number, required
  - `expectedShards` number, required
  - `page` number, required
  - `pageSize` number, required
  - `results` object[], required
    - `id` string, required
    - `hts10` string, nullable, required
    - `confidence` number, nullable, required
    - `chosenModel` string, nullable, required
    - `top5` union, required
      - string
      - number
      - boolean
      - Schema2[]
      - object

## Other responses

- `400`: Invalid input data
- `401`: Authorization not provided
- `403`: Insufficient access
- `404`: Not found
- `500`: Internal server error

---

[API](https://skmtc.dev/tarifflo/apis/tarifflo-api.md) - [All operations](https://skmtc.dev/tarifflo/apis/tarifflo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tarifflo/apis/tarifflo-api/revisions/f048ebac1ac5?raw)