Skip to main content
POST
cURL
All provided options are optional and will be merged with those defined in the template.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json
webhook
object
required

Webhook to call when screenshot is generated.

page
object | null

Page options.

screenshot
object | null

Screenshot options, only used if Template's output is "SCREENSHOT".

pdf
object | null

Pdf options, only used if Template's output is "PDF".

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"