BAbannerbear

Render spreadsheet

Changed on

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.

post/tools/render_spreadsheet

Request

  • Base URL
    https://api.bannerbear.com/v5
  • Auth
    HTTP bearer

Request body

spreadsheet_urlstring uri required

A CSV or XLSX file with a header row of layer names, up to 500 rows

templatestring required

The UID of an image template in this workspace

format'png' | 'jpg' | 'pdf'

The file type of each image

metadatastring

Arbitrary metadata string stored with the tool run

Response

Tool run accepted

uidstring
tool'render_spreadsheet'
status'pending' | 'running' | 'completed' | 'failed'

pending → running → completed / failed

progressinteger

0-100 job progress, 100 once completed

inputsobject

Inputs the job was created with

metadatastring nullable

Arbitrary metadata string round-tripped from the create request

selfstring uri
created_atstring date-time
completed_atstring date-time nullable
error_messagestring nullable

Human-readable failure reason (only present on failed jobs)

Changes