POST
/
v1
/
pdf
/
sync

Authorizations

Authorization
string
headerrequired

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

Body

application/json
page
object
required

Page options, either provide the url, html or htmlTemplate option.

pdf
object
storage
object

Response

201 - application/json
id
string
required

Id of the queued job.

status
enum<string>
required

Status of the job.

Available options:
PENDING,
RUNNING,
FAILED,
COMPLETED
fileUrl
string | null

URL to the generated file (will be null if storage.signedUrl is used). This url is valid for 1 hour, after that the file will be deleted from our storage.

signedUrlStatus
string | null

Status of the signed url request if provided.

  • NOT_PROVIDED, no storage.preSignedUrl was provided.
  • UPLOADED, storage.preSignedUrl was provided and file is uploaded.
  • FAILED, storage.preSignedUrl was provided but the upload failed.