---
title: "Get Agent Batch"
method: GET
path: "/api/v1/agent/batch/{batch_id}"
---

# Get Agent Batch

`GET /api/v1/agent/batch/{batch_id}`

## Request

- Base URL: `https://api.mesharc.dev` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mesharc.dev/api/v1/agent/batch/{batch_id}`
- Auth: none declared

A batch and one page of its rows, in table order -- each with its
status, answer, sources and credits as its run has them. `status` keeps
one status (done, error, invalid, …). 410 past its keep date.

## Path parameters

- `batch_id` string, required

## Query parameters

- `offset` integer
- `limit` integer
- `status` string, nullable

## Headers

- `authorization` string, nullable
- `x-mesharc-tenant` string, nullable

## Response `200`

Successful Response

- AgentBatch
  - `id` string, required
  - `kind` string, required
  - `name` string, required
  - `status` string, required
  - `columns` string[], required
  - `outputColumns` string[], required
  - `prompt` string, required
  - `urls` string[], required
  - `schema` object, nullable
  - `maxCreditsPerRow` integer, required
  - `maxSteps` integer, required
  - `domainLimit` string, required
  - `allowedDomains` string[], required
  - `concurrency` integer, required
  - `rows` integer, required
  - `counts` AgentBatchCounts, required
    - `pending` integer
    - `running` integer
    - `done` integer
    - `credit_limit` integer
    - `error` integer
    - `cancelled` integer
    - `invalid` integer
    - `skipped` integer
  - `budget` integer, required
  - `creditsUsed` integer, required
  - `averagePerRow` integer, nullable
  - `model` string, required
  - `next` string, nullable
  - `createdAt` string, nullable
  - `finishedAt` string, nullable
  - `expiresAt` string, nullable
  - `data` AgentBatchRow[], nullable
    - `row` integer, required
    - `values` object, required
    - `status` string, required
    - `data` union
      - object
      - unknown[]
        - unknown
    - `fieldSources` object
    - `sources` string[]
    - `creditsUsed` integer, required
    - `budget` integer, required
    - `error` string
    - `runId` string, nullable
    - `startedAt` string, nullable
    - `finishedAt` string, nullable
  - `more` string, nullable
  - `webhookSecret` string, nullable
  - `request_id` string

## Other responses

- `422`: Validation Error

---

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