Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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.

webhook
object
required

Webhook to call when screenshot is generated.

pdf
object | null
storage
object | null

Response

id
string
required

Id of the queued job.

Example:

"5KqYNUjbxRJ-rKbIeGsXo"

status
enum<string>
required

Status of the job.

Available options:
PENDING,
RUNNING,
FAILED,
COMPLETED
Example:

"PENDING"