BAbannerbear

Lay out print sheet

Changed on

Place images on paper in a grid with cut lines. Async — returns 202 with a pending job; poll GET /tool_jobs/{uid} until status is completed or failed.

post/tools/lay_out_print_sheet

Request

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

Request body

file_urlsstring[] required

One URL per line: PNG, JPG or a one-page PDF, up to 500. Each file makes one card, in this order

paper'a4' | 'letter' required

The paper size of every page

orientation'portrait' | 'landscape'

Defaults to portrait

card_width_mmnumber required

The printed width of one card

card_height_mmnumber required

The printed height of one card

gutter_mmnumber

The space between cards. Defaults to 0

fold'none' | 'tent'

Tent doubles the card height and turns the upper copy by 180 degrees, so the card folds into a tent

lines'none' | 'perforation' | 'crop_marks'

Perforation draws a dashed line round each card. Crop marks draw marks outside the corners

metadatastring

Arbitrary metadata string stored with the tool run

Response

Tool run accepted

uidstring
tool'lay_out_print_sheet'
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