Skip to main content
POST
Render one PDF page as an image

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Path Parameters

projectId
string
required

Body

application/json
fileId
string
required

Id of the uploaded PDF.

page
number
required

Physical page number, 1-based.

Response

200 - application/json
heightPx
number
required

Rendered height in pixels.

page
number
required
pageCount
number
required

Pages in the document, so a viewer can page through it without a second round trip to learn where it ends.

pngBase64
string
required

The rendered page as base64 PNG. Inlined rather than served as a URL so the browser needs no separately authenticated image request.

widthPx
number
required

Rendered width in pixels.