Skip to navigation

Media · Image · Combine images into a single PDF

View as Markdown

Combine multiple images — mixed formats supported (PNG, JPEG, WEBP, HEIC/HEIF) — into a single PDF, one page per image, in the given order. Each entry in images is a remote URL or an existing Simplified asset UUID (resolved server-side, scoped to the caller’s workspace). This produces a NEW combined PDF from separate source images — for converting a single image’s own container format use convertImageFormat instead. Async — returns a task_id (auto-polled).

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
imageslist of stringsRequired

Ordered list of image sources — each a remote URL or an existing Simplified asset UUID. Page order matches this order.

namestringOptional<=500 characters
Output PDF filename. Defaults to "images.pdf".
page_layoutenumOptionalDefaults to fit-to-image

"fit-to-image": each page sized to its own source image. "a4" / "letter": fixed page size, image centered and scaled to fit within margins.

Allowed values:
on_errorenumOptionalDefaults to fail

"fail": abort if any image can't be fetched or decoded. "skip": best-effort — assemble from whatever succeeded; skipped inputs are reported in the result.

Allowed values:

Response

Async task queued.
task_idstringOptional

Poll GET /api/v1/tasks/{task_id} until SUCCESS or FAILURE.