Skip to navigation
Paperwork APISpaces

Render a PDF page to an image

View as Markdown

Renders one page of a PDF as a PNG and stores it as a new file.

{ "page": 1, "scale": 2 }

page is 1-based and defaults to the first page. scale runs from 0.1 to 6 and defaults to 2; the long edge is capped at 4000 pixels whatever you ask for.

Only a PDF can be rendered — convert first with convert/pdf.

Learn more: Working with files

Authentication

AuthorizationBearer

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

Path parameters

refstringRequired>=1 character
spaceIdstringRequired

Request

This endpoint expects an object.
pageintegerOptional1-9007199254740991
scaledoubleOptional0.1-6

Response

The rendered image.
object"file"
idstring
namestring
mimeTypestring
statusenum
Allowed values:
createdAtstring
parentFileIdstringOptional
metadatamap from strings to stringsOptional
errorstringOptional
uploadUrlstringOptional
uploadExpiresAtstringOptional
urlsobjectOptional

Errors

404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error