Screenshot
Create screenshot sync
Screenshot
Create screenshot sync
Create a screenshot and directly return a document URL instead of the raw document. Optionally writes the document directly into your bucket, bypassing the need for our temporary storage.
POST
/
v1
/
screenshot
/
sync
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
page
object
requiredPage options, either provide the url, html or htmlTemplate option.
screenshot
object
storage
object
Response
201 - application/json
id
string
requiredId of the queued job.
status
enum<string>
requiredStatus 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, nostorage.preSignedUrlwas provided.UPLOADED,storage.preSignedUrlwas provided and file is uploaded.FAILED,storage.preSignedUrlwas provided but the upload failed.
Was this page helpful?