---
title: "Render spreadsheet"
method: POST
path: "/tools/render_spreadsheet"
---

# Render spreadsheet

`POST /tools/render_spreadsheet`

## Request

- Base URL: `https://api.bannerbear.com/v5`
- URL: `https://api.bannerbear.com/v5/tools/render_spreadsheet`
- Auth: HTTP bearer

Render one template image for each spreadsheet row. Async — returns 202 with a pending job; poll GET /tool_jobs/{uid} until `status` is `completed` or `failed`.

## Request body

- object
  - `spreadsheet_url` string, uri, required: A CSV or XLSX file with a header row of layer names, up to 500 rows
  - `template` string, required: The UID of an image template in this workspace
  - `format` 'png' | 'jpg' | 'pdf': The file type of each image
  - `metadata` string: Arbitrary metadata string stored with the tool run

## Response `202`

Tool run accepted

- object
  - `uid` string
  - `tool` 'render_spreadsheet'
  - `status` 'pending' | 'running' | 'completed' | 'failed': pending → running → completed / failed
  - `progress` integer: 0-100 job progress, 100 once completed
  - `inputs` object: Inputs the job was created with
  - `outputs` object
    - `image_urls` string[]
    - `image_url` string, uri
    - `row_count` integer
  - `metadata` string, nullable: Arbitrary metadata string round-tripped from the create request
  - `self` string, uri
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `error_message` string, nullable: Human-readable failure reason (only present on failed jobs)

## Other responses

- `402`: API quota exhausted — upgrade required
- `404`: Unknown tool
- `422`: Input validation failure

## Changes

- **2026-11-10** `24e6335e0a47`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bannerbear/apis/bannerbear-v5-api/changes/tools/render_spreadsheet/post.md)

---

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