PDF Tools

Work with PDFs and Office documents—merge, split, convert, or extract pages.

Images to PDF

post

Upload one or more images and receive a single PDF.

  • Binary PDF is returned by default.

  • To receive a JSON payload with base64, set header Accept: application/json (or send json=1).

  • Choose engine via engine param: pdfkit (default), pdf-lib, or sharp (robust for PNGs). Use this when you want to gather screenshots, marketing graphics, or homework pages into a single document that is easy to share.

Authorizations
X-API-KeystringRequired
Body
filestring · binaryOptional

Upload a single file field when you only have one image.

file[]string · binary[]Optional

Repeat file[] fields when combining multiple images into one PDF.

pageSizestringOptional

Optional page size such as A4, Letter, or custom 800x600.

orientationstringOptional

Choose portrait or landscape to rotate the pages.

marginintegerOptional

Margin around each page in millimetres.

layoutstringOptional

Advanced layout choice (for example grid or single).

dpiintegerOptional

Render resolution. Higher values sharpen images but increase file size.

enginestring · enumOptional

Rendering engine to use. sharp handles transparency-heavy images best.

Possible values:
bgColorstringOptional

Optional hex color (e.g., #f4f4f4) to fill the background behind transparent images.

targetKBintegerOptional

Ask BridgeAPI to aim for this size in kilobytes.

targetMBintegerOptional

Ask BridgeAPI to aim for this size in megabytes.

jsonstringOptional

Set to 1, true, or json to request a JSON response instead of raw PDF bytes.

Responses
chevron-right
200

PDF bytes or JSON envelope with base64

Responsestring · binary
post
/v1/convert/images-to-pdf
Combine images into PDF

Images to PDFs (one-per-image)

post

Upload multiple images and get one PDF per image.

  • Default is a zip download.

  • Set Accept: application/json to receive a JSON payload with base64 for each output. Choose this when every input deserves its own PDF, such as generating certificates or handouts.

Authorizations
X-API-KeystringRequired
Body
file[]string · binary[]Optional

Upload each image as a file[] field.

pageSizestringOptional

Optional page size, for example A4 or Letter.

orientationstringOptional

Choose portrait or landscape for all generated PDFs.

marginintegerOptional

Margin around each page in millimetres.

Responses
chevron-right
200

Zip or JSON array

Responsestring · binary
post
/v1/convert/images-to-pdf/each
PDF per image

Merge PDFs

post

Merge multiple input PDFs into a single document. Binary PDF is returned by default; set Accept: application/json for a JSON envelope that carries the PDF as Base64 text. Handy for joining invoices, essays, or scans together.

Authorizations
X-API-KeystringRequired
Body
file[]string · binary[]Optional

Upload each source PDF as a separate file[] field in the form.

Responses
chevron-right
200

PDF bytes or JSON envelope with base64

Responsestring · binary
post
/v1/convert/pdf-merge
Merge multiple PDFs

Extract PDF pages to single PDF

post

Binary PDF by default; set Accept: application/json for base64 JSON response.

Authorizations
X-API-KeystringRequired
Body
filestring · binaryOptional

Source PDF from which you want to extract pages.

pagesstringOptional

Page numbers or ranges, e.g. 1, 1-3, or 1,3,5-7.

Responses
chevron-right
200

PDF bytes or JSON envelope with base64

Responsestring · binary
post
/v1/convert/pdf-extract-pages
Extract specific pages

Split PDF to multiple PDFs (zip)

post

Binary zip by default; set Accept: application/json to receive base64 JSON.

Authorizations
X-API-KeystringRequired
Body
filestring · binaryOptional

Source PDF to split.

pagesstringOptional

Instructions for splitting, such as 1-3,4-6 or even.

Responses
chevron-right
200

Zip bytes or JSON envelope with base64

Responsestring · binary
post
/v1/convert/pdf-split
Split PDF into ranges

PDF to images (zip)

post

Requires PDF rasterizer service. Returns zip by default; set Accept: application/json for base64 JSON.

Authorizations
X-API-KeystringRequired
Body
filestring · binaryOptional

Source PDF file.

tostring · enumOptional

Desired image format for each page.

Possible values:
dpiintegerOptional

Output resolution. Higher DPI creates sharper images.

pagesstringOptional

Optional page range, e.g. 1-3 or odd.

Responses
chevron-right
200

Zip bytes or JSON envelope with base64

Responsestring · binary
post
/v1/convert/pdf-to-images
Convert PDF pages to PNG

PDF watermark (text or image)

post

Overlay a text or image watermark onto every page of a PDF. Provide either text or an image file mark.

Authorizations
X-API-KeystringRequired
Body
filestring · binaryOptional

Source PDF file.

textstringOptional

Text watermark. Provide this or mark.

markstring · binaryOptional

Image watermark (PNG/JPEG). Provide this or text.

positionstring · enumOptionalDefault: sePossible values:
opacitynumber · max: 1OptionalDefault: 0.4
sizeintegerOptional

Font size for text watermark.

scaleinteger · min: 1 · max: 100Optional

Percentage scale for image watermark.

Default: 25
Responses
chevron-right
200

Binary PDF with watermark applied.

string · binaryOptional
post
/v1/convert/pdf-watermark

OCR image to text

post

Extract text from an image using OCR. Requires Google Cloud Vision credentials in the environment.

Authorizations
X-API-KeystringRequired
Body
filestring · binaryOptional

Image to OCR (PNG/JPEG).

Responses
chevron-right
200

JSON with recognized text.

application/json
textstringOptional
post
/v1/convert/ocr-to-txt

OCR image to searchable PDF

post

Create a searchable PDF by embedding the original image and overlaying recognized text. Requires Google Cloud Vision credentials in the environment.

Authorizations
X-API-KeystringRequired
Body
filestring · binaryOptional

Image to OCR (PNG/JPEG).

Responses
chevron-right
200

Searchable PDF.

application/pdf
string · binaryOptional
post
/v1/convert/ocr-to-pdf

Images to PDF (batch input)

post

Upload a single archive (zip) or large set via file field to produce a combined PDF.

Authorizations
X-API-KeystringRequired
Body
filestring · binaryRequired

Zip archive or multi-part upload containing the images to combine.

Responses
chevron-right
200

Combined PDF file or JSON envelope when you request JSON.

Responsestring · binary
post
/v1/convert/images-to-pdf/batch
Upload zip of images

PDF to DOCX

post

Turns a PDF into an editable Microsoft Word document so you can update text without retyping.

Authorizations
X-API-KeystringRequired
Body
filestring · binaryRequired

PDF file to convert into DOCX.

Responses
chevron-right
200

DOCX bytes or JSON envelope when Accept=application/json

Responsestring · binary
post
/v1/convert/pdf-to-docx
Convert PDF to DOCX

PDF to DOCX (batch)

post

Convert many PDFs to DOCX documents in one request. Useful when retrofitting legacy forms.

Authorizations
X-API-KeystringRequired
Body
filestring · binaryRequired

Zip archive or repeated upload of PDFs to convert.

Responses
chevron-right
200

Zip of DOCX files or JSON with base64

Responsestring · binary
post
/v1/convert/pdf-to-docx/batch
Batch convert PDFs to DOCX

DOCX to PDF

post

Turn Microsoft Word documents into shareable PDFs while keeping fonts and layout in place.

Authorizations
X-API-KeystringRequired
Body
filestring · binaryRequired

DOCX file to convert to PDF.

Responses
chevron-right
200

PDF bytes or JSON envelope when Accept=application/json

Responsestring · binary
post
/v1/convert/docx-to-pdf
Convert DOCX to PDF

PPTX to PDF

post

Convert PowerPoint presentations into PDFs for easy sharing without altering slide layout.

Authorizations
X-API-KeystringRequired
Body
filestring · binaryRequired

PPTX file to convert.

Responses
chevron-right
200

PDF bytes or JSON envelope

Responsestring · binary
post
/v1/convert/pptx-to-pdf
Convert PPTX to PDF

XLSX to PDF

post

Render spreadsheets as PDFs so tables, charts, and formulas can be shared as read-only documents.

Authorizations
X-API-KeystringRequired
Body
filestring · binaryRequired

XLSX workbook to convert.

Responses
chevron-right
200

PDF bytes or JSON envelope

Responsestring · binary
post
/v1/convert/xlsx-to-pdf
Convert spreadsheet to PDF

Office to PDF (batch)

post

Upload a collection of Office documents (Word, PowerPoint, Excel) and receive PDFs for each one.

Authorizations
X-API-KeystringRequired
Body
filestring · binaryRequired

Zip of Office files or repeated uploads.

Responses
chevron-right
200

Zip of PDFs or JSON envelope

Responsestring · binary
post
/v1/convert/office-to-pdf/batch
Batch Office to PDF

Last updated