---
title: "Batch task progress"
method: GET
path: "/batch-tasks/{id}"
---

# Batch task progress

`GET /batch-tasks/{id}`

## Request

- Base URL: `https://rendry.io/api/v1`
- URL: `https://rendry.io/api/v1/batch-tasks/{id}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer
  - HTTP bearer

## Path parameters

- `id` string, required

## Headers

- `X-Rendry-Account` string

## Response `200`

Status, per-row results and counts

- BatchTaskStatus: Progress of a batch task: counts, every row with its own outcome, and the archive once the run is over.
  - `task_id` string, required
  - `preset_id` string
  - `created_at` string
  - `mapping` object: column -> variable used for this run
  - `status` 'running' | 'done' | 'partial' | 'failed', required: partial: the run is over with both finished and failed rows
  - `rows_total` integer, required
  - `rows_done` integer, required
  - `rows_failed` integer, required
  - `rows` BatchTaskRow[], required
    - `idx` integer: 0-based row number in the table
    - `data` object: The variables this row fed
    - `render_job_id` string: The render job; poll-able through GET /render/status/{id}. A row refused before rendering carries a marker instead of an id
    - `status` 'queued' | 'processing' | 'done' | 'error'
    - `result_url` string: Path under /api/v1/files/… relative to the API origin — prefix https://rendry.io to download. Historical image results are public. New document attempt files and their page previews require the authenticated owner; a user asset (user_assets/…) is served only to its owner.
    - `error` string
    - `warnings` string[]: Layout findings of the finished picture (shrunk or clipped text, a sample photo printed)
  - `needs_attention` integer[]: Row indexes (idx) that failed or carry warnings; sent when there are any
  - `verdict` string: One sentence for a person: clean, with warnings, failed — sent with needs_attention
  - `archive_url` string: Path of GET /batch-tasks/{id}/archive, relative to the API origin; sent once every row is done or failed

---

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