POST
/
v1
/
screenshot
/
async

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.

webhook
object
required

Webhook to call when screenshot is generated.

screenshot
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