Render a PDF page as an image.

Downloads or accepts an uploaded PDF, rasterizes the requested page, and returns it as PNG/JPG/WebP output. Drop this helper wherever you want to render a PDF page as an image with a single HTTP call. Send the documented inputs and the API streams back polished results you can hand directly to your users.

GETPOST/documents/page-to-image

Where this helper shines

Render a PDF page as an image. keeps documents helpers on autopilot. Use it whenever you need to render a PDF page as an image without pausing a sprint or asking design/dev to jump in.

Trigger this helper whenever you need to render a PDF page as an image without waiting on a full deploy.
Drop it into automations (Zapier, Make, workers) to render a PDF page as an image as part of your workflow.
Share the GET URL so support and success can render a PDF page as an image safely using their Dataczar API key.

Copy & ship snippets

GET

Instant link

GET https://api.dataczar.app/documents/page-to-image?url=https%3A%2F%2Fexample.com%2Fsample.png&page=1&width=640&height=480&ak=demo

Open directly in any browser, webhook, or low-code workflow.

curl

curl GET

curl "https://api.dataczar.app/documents/page-to-image?url=https%3A%2F%2Fexample.com%2Fsample.png&page=1&width=640&height=480&ak=demo"

Swap ak=demo with your Dataczar API key.

curl

curl POST

curl -X POST "https://api.dataczar.app/documents/page-to-image?ak=demo" \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.com/sample.png",
  "page": 20,
  "width": 640,
  "height": 480,
  "scale": 50,
  "format": "png",
  "background": "sample_background",
  "dryrun": true
}'

Send JSON payloads from back-end jobs, queues, or workers.

Parameters

Query Parameters

Name	Type	Description
url	string	PDF URL (or upload a file via multipart).
page	integer	1-indexed page to render.
width	integer	Target width in pixels (auto-scales height).
height	integer	Target height in pixels (auto-scales width).
scale	number	Manual zoom multiplier (default 2.0).
format	string	png \| jpg \| webp.
background	string	Canvas color used when flattening.
dryrun	boolean

All helper calls accept your Dataczar key via the ak query parameter. Need one? Create or copy a key on Dataczar Connect and drop it into each request.

Responses

Status 200

Rasterized image bytes.

Examples

Request

"GET /pdf/page-to-image?url=https://example.com/guide.pdf&page=2&format=jpg&width=1200&dryrun=1"

Response

{
  "ok": true,
  "data": {
    "summary": [
      "Render page 2",
      "Format JPG"
    ],
    "preview_png_base64": "..."
  },
  "meta": {
    "dryrun": true
  }
}

API key

HTTP method

File uploads (multipart form-data)

Attach PDFs or images as multipart fields. We'll fill in the field names for you.

Files

file — PDF document

Query parameters

url optionalpage optionalwidth optionalheight optionalscale optionalformat optionalbackground optionaldryrun optional

Body parameters

We'll send these as JSON for POST/PUT/PATCH requests and as query params for GET.

url optionalpage optionalwidth optionalheight optionalscale optionalformat optionalbackground optionaldryrun optional

Equivalent curl

Grab your Dataczar API key

Every helper runs with the same simple API key. Sign in (or create a free Dataczar account) at Dataczar Connect to issue keys in seconds, then drop the key into any `ak=` parameter and start shipping.

Get your API key Browse helpers

Tip: reuse the same key across these helpers, or rotate keys per project from the Connect dashboard.