Skip to main content
POST
/
v1
/
template
/
{id}
/
sync
cURL
curl --request POST \
  --url https://api.doczilla.app/v1/template/{id}/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": {
    "url": "<string>",
    "html": "<string>",
    "htmlTemplate": "<string>",
    "templateData": {},
    "waitUntil": "auto",
    "waitForMilliseconds": 2500,
    "headers": {
      "x-foo": "bar"
    },
    "adblock": true,
    "javascript": true,
    "cookies": [
      {
        "name": "<string>",
        "value": "<string>",
        "domain": "<string>",
        "url": "<string>",
        "path": "<string>",
        "secure": true,
        "httpOnly": true,
        "expires": 123
      }
    ],
    "colorScheme": "<string>",
    "timezone": "<string>"
  },
  "screenshot": {
    "type": "png",
    "device": "Macbook Pro 16",
    "fullPage": false,
    "fromSurface": true,
    "omitBackground": false,
    "optimizeForSpeed": true,
    "quality": 50,
    "captureBeyondViewport": false,
    "element": "<string>",
    "overlay": {
      "background": "<string>",
      "filter": "none",
      "margin": 0.2,
      "screenshotBorderRadius": 0
    }
  },
  "pdf": {
    "scale": 1,
    "displayHeaderFooter": false,
    "headerHtml": "<string>",
    "footerHtml": "<string>",
    "printBackground": false,
    "landscape": false,
    "pageRanges": "1-5",
    "format": "letter",
    "width": "<string>",
    "height": "<string>",
    "preferCSSPageSize": false,
    "margin": {
      "top": "<string>",
      "bottom": "<string>",
      "left": "<string>",
      "right": "<string>"
    },
    "omitBackground": false,
    "outline": false,
    "tagged": false
  }
}
'
{
  "id": "5KqYNUjbxRJ-rKbIeGsXo",
  "status": "PENDING",
  "fileUrl": "<string>",
  "signedUrlStatus": "<string>"
}
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
​
page
object

Page options.

​
screenshot
object

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

​
pdf
object

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

​
storage
object

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"

​
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, no storage.preSignedUrl was provided.
  • UPLOADED, storage.preSignedUrl was provided and file is uploaded.
  • FAILED, storage.preSignedUrl was provided but the upload failed.