---
title: "Poll a batch job"
method: GET
path: "/v1/batches/{id}"
---

# Poll a batch job

`GET /v1/batches/{id}`

## Request

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

## Path parameters

- `id` string, uuid, required

## Response `200`

OK

- Batch
  - `id` string, uuid, required
  - `status` 'queued' | 'running' | 'done' | 'failed', required
  - `endpoint` string, required
  - `created_at` string, date-time, required
  - `completed_at` string, date-time, nullable
  - `credits_used` number
  - `poll_url` string, required
  - `webhook_url` string, nullable
  - `webhook_status` 'pending' | 'delivered' | 'failed' | 'null', nullable
  - `error` object, nullable
    - `code` string
    - `message` string
  - `result` object, nullable: Present when done; kept 24h. The endpoint's response body, or {markdown, meta} for format=markdown jobs

## Other responses

- `401`: Error
- `404`: Error
- `429`: Error

---

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