Render up to 10 images in one call

One template x many data sets. Each item is charged as one render (1-3 credits by canvas area; pdf/html 2 a page) and the run stops at the first item the balance cannot pay for. For hundreds of rows use POST /batch-tasks (a table, one archive); for thousands loop this endpoint or queue /render/async with a webhook.

post/render/batch

Request

  • Base URL: https://rendry.io/api/v1
  • URL: https://rendry.io/api/v1/render/batch
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Headers

X-Rendry-Accountstring

Browser/OAuth current member account selector. API keys/embed credentials are bound to their persisted account and reject another account. Omitting this header selects the browser actor personal account.

Request body

preset_idstring required
format'png' | 'jpeg' | 'webp' | 'pdf' | 'html'

For the whole batch. pdf and html render the document profile at 2 credits a page

qualityinteger
max_widthinteger

Response

Batch finished, per-item status inside. An item that was refused carries the same refusal object a single render answers (error, message, diagnostics, …) beside its index and status (error, insufficient_credits, quota_exceeded). When the credits run out the batch stops, and every item it did not attempt is listed with status not_attempted and a reason.

renderedinteger required

Items that finished

totalinteger required
hintstring
needs_attentioninteger[]

Item indexes with warnings; sent when there are any

Changes

No recorded changes to this operation across all 1 revision of this API.