Render screenshot synchronously

A sync render request responds once the render is finished with the document URL (instead of the raw document). A screenshot request renders an image.

It is a simple request, with an additionnal body param if you wish for Doppio to upload your document in your own S3 bucket.

Route

Method: POST

Route: api.doppio.sh/v1/render/screenshot/sync

Common body params doppio, page and launch: see here.

Screenshot body params page.screenshot: see here.

Examples

Request

Response:

json

{
  "doppioRequestId": "doppioreq_640d0598-0413-4385-8e4a-0ee43d531609",
  "renderStatus": "SUCCESS",
  "documentUrl": "https://tmp.doppio.sh/doppioreq_640d0598-0413-4385-8e4a-0ee43d531609-1661856673637.webp",
  "isAsync": false,
  "isCustomBucket": true
}

Response

To get a list of all possible response codes, see here

If everything goes well, Doppio will respond with the following payload:

Property name	Type	Description
`doppioRequestId`	string	Request identifier.
`renderStatus`	string	Rendering status of your document. Can be either `SUCCESS`or `ERROR`
`documentUrl`	string	URL to access your rendered document
`isAsync`	boolean	If the request is async. Will always be `false`for this request method
`isCustomBucket`	boolean	If the document is hosted on your own S3 bucket or temporarily on our own.

Render screenshot synchronously #

Route #

Examples #

Request #