{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Doczilla","colors":{"primary":"#17E286","light":"#17E286","dark":"#17E286"},"favicon":"/favicon.png","logo":{"light":"https://mintcdn.com/doczilla/yA67lL7oehM3XiOm/images/logo.svg?fit=max\u0026auto=format\u0026n=yA67lL7oehM3XiOm\u0026q=85\u0026s=29829af5c66efb627f6a2394dd7e4fcc","dark":"https://mintcdn.com/doczilla/yA67lL7oehM3XiOm/images/logo.svg?fit=max\u0026auto=format\u0026n=yA67lL7oehM3XiOm\u0026q=85\u0026s=29829af5c66efb627f6a2394dd7e4fcc","href":"https://doczilla.app"},"api":{"openapi":"api-reference/openapi.json"},"appearance":{"default":"dark","strict":true},"background":{"decoration":null,"color":{"light":"#000","dark":"#000"}},"navbar":{"links":[{"label":"Login","href":"https://doczilla.app/login"}],"primary":{"type":"button","label":"Sign up","href":"https://doczilla.app/signup"}},"footer":{"socials":{"github":"https://github.com/doczilla-app","website":"https://doczilla.app"},"links":[{"header":null,"items":[{"label":"Pricing","href":"https://doczilla.app/pricing"},{"label":"PDF API","href":"https://doczilla.app/features/pdf-api"},{"label":"Screenshot API","href":"https://doczilla.app/features/screenshot-api"}]},{"header":null,"items":[{"label":"Blog","href":"https://doczilla.app/blog"},{"label":"About us","href":"https://doczilla.app/about"},{"label":"Privacy Policy","href":"https://doczilla.app/privacy"},{"label":"Terms of Service","href":"https://doczilla.app/terms"}]},{"header":null,"items":[{"label":"Contact","href":"mailto:contact@doczilla.app"},{"label":"Community","href":"/community"},{"label":"Examples","href":"https://doczilla.app/terms"}]}]},"integrations":{"posthog":{"apiKey":"phc_YhKaViejsEL77Sp2WhzFvU4XArynP0nwT7cm4vp8fY6","apiHost":"https://eu.posthog.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"doczilla","hasAudioNarration":false,"actualSubdomain":"doczilla","customDomains":["docs.doczilla.app"],"gitSource":{"type":"github","owner":"doczilla-app","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e61133a4518725aab129","collectionId":"91be9ac5-be07-45b6-9dbd-d056ca1eb385","schemaVersion":"v2"},"feedback":{"thumbs":true,"issues":false},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a21e61133a4518725aab129:success","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Documentation","count":28},{"language":"default","tag":"Examples","count":13},{"language":"default","tag":"Libraries","count":6},{"language":"default","tag":"Manage Templates","count":5},{"language":"default","tag":"API Documentation","count":5},{"language":"default","tag":"Get Started","count":4},{"language":"default","tag":"Screenshots","count":4},{"language":"default","tag":"PDFs","count":4},{"language":"default","tag":"Templating","count":4},{"language":"default","tag":"PDF","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/create-template","slug":"/api-reference/endpoint/create-template","pageMetadata":{"title":"Create new Template","openapi":"POST /v1/templates","description":"Create one template.","href":"/api-reference/endpoint/create-template","hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create one template.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create new Template","openapi":"POST /v1/templates","description":"Create one template.","href":"/api-reference/endpoint/create-template","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Create one template.","operationId":"templates.create","parameters":[],"requestBody":"d69833a7-eb27-4888-9262-e361e3ffef60","responses":{"201":"046093f0-46f5-4cb9-812b-d50470d7f08d","400":"68bf7bb9-6d69-4627-916e-072882b9abf8","401":"3a1620d2-f125-40a8-adc9-e120c9e24773","402":"7989bb9a-2cc9-4c05-9356-c9daa8b36a06","403":"a0d3c967-a361-4b32-826e-6dacbbaed0e4","413":"036067a0-a435-428b-b808-5acd8c34ea7f","429":"cdbe2e90-bdae-4813-836a-b31a42cfd14e","500":"9fba3f74-a349-4cc3-b4e9-e654960323f5"},"security":["ae9b3245-4023-4092-86fe-513691b285df"],"summary":"","tags":["Templates"],"method":"post","type":"path","servers":["57ffd971-71ce-487f-843d-609a50a44134"],"path":"/v1/templates","baseUrlOptions":["https://api.doczilla.app"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the template.","maxLength":200,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"output":{"type":"string","description":"The output format of the template.","enum":["PDF","IMAGE"],"isRequired":true,"uniqueKey":"output","typeLabel":"enum\u003cstring>"},"variables":{"type":"object","description":"The variables of the template.","required":["page"],"properties":{"page":{"type":"object","description":"Page options, either provide the `url`, `html` or `htmlTemplate` option.","properties":{"url":{"oneOf":[{"type":"string","description":"URL to go to. Should include the scheme, e.g. `https://`","uniqueKey":"variables.page.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL to go to. Should include the scheme, e.g. `https://`","uniqueKey":"variables.page.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.url","typeLabel":"string | null"},"html":{"oneOf":[{"type":"string","description":"HTML to render. Needs to be base64 encoded!","uniqueKey":"variables.page.html.oneOf.0","typeLabel":"string"},{"type":"null","description":"HTML to render. Needs to be base64 encoded!","uniqueKey":"variables.page.html.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.html","typeLabel":"string | null"},"htmlTemplate":{"oneOf":[{"type":"string","description":"HTML template to render, uses [Handlebars](https://handlebarsjs.com/) to render your HTML together with the provided `templateData`. Needs to be base64 encoded!","uniqueKey":"variables.page.htmlTemplate.oneOf.0","typeLabel":"string"},{"type":"null","description":"HTML template to render, uses [Handlebars](https://handlebarsjs.com/) to render your HTML together with the provided `templateData`. Needs to be base64 encoded!","uniqueKey":"variables.page.htmlTemplate.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.htmlTemplate","typeLabel":"string | null"},"templateData":{"oneOf":[{"type":"object","description":"Template data, only used in combination with `page.htmlTemplate`.","uniqueKey":"variables.page.templateData.oneOf.0","typeLabel":"object"},{"type":"null","description":"Template data, only used in combination with `page.htmlTemplate`.","uniqueKey":"variables.page.templateData.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.templateData","typeLabel":"object | null"},"waitUntil":{"type":"string","example":"auto","description":"When to consider waiting succeeds.\n- `auto` our smart waiting option that can handle 90% of the cases.\n- `load` waits for the 'load' event.\n- `domcontentloaded` waits for the 'DOMContentLoaded' event.\n- `networkidle0` waits till there are no more than 0 network connections for at least `500` ms.\n- `networkidle2` waits till there are no more than 2 network connections for at least `500` ms. ","enum":["auto","load","domcontentloaded","networkidle0","networkidle2"],"default":"auto","uniqueKey":"variables.page.waitUntil","typeLabel":"enum\u003cstring>"},"waitForMilliseconds":{"oneOf":[{"type":"number","description":"Wait for a certain amount of milliseconds before the request continues.","minimum":0,"maximum":5000,"uniqueKey":"variables.page.waitForMilliseconds.oneOf.0","typeLabel":"number"},{"type":"null","description":"Wait for a certain amount of milliseconds before the request continues.","minimum":0,"maximum":5000,"uniqueKey":"variables.page.waitForMilliseconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.waitForMilliseconds","typeLabel":"number | null"},"waitForSelector":{"oneOf":[{"type":"object","description":"Wait for the [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors) to appear in page. If the [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors) doesn't appear after the `timeout` milliseconds of waiting, the request will continue.","required":["selector"],"properties":{"selector":{"type":"string","description":"The [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors) of an element to wait for.","minLength":1,"maxLength":1024,"isRequired":true,"uniqueKey":"variables.page.waitForSelector.oneOf.0.selector","typeLabel":"string"},"options":{"oneOf":[{"type":"object","description":"Options for configuring waiting behavior.","properties":{"visible":{"type":"boolean","example":false,"description":"Wait for the selected element to be present in DOM and to be visibleAn element is considered to be visible if all of the following is true:\n- the element has [computed styles](https://developer.mozilla.org/en-US/docs/Web/API/Window/getComputedStyle)\n- the element has a non-empty [bounding client rect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect)\n- the element's [visibility](https://developer.mozilla.org/en-US/docs/Web/CSS/visibility) is not `hidden` or `collapse`","default":false,"uniqueKey":"variables.page.waitForSelector.oneOf.0.options.oneOf.0.visible","typeLabel":"boolean"},"hidden":{"type":"boolean","example":false,"description":"Wait for the selected element to not be found in the DOM or to be hidden.An element is considered to be hidden if at least one of the following is true:\n- the element has no [computed styles](https://developer.mozilla.org/en-US/docs/Web/API/Window/getComputedStyle)\n- the element has an empty [bounding client rect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect)\n- the element's [visibility](https://developer.mozilla.org/en-US/docs/Web/CSS/visibility) is `hidden` or `collapse`","default":false,"uniqueKey":"variables.page.waitForSelector.oneOf.0.options.oneOf.0.hidden","typeLabel":"boolean"},"timeout":{"type":"number","example":10000,"description":"Maximum time to wait in milliseconds.","minimum":1,"maximum":30000,"default":10000,"uniqueKey":"variables.page.waitForSelector.oneOf.0.options.oneOf.0.timeout","typeLabel":"number"}},"uniqueKey":"variables.page.waitForSelector.oneOf.0.options.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.page.waitForSelector.oneOf.0.options.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.waitForSelector.oneOf.0.options","typeLabel":"object | null"}},"uniqueKey":"variables.page.waitForSelector.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.page.waitForSelector.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.waitForSelector","typeLabel":"object | null"},"waitForFunction":{"oneOf":[{"type":"object","description":"Wait for the `pageFunction` to execute in the page. If the `pageFunction` doesn't execute successfully after the `timeout` milliseconds of waiting, the request will continue.","required":["pageFunction"],"properties":{"pageFunction":{"type":"string","example":"window.innerWidth \u003c 100","description":"Function to be evaluated in browser context until it returns a truthy value.","minLength":1,"maxLength":1024,"isRequired":true,"uniqueKey":"variables.page.waitForFunction.oneOf.0.pageFunction","typeLabel":"string"},"options":{"oneOf":[{"type":"object","description":"Options for configuring waiting behavior.","properties":{"polling":{"oneOf":[{"type":"string","description":"An interval at which the `pageFunction` is executed, defaults to `raf`. If `polling` is a number, then it is treated as an interval in milliseconds at which the function would be executed. If `polling` is a string, then it can be one of the following values:\n- `raf` to constantly execute `pageFunction` in `requestAnimationFrame` callback. This is the tightest polling mode which is suitable to observe styling changes.\n- `mutation` to execute `pageFunction` on every DOM mutation.","default":"raf","enum":["raf","mutation"],"example":"raf","uniqueKey":"variables.page.waitForFunction.oneOf.0.options.oneOf.0.polling.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"number","description":"An interval at which the `pageFunction` is executed, defaults to `raf`. If `polling` is a number, then it is treated as an interval in milliseconds at which the function would be executed. If `polling` is a string, then it can be one of the following values:\n- `raf` to constantly execute `pageFunction` in `requestAnimationFrame` callback. This is the tightest polling mode which is suitable to observe styling changes.\n- `mutation` to execute `pageFunction` on every DOM mutation.","default":"raf","example":"raf","uniqueKey":"variables.page.waitForFunction.oneOf.0.options.oneOf.0.polling.oneOf.1","typeLabel":"number"}],"uniqueKey":"variables.page.waitForFunction.oneOf.0.options.oneOf.0.polling","typeLabel":"enum\u003cstring> | number"},"timeout":{"type":"number","example":10000,"description":"Maximum time to wait in milliseconds.","minimum":1,"maximum":30000,"default":10000,"uniqueKey":"variables.page.waitForFunction.oneOf.0.options.oneOf.0.timeout","typeLabel":"number"}},"uniqueKey":"variables.page.waitForFunction.oneOf.0.options.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.page.waitForFunction.oneOf.0.options.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.waitForFunction.oneOf.0.options","typeLabel":"object | null"}},"uniqueKey":"variables.page.waitForFunction.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.page.waitForFunction.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.waitForFunction","typeLabel":"object | null"},"headers":{"oneOf":[{"type":"object","example":{"x-foo":"bar"},"description":"An object containing additional HTTP headers to be sent with every request. All header values must be strings.","uniqueKey":"variables.page.headers.oneOf.0","typeLabel":"object"},{"type":"null","example":{"x-foo":"bar"},"description":"An object containing additional HTTP headers to be sent with every request. All header values must be strings.","uniqueKey":"variables.page.headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.headers","typeLabel":"object | null"},"adblock":{"type":"boolean","example":true,"description":"Use our build-in adblocker.","default":true,"uniqueKey":"variables.page.adblock","typeLabel":"boolean"},"javascript":{"type":"boolean","example":true,"description":"Whether or not to enable JavaScript on the page.","default":true,"uniqueKey":"variables.page.javascript","typeLabel":"boolean"},"cookies":{"oneOf":[{"description":"Cookies added to the page, Also accepted as string inside `headers.cookie`.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Cookie name.","minLength":1,"maxLength":1024,"isRequired":true,"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","description":"Cookie value.","minLength":1,"maxLength":4096,"isRequired":true,"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].value","typeLabel":"string"},"domain":{"type":"string","description":"Cookie domain.","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].domain","typeLabel":"string"},"url":{"oneOf":[{"type":"string","description":"The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie. Should include the scheme, e.g. `https://`","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie. Should include the scheme, e.g. `https://`","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].url.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].url","typeLabel":"string | null"},"path":{"oneOf":[{"type":"string","description":"Cookie path.","minLength":1,"maxLength":512,"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].path.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cookie path.","minLength":1,"maxLength":512,"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].path.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].path","typeLabel":"string | null"},"secure":{"oneOf":[{"type":"boolean","description":"`true` if cookie is secure.","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].secure.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"`true` if cookie is secure.","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].secure.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].secure","typeLabel":"boolean | null"},"httpOnly":{"oneOf":[{"type":"boolean","description":"`true` if cookie is http-only.","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].httpOnly.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"`true` if cookie is http-only.","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].httpOnly.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].httpOnly","typeLabel":"boolean | null"},"sameSite":{"oneOf":[{"type":"string","description":"Cookie SameSite type.","enum":["Strict","Lax","None"],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].sameSite.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Cookie SameSite type.","enum":["Strict","Lax","None"],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].sameSite.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].sameSite","typeLabel":"enum\u003cstring> | null"},"expires":{"oneOf":[{"type":"number","description":"Cookie expiration date (UTC time in seconds, counted from January 1, 1970.), session cookie if not set. ","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].expires.oneOf.0","typeLabel":"number"},{"type":"null","description":"Cookie expiration date (UTC time in seconds, counted from January 1, 1970.), session cookie if not set. ","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].expires.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].expires","typeLabel":"number | null"}},"required":["name","value","domain"],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"variables.page.cookies.oneOf.0","typeLabel":"object[]"},{"description":"Cookies added to the page, Also accepted as string inside `headers.cookie`.","type":"null","items":{"type":"object","properties":{"name":{"type":"string","description":"Cookie name.","minLength":1,"maxLength":1024},"value":{"type":"string","description":"Cookie value.","minLength":1,"maxLength":4096},"domain":{"type":"string","description":"Cookie domain.","minLength":1,"maxLength":512},"url":{"oneOf":[{"type":"string","description":"The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie. Should include the scheme, e.g. `https://`"},{"type":"null","description":"The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie. Should include the scheme, e.g. `https://`"}]},"path":{"oneOf":[{"type":"string","description":"Cookie path.","minLength":1,"maxLength":512},{"type":"null","description":"Cookie path.","minLength":1,"maxLength":512}]},"secure":{"oneOf":[{"type":"boolean","description":"`true` if cookie is secure."},{"type":"null","description":"`true` if cookie is secure."}]},"httpOnly":{"oneOf":[{"type":"boolean","description":"`true` if cookie is http-only."},{"type":"null","description":"`true` if cookie is http-only."}]},"sameSite":{"oneOf":[{"type":"string","description":"Cookie SameSite type.","enum":["Strict","Lax","None"]},{"type":"null","description":"Cookie SameSite type.","enum":["Strict","Lax","None"]}]},"expires":{"oneOf":[{"type":"number","description":"Cookie expiration date (UTC time in seconds, counted from January 1, 1970.), session cookie if not set. "},{"type":"null","description":"Cookie expiration date (UTC time in seconds, counted from January 1, 1970.), session cookie if not set. "}]}},"required":["name","value","domain"]},"uniqueKey":"variables.page.cookies.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.cookies","typeLabel":"object[] | null"},"authentication":{"oneOf":[{"type":"object","description":"Provide credentials for `HTTP authentication`.","required":["username","password"],"properties":{"username":{"type":"string","minLength":1,"maxLength":1024,"isRequired":true,"uniqueKey":"variables.page.authentication.oneOf.0.username","typeLabel":"string"},"password":{"type":"string","minLength":1,"maxLength":4096,"isRequired":true,"uniqueKey":"variables.page.authentication.oneOf.0.password","typeLabel":"string"}},"uniqueKey":"variables.page.authentication.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.page.authentication.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.authentication","typeLabel":"object | null"},"colorScheme":{"oneOf":[{"type":"string","description":"Color-scheme to set on the page.","maxLength":20,"uniqueKey":"variables.page.colorScheme.oneOf.0","typeLabel":"string"},{"type":"null","description":"Color-scheme to set on the page.","maxLength":20,"uniqueKey":"variables.page.colorScheme.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.colorScheme","typeLabel":"string | null"},"mediaType":{"oneOf":[{"type":"string","description":"Changes the CSS media type of the page.","enum":["screen","print"],"uniqueKey":"variables.page.mediaType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Changes the CSS media type of the page.","enum":["screen","print"],"uniqueKey":"variables.page.mediaType.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.mediaType","typeLabel":"enum\u003cstring> | null"},"timezone":{"oneOf":[{"type":"string","description":"Changes the timezone of the page. See [ICU’s metaZones.txt](https://source.chromium.org/chromium/chromium/deps/icu.git/+/faee8bc70570192d82d2978a71e2a615788597d1:source/data/misc/metaZones.txt) for a list of supported timezone IDs.","uniqueKey":"variables.page.timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Changes the timezone of the page. See [ICU’s metaZones.txt](https://source.chromium.org/chromium/chromium/deps/icu.git/+/faee8bc70570192d82d2978a71e2a615788597d1:source/data/misc/metaZones.txt) for a list of supported timezone IDs.","uniqueKey":"variables.page.timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.timezone","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"variables.page","typeLabel":"object"},"screenshot":{"oneOf":[{"type":"object","properties":{"type":{"oneOf":[{"type":"string","example":"png","enum":["png","jpeg","webp"],"default":"png","uniqueKey":"variables.screenshot.oneOf.0.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"png","enum":["png","jpeg","webp"],"default":"png","uniqueKey":"variables.screenshot.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.type","typeLabel":"enum\u003cstring> | null"},"device":{"oneOf":[{"type":"string","example":"Macbook Pro 16","description":"Device preset to use, will not be set when `viewport` option is provided!","enum":["Blackberry PlayBook","Blackberry PlayBook landscape","BlackBerry Z30","BlackBerry Z30 landscape","Galaxy Note 3","Galaxy Note 3 landscape","Galaxy Note II","Galaxy Note II landscape","Galaxy S III","Galaxy S III landscape","Galaxy S5","Galaxy S5 landscape","Galaxy S8","Galaxy S8 landscape","Galaxy S9+","Galaxy S9+ landscape","Galaxy Tab S4","Galaxy Tab S4 landscape","iPad","iPad landscape","iPad (gen 6)","iPad (gen 6) landscape","iPad (gen 7)","iPad (gen 7) landscape","iPad Mini","iPad Mini landscape","iPad Pro","iPad Pro landscape","iPad Pro 11","iPad Pro 11 landscape","iPhone 4","iPhone 4 landscape","iPhone 5","iPhone 5 landscape","iPhone 6","iPhone 6 landscape","iPhone 6 Plus","iPhone 6 Plus landscape","iPhone 7","iPhone 7 landscape","iPhone 7 Plus","iPhone 7 Plus landscape","iPhone 8","iPhone 8 landscape","iPhone 8 Plus","iPhone 8 Plus landscape","iPhone SE","iPhone SE landscape","iPhone X","iPhone X landscape","iPhone XR","iPhone XR landscape","iPhone 11","iPhone 11 landscape","iPhone 11 Pro","iPhone 11 Pro landscape","iPhone 11 Pro Max","iPhone 11 Pro Max landscape","iPhone 12","iPhone 12 landscape","iPhone 12 Pro","iPhone 12 Pro landscape","iPhone 12 Pro Max","iPhone 12 Pro Max landscape","iPhone 12 Mini","iPhone 12 Mini landscape","iPhone 13","iPhone 13 landscape","iPhone 13 Pro","iPhone 13 Pro landscape","iPhone 13 Pro Max","iPhone 13 Pro Max landscape","iPhone 13 Mini","iPhone 13 Mini landscape","iPhone 14","iPhone 14 landscape","iPhone 14 Plus","iPhone 14 Plus landscape","iPhone 14 Pro","iPhone 14 Pro landscape","iPhone 14 Pro Max","iPhone 14 Pro Max landscape","iPhone 15","iPhone 15 landscape","iPhone 15 Plus","iPhone 15 Plus landscape","iPhone 15 Pro","iPhone 15 Pro landscape","iPhone 15 Pro Max","iPhone 15 Pro Max landscape","JioPhone 2","JioPhone 2 landscape","Kindle Fire HDX","Kindle Fire HDX landscape","LG Optimus L70","LG Optimus L70 landscape","Microsoft Lumia 550","Microsoft Lumia 950","Microsoft Lumia 950 landscape","Nexus 10","Nexus 10 landscape","Nexus 4","Nexus 4 landscape","Nexus 5","Nexus 5 landscape","Nexus 5X","Nexus 5X landscape","Nexus 6","Nexus 6 landscape","Nexus 6P","Nexus 6P landscape","Nexus 7","Nexus 7 landscape","Nokia Lumia 520","Nokia Lumia 520 landscape","Nokia N9","Nokia N9 landscape","Pixel 2","Pixel 2 landscape","Pixel 2 XL","Pixel 2 XL landscape","Pixel 3","Pixel 3 landscape","Pixel 4","Pixel 4 landscape","Pixel 4a (5G)","Pixel 4a (5G) landscape","Pixel 5","Pixel 5 landscape","Moto G4","Moto G4 landscape","Macbook Pro 13","Macbook Pro 15","Macbook Pro 16","iMac 21","iMac 21 4K","iMac 24 4.5K","iMac 27","iMac 27 5K"],"default":"Macbook Pro 16","uniqueKey":"variables.screenshot.oneOf.0.device.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"Macbook Pro 16","description":"Device preset to use, will not be set when `viewport` option is provided!","enum":["Blackberry PlayBook","Blackberry PlayBook landscape","BlackBerry Z30","BlackBerry Z30 landscape","Galaxy Note 3","Galaxy Note 3 landscape","Galaxy Note II","Galaxy Note II landscape","Galaxy S III","Galaxy S III landscape","Galaxy S5","Galaxy S5 landscape","Galaxy S8","Galaxy S8 landscape","Galaxy S9+","Galaxy S9+ landscape","Galaxy Tab S4","Galaxy Tab S4 landscape","iPad","iPad landscape","iPad (gen 6)","iPad (gen 6) landscape","iPad (gen 7)","iPad (gen 7) landscape","iPad Mini","iPad Mini landscape","iPad Pro","iPad Pro landscape","iPad Pro 11","iPad Pro 11 landscape","iPhone 4","iPhone 4 landscape","iPhone 5","iPhone 5 landscape","iPhone 6","iPhone 6 landscape","iPhone 6 Plus","iPhone 6 Plus landscape","iPhone 7","iPhone 7 landscape","iPhone 7 Plus","iPhone 7 Plus landscape","iPhone 8","iPhone 8 landscape","iPhone 8 Plus","iPhone 8 Plus landscape","iPhone SE","iPhone SE landscape","iPhone X","iPhone X landscape","iPhone XR","iPhone XR landscape","iPhone 11","iPhone 11 landscape","iPhone 11 Pro","iPhone 11 Pro landscape","iPhone 11 Pro Max","iPhone 11 Pro Max landscape","iPhone 12","iPhone 12 landscape","iPhone 12 Pro","iPhone 12 Pro landscape","iPhone 12 Pro Max","iPhone 12 Pro Max landscape","iPhone 12 Mini","iPhone 12 Mini landscape","iPhone 13","iPhone 13 landscape","iPhone 13 Pro","iPhone 13 Pro landscape","iPhone 13 Pro Max","iPhone 13 Pro Max landscape","iPhone 13 Mini","iPhone 13 Mini landscape","iPhone 14","iPhone 14 landscape","iPhone 14 Plus","iPhone 14 Plus landscape","iPhone 14 Pro","iPhone 14 Pro landscape","iPhone 14 Pro Max","iPhone 14 Pro Max landscape","iPhone 15","iPhone 15 landscape","iPhone 15 Plus","iPhone 15 Plus landscape","iPhone 15 Pro","iPhone 15 Pro landscape","iPhone 15 Pro Max","iPhone 15 Pro Max landscape","JioPhone 2","JioPhone 2 landscape","Kindle Fire HDX","Kindle Fire HDX landscape","LG Optimus L70","LG Optimus L70 landscape","Microsoft Lumia 550","Microsoft Lumia 950","Microsoft Lumia 950 landscape","Nexus 10","Nexus 10 landscape","Nexus 4","Nexus 4 landscape","Nexus 5","Nexus 5 landscape","Nexus 5X","Nexus 5X landscape","Nexus 6","Nexus 6 landscape","Nexus 6P","Nexus 6P landscape","Nexus 7","Nexus 7 landscape","Nokia Lumia 520","Nokia Lumia 520 landscape","Nokia N9","Nokia N9 landscape","Pixel 2","Pixel 2 landscape","Pixel 2 XL","Pixel 2 XL landscape","Pixel 3","Pixel 3 landscape","Pixel 4","Pixel 4 landscape","Pixel 4a (5G)","Pixel 4a (5G) landscape","Pixel 5","Pixel 5 landscape","Moto G4","Moto G4 landscape","Macbook Pro 13","Macbook Pro 15","Macbook Pro 16","iMac 21","iMac 21 4K","iMac 24 4.5K","iMac 27","iMac 27 5K"],"default":"Macbook Pro 16","uniqueKey":"variables.screenshot.oneOf.0.device.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.device","typeLabel":"enum\u003cstring> | null"},"viewport":{"oneOf":[{"type":"object","description":"Define an custom viewport, when defined the `device` option will be ignored!","required":["width","height"],"properties":{"width":{"type":"number","description":"The page width in CSS pixels.","minimum":0,"maximum":4480,"isRequired":true,"uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.0.width","typeLabel":"number"},"height":{"type":"number","description":"The page height in CSS pixels.","minimum":0,"maximum":2520,"isRequired":true,"uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.0.height","typeLabel":"number"},"deviceScaleFactor":{"type":"number","example":1,"description":"Specify device scale factor. See [devicePixelRatio](https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio) for more info.","default":1,"minimum":1,"maximum":3,"uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.0.deviceScaleFactor","typeLabel":"number"},"isMobile":{"type":"boolean","example":false,"description":"Whether the `meta viewport` tag is taken into account.","default":false,"uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.0.isMobile","typeLabel":"boolean"},"hasTouch":{"type":"boolean","example":false,"description":"Specify if the viewport supports touch events.","default":false,"uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.0.hasTouch","typeLabel":"boolean"},"isLandscape":{"type":"boolean","example":false,"description":"Specifies if the viewport is in landscape mode.","default":false,"uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.0.isLandscape","typeLabel":"boolean"}},"uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.viewport","typeLabel":"object | null"},"fullPage":{"type":"boolean","example":false,"description":"When `true`, takes a screenshot of the full page.","default":false,"uniqueKey":"variables.screenshot.oneOf.0.fullPage","typeLabel":"boolean"},"fromSurface":{"type":"boolean","example":true,"description":"Capture the screenshot from the surface, rather than the view.","default":true,"uniqueKey":"variables.screenshot.oneOf.0.fromSurface","typeLabel":"boolean"},"omitBackground":{"type":"boolean","example":false,"description":"Hides default white background and allows capturing screenshots with transparency.","default":false,"uniqueKey":"variables.screenshot.oneOf.0.omitBackground","typeLabel":"boolean"},"optimizeForSpeed":{"type":"boolean","example":true,"default":true,"uniqueKey":"variables.screenshot.oneOf.0.optimizeForSpeed","typeLabel":"boolean"},"quality":{"oneOf":[{"type":"number","description":"Quality of the image, between 0-100. Not applicable to `png` images.","minimum":0,"maximum":100,"uniqueKey":"variables.screenshot.oneOf.0.quality.oneOf.0","typeLabel":"number"},{"type":"null","description":"Quality of the image, between 0-100. Not applicable to `png` images.","minimum":0,"maximum":100,"uniqueKey":"variables.screenshot.oneOf.0.quality.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.quality","typeLabel":"number | null"},"captureBeyondViewport":{"type":"boolean","example":false,"description":"Capture the screenshot beyond the viewport. `false` if there is no `clip`. `true` otherwise.","default":false,"uniqueKey":"variables.screenshot.oneOf.0.captureBeyondViewport","typeLabel":"boolean"},"clip":{"oneOf":[{"type":"object","description":"Specifies the region of the page to clip.","required":["width","height","x","y"],"properties":{"width":{"type":"number","description":"The width of the element in pixels.","minimum":0,"maximum":4480,"isRequired":true,"uniqueKey":"variables.screenshot.oneOf.0.clip.oneOf.0.width","typeLabel":"number"},"height":{"type":"number","description":"The height of the element in pixels.","minimum":0,"maximum":2520,"isRequired":true,"uniqueKey":"variables.screenshot.oneOf.0.clip.oneOf.0.height","typeLabel":"number"},"x":{"type":"number","isRequired":true,"uniqueKey":"variables.screenshot.oneOf.0.clip.oneOf.0.x","typeLabel":"number"},"y":{"type":"number","isRequired":true,"uniqueKey":"variables.screenshot.oneOf.0.clip.oneOf.0.y","typeLabel":"number"},"scale":{"type":"number","example":1,"default":1,"minimum":0,"uniqueKey":"variables.screenshot.oneOf.0.clip.oneOf.0.scale","typeLabel":"number"}},"uniqueKey":"variables.screenshot.oneOf.0.clip.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.screenshot.oneOf.0.clip.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.clip","typeLabel":"object | null"},"element":{"oneOf":[{"type":"string","description":"It captures the DOM element matching the given CSS [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors). This will overwrite the `clip` property and set `fullPage` to `false`. Will wait for the element to become visible for a maximum of 15 seconds.","uniqueKey":"variables.screenshot.oneOf.0.element.oneOf.0","typeLabel":"string"},{"type":"null","description":"It captures the DOM element matching the given CSS [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors). This will overwrite the `clip` property and set `fullPage` to `false`. Will wait for the element to become visible for a maximum of 15 seconds.","uniqueKey":"variables.screenshot.oneOf.0.element.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.element","typeLabel":"string | null"},"overlay":{"oneOf":[{"type":"object","description":"Add an overlay to the image. Cannot be used together with the `fullPage` option!","properties":{"background":{"oneOf":[{"type":"string","description":"Color to apply as background, can be an an hexadecimal/rgb/rgba color code or CSS gradient.","uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.background.oneOf.0","typeLabel":"string"},{"type":"null","description":"Color to apply as background, can be an an hexadecimal/rgb/rgba color code or CSS gradient.","uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.background","typeLabel":"string | null"},"filter":{"oneOf":[{"type":"string","example":"none","description":"Apply [CSS Filter](https://developer.mozilla.org/en-US/docs/Web/CSS/filter) to background.","default":"none","uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.filter.oneOf.0","typeLabel":"string"},{"type":"null","example":"none","description":"Apply [CSS Filter](https://developer.mozilla.org/en-US/docs/Web/CSS/filter) to background.","default":"none","uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.filter.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.filter","typeLabel":"string | null"},"margin":{"type":"number","example":0.2,"description":"Margin to apply.","default":0.2,"minimum":0,"maximum":1,"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.margin","typeLabel":"number"},"browser":{"oneOf":[{"type":"string","description":"Browser to apply.","enum":["light","dark"],"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.browser.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Browser to apply.","enum":["light","dark"],"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.browser.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.browser","typeLabel":"enum\u003cstring> | null"},"screenshotBorderRadius":{"type":"number","example":0,"description":"The border radius, specified in CSS pixels, is applied to the screenshot only when the `device` option is not set.","default":0,"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.screenshotBorderRadius","typeLabel":"number"}},"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.overlay","typeLabel":"object | null"}},"uniqueKey":"variables.screenshot.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.screenshot.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot","typeLabel":"object | null"},"pdf":{"oneOf":[{"type":"object","properties":{"scale":{"type":"number","example":1,"description":"Scales the rendering of the web page. Amount must be between `0.1` and `2`.","minimum":0.1,"maximum":2,"default":1,"uniqueKey":"variables.pdf.oneOf.0.scale","typeLabel":"number"},"displayHeaderFooter":{"type":"boolean","example":false,"description":"Whether to show the header and footer.","default":false,"uniqueKey":"variables.pdf.oneOf.0.displayHeaderFooter","typeLabel":"boolean"},"headerHtml":{"oneOf":[{"type":"string","description":"HTML template for the print header. Should be valid HTML (base64 encoded) with the following classes used to inject values into them:\n- `date` formatted print date\n- `title` document title\n- `url` document location\n- `pageNumber` current page number\n- `totalPages` total pages in the document","uniqueKey":"variables.pdf.oneOf.0.headerHtml.oneOf.0","typeLabel":"string"},{"type":"null","description":"HTML template for the print header. Should be valid HTML (base64 encoded) with the following classes used to inject values into them:\n- `date` formatted print date\n- `title` document title\n- `url` document location\n- `pageNumber` current page number\n- `totalPages` total pages in the document","uniqueKey":"variables.pdf.oneOf.0.headerHtml.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.headerHtml","typeLabel":"string | null"},"footerHtml":{"oneOf":[{"type":"string","description":"HTML template for the print footer. Has the same constraints and support for special classes as `headerHtml`.","uniqueKey":"variables.pdf.oneOf.0.footerHtml.oneOf.0","typeLabel":"string"},{"type":"null","description":"HTML template for the print footer. Has the same constraints and support for special classes as `headerHtml`.","uniqueKey":"variables.pdf.oneOf.0.footerHtml.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.footerHtml","typeLabel":"string | null"},"printBackground":{"type":"boolean","example":false,"description":"Set to `true` to print background graphics.","default":false,"uniqueKey":"variables.pdf.oneOf.0.printBackground","typeLabel":"boolean"},"landscape":{"type":"boolean","example":false,"description":"Whether to print in landscape orientation.","default":false,"uniqueKey":"variables.pdf.oneOf.0.landscape","typeLabel":"boolean"},"pageRanges":{"oneOf":[{"type":"string","example":"1-5","description":"Paper ranges to print, e.g. `1-5, 8, 11-13`.","uniqueKey":"variables.pdf.oneOf.0.pageRanges.oneOf.0","typeLabel":"string"},{"type":"null","example":"1-5","description":"Paper ranges to print, e.g. `1-5, 8, 11-13`.","uniqueKey":"variables.pdf.oneOf.0.pageRanges.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.pageRanges","typeLabel":"string | null"},"format":{"type":"string","example":"letter","description":"If set, this takes priority over the `width` and `height` options.\n The sizes of each format are as follows:\n- `letter` 8.5in x 11in\n- `legal` 8.5in x 14in\n- `tabloid` 11in x 17in\n- `ledger` 17in x 11in\n- `a0` 33.1in x 46.8in\n- `a1` 23.4in x 33.1in\n- `a2` 16.54in x 23.4in\n- `a3` 11.7in x 16.54in\n- `a4` 8.27in x 11.7in\n- `a5` 5.83in x 8.27in\n- `a6` 4.13in x 5.83in","default":"letter","enum":["letter","legal","tabloid","ledger","a0","a1","a2","a3","a4","a5","a6"],"uniqueKey":"variables.pdf.oneOf.0.format","typeLabel":"enum\u003cstring>"},"width":{"oneOf":[{"type":"string","description":"Sets the width of paper. You can pass in a number or a string with a unit.","uniqueKey":"variables.pdf.oneOf.0.width.oneOf.0","typeLabel":"string"},{"type":"number","description":"Sets the width of paper. You can pass in a number or a string with a unit.","uniqueKey":"variables.pdf.oneOf.0.width.oneOf.1","typeLabel":"number"},{"type":"null","uniqueKey":"variables.pdf.oneOf.0.width.oneOf.2","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.width","typeLabel":"string | number | null"},"height":{"oneOf":[{"type":"string","description":"Sets the height of paper. You can pass in a number or a string with a unit.","uniqueKey":"variables.pdf.oneOf.0.height.oneOf.0","typeLabel":"string"},{"type":"number","description":"Sets the height of paper. You can pass in a number or a string with a unit.","uniqueKey":"variables.pdf.oneOf.0.height.oneOf.1","typeLabel":"number"},{"type":"null","uniqueKey":"variables.pdf.oneOf.0.height.oneOf.2","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.height","typeLabel":"string | number | null"},"preferCSSPageSize":{"type":"boolean","example":false,"description":"Give any CSS [@page](https://developer.mozilla.org/en-US/docs/Web/CSS/@page) size declared in the page priority over what is declared in the `width` or `height` or `format` option.","default":false,"uniqueKey":"variables.pdf.oneOf.0.preferCSSPageSize","typeLabel":"boolean"},"margin":{"oneOf":[{"type":"object","description":"Set the PDF margins.","properties":{"top":{"oneOf":[{"type":"string","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.top.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.top.oneOf.1","typeLabel":"number"},{"type":"null","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.top.oneOf.2","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.top","typeLabel":"string | number | null"},"bottom":{"oneOf":[{"type":"string","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.bottom.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.bottom.oneOf.1","typeLabel":"number"},{"type":"null","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.bottom.oneOf.2","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.bottom","typeLabel":"string | number | null"},"left":{"oneOf":[{"type":"string","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.left.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.left.oneOf.1","typeLabel":"number"},{"type":"null","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.left.oneOf.2","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.left","typeLabel":"string | number | null"},"right":{"oneOf":[{"type":"string","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.right.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.right.oneOf.1","typeLabel":"number"},{"type":"null","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.right.oneOf.2","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.right","typeLabel":"string | number | null"}},"uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.margin","typeLabel":"object | null"},"omitBackground":{"type":"boolean","example":false,"description":"Hides default white background and allows generating pdfs with transparency.","default":false,"uniqueKey":"variables.pdf.oneOf.0.omitBackground","typeLabel":"boolean"},"outline":{"type":"boolean","example":false,"description":"Generate document outline.\nIf this is enabled the PDF will also be tagged (accessible).","default":false,"uniqueKey":"variables.pdf.oneOf.0.outline","typeLabel":"boolean"},"tagged":{"type":"boolean","example":false,"description":"Generate tagged (accessible) PDF.\nThis is experimental and will increase the size of the PDF.","default":false,"uniqueKey":"variables.pdf.oneOf.0.tagged","typeLabel":"boolean"}},"uniqueKey":"variables.pdf.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.pdf.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.pdf","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"variables","typeLabel":"object"}},"required":["name","output","variables"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","variables":{"page":{"url":"\u003cstring>","html":"\u003cstring>","htmlTemplate":"\u003cstring>","templateData":{},"waitUntil":"auto","waitForMilliseconds":2500,"waitForSelector":{"selector":"\u003cstring>","options":{"visible":false,"hidden":false,"timeout":10000}},"waitForFunction":{"pageFunction":"window.innerWidth \u003c 100","options":{"polling":"raf","timeout":10000}},"headers":{"x-foo":"bar"},"adblock":true,"javascript":true,"cookies":[{"name":"\u003cstring>","value":"\u003cstring>","domain":"\u003cstring>","url":"\u003cstring>","path":"\u003cstring>","secure":true,"httpOnly":true,"expires":123}],"authentication":{"username":"\u003cstring>","password":"\u003cstring>"},"colorScheme":"\u003cstring>","timezone":"\u003cstring>"},"screenshot":{"type":"png","device":"Macbook Pro 16","viewport":{"width":2240,"height":1260,"deviceScaleFactor":1,"isMobile":false,"hasTouch":false,"isLandscape":false},"fullPage":false,"fromSurface":true,"omitBackground":false,"optimizeForSpeed":true,"quality":50,"captureBeyondViewport":false,"clip":{"width":2240,"height":1260,"x":123,"y":123,"scale":1},"element":"\u003cstring>","overlay":{"background":"\u003cstring>","filter":"none","margin":0.2,"screenshotBorderRadius":0}},"pdf":{"scale":1,"displayHeaderFooter":false,"headerHtml":"\u003cstring>","footerHtml":"\u003cstring>","printBackground":false,"landscape":false,"pageRanges":"1-5","format":"letter","width":"\u003cstring>","height":"\u003cstring>","preferCSSPageSize":false,"margin":{"top":"\u003cstring>","bottom":"\u003cstring>","left":"\u003cstring>","right":"\u003cstring>"},"omitBackground":false,"outline":false,"tagged":false}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"046093f0-46f5-4cb9-812b-d50470d7f08d":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the template.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","description":"The name of the template.","maxLength":200,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"output":{"type":"string","description":"The output format of the template.","enum":["PDF","IMAGE"],"isRequired":true,"uniqueKey":"output","typeLabel":"enum\u003cstring>"},"createdAt":{"format":"date-time","type":"string","description":"The date and time the template was created.","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"The date and time the template was last updated.","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"variables":{"type":"object","description":"The variables of the template.","required":["page"],"properties":{"page":{"type":"object","description":"Page options, either provide the `url`, `html` or `htmlTemplate` option.","properties":{"url":{"oneOf":[{"type":"string","description":"URL to go to. Should include the scheme, e.g. `https://`","uniqueKey":"variables.page.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL to go to. Should include the scheme, e.g. `https://`","uniqueKey":"variables.page.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.url","typeLabel":"string | null"},"html":{"oneOf":[{"type":"string","description":"HTML to render. Needs to be base64 encoded!","uniqueKey":"variables.page.html.oneOf.0","typeLabel":"string"},{"type":"null","description":"HTML to render. Needs to be base64 encoded!","uniqueKey":"variables.page.html.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.html","typeLabel":"string | null"},"htmlTemplate":{"oneOf":[{"type":"string","description":"HTML template to render, uses [Handlebars](https://handlebarsjs.com/) to render your HTML together with the provided `templateData`. Needs to be base64 encoded!","uniqueKey":"variables.page.htmlTemplate.oneOf.0","typeLabel":"string"},{"type":"null","description":"HTML template to render, uses [Handlebars](https://handlebarsjs.com/) to render your HTML together with the provided `templateData`. Needs to be base64 encoded!","uniqueKey":"variables.page.htmlTemplate.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.htmlTemplate","typeLabel":"string | null"},"templateData":{"oneOf":[{"type":"object","description":"Template data, only used in combination with `page.htmlTemplate`.","uniqueKey":"variables.page.templateData.oneOf.0","typeLabel":"object"},{"type":"null","description":"Template data, only used in combination with `page.htmlTemplate`.","uniqueKey":"variables.page.templateData.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.templateData","typeLabel":"object | null"},"waitUntil":{"type":"string","example":"auto","description":"When to consider waiting succeeds.\n- `auto` our smart waiting option that can handle 90% of the cases.\n- `load` waits for the 'load' event.\n- `domcontentloaded` waits for the 'DOMContentLoaded' event.\n- `networkidle0` waits till there are no more than 0 network connections for at least `500` ms.\n- `networkidle2` waits till there are no more than 2 network connections for at least `500` ms. ","enum":["auto","load","domcontentloaded","networkidle0","networkidle2"],"default":"auto","uniqueKey":"variables.page.waitUntil","typeLabel":"enum\u003cstring>"},"waitForMilliseconds":{"oneOf":[{"type":"number","description":"Wait for a certain amount of milliseconds before the request continues.","minimum":0,"maximum":5000,"uniqueKey":"variables.page.waitForMilliseconds.oneOf.0","typeLabel":"number"},{"type":"null","description":"Wait for a certain amount of milliseconds before the request continues.","minimum":0,"maximum":5000,"uniqueKey":"variables.page.waitForMilliseconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.waitForMilliseconds","typeLabel":"number | null"},"waitForSelector":{"oneOf":[{"type":"object","description":"Wait for the [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors) to appear in page. If the [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors) doesn't appear after the `timeout` milliseconds of waiting, the request will continue.","required":["selector"],"properties":{"selector":{"type":"string","description":"The [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors) of an element to wait for.","minLength":1,"maxLength":1024,"isRequired":true,"uniqueKey":"variables.page.waitForSelector.oneOf.0.selector","typeLabel":"string"},"options":{"oneOf":[{"type":"object","description":"Options for configuring waiting behavior.","properties":{"visible":{"type":"boolean","example":false,"description":"Wait for the selected element to be present in DOM and to be visibleAn element is considered to be visible if all of the following is true:\n- the element has [computed styles](https://developer.mozilla.org/en-US/docs/Web/API/Window/getComputedStyle)\n- the element has a non-empty [bounding client rect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect)\n- the element's [visibility](https://developer.mozilla.org/en-US/docs/Web/CSS/visibility) is not `hidden` or `collapse`","default":false,"uniqueKey":"variables.page.waitForSelector.oneOf.0.options.oneOf.0.visible","typeLabel":"boolean"},"hidden":{"type":"boolean","example":false,"description":"Wait for the selected element to not be found in the DOM or to be hidden.An element is considered to be hidden if at least one of the following is true:\n- the element has no [computed styles](https://developer.mozilla.org/en-US/docs/Web/API/Window/getComputedStyle)\n- the element has an empty [bounding client rect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect)\n- the element's [visibility](https://developer.mozilla.org/en-US/docs/Web/CSS/visibility) is `hidden` or `collapse`","default":false,"uniqueKey":"variables.page.waitForSelector.oneOf.0.options.oneOf.0.hidden","typeLabel":"boolean"},"timeout":{"type":"number","example":10000,"description":"Maximum time to wait in milliseconds.","minimum":1,"maximum":30000,"default":10000,"uniqueKey":"variables.page.waitForSelector.oneOf.0.options.oneOf.0.timeout","typeLabel":"number"}},"uniqueKey":"variables.page.waitForSelector.oneOf.0.options.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.page.waitForSelector.oneOf.0.options.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.waitForSelector.oneOf.0.options","typeLabel":"object | null"}},"uniqueKey":"variables.page.waitForSelector.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.page.waitForSelector.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.waitForSelector","typeLabel":"object | null"},"waitForFunction":{"oneOf":[{"type":"object","description":"Wait for the `pageFunction` to execute in the page. If the `pageFunction` doesn't execute successfully after the `timeout` milliseconds of waiting, the request will continue.","required":["pageFunction"],"properties":{"pageFunction":{"type":"string","example":"window.innerWidth \u003c 100","description":"Function to be evaluated in browser context until it returns a truthy value.","minLength":1,"maxLength":1024,"isRequired":true,"uniqueKey":"variables.page.waitForFunction.oneOf.0.pageFunction","typeLabel":"string"},"options":{"oneOf":[{"type":"object","description":"Options for configuring waiting behavior.","properties":{"polling":{"oneOf":[{"type":"string","description":"An interval at which the `pageFunction` is executed, defaults to `raf`. If `polling` is a number, then it is treated as an interval in milliseconds at which the function would be executed. If `polling` is a string, then it can be one of the following values:\n- `raf` to constantly execute `pageFunction` in `requestAnimationFrame` callback. This is the tightest polling mode which is suitable to observe styling changes.\n- `mutation` to execute `pageFunction` on every DOM mutation.","default":"raf","enum":["raf","mutation"],"example":"raf","uniqueKey":"variables.page.waitForFunction.oneOf.0.options.oneOf.0.polling.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"number","description":"An interval at which the `pageFunction` is executed, defaults to `raf`. If `polling` is a number, then it is treated as an interval in milliseconds at which the function would be executed. If `polling` is a string, then it can be one of the following values:\n- `raf` to constantly execute `pageFunction` in `requestAnimationFrame` callback. This is the tightest polling mode which is suitable to observe styling changes.\n- `mutation` to execute `pageFunction` on every DOM mutation.","default":"raf","example":"raf","uniqueKey":"variables.page.waitForFunction.oneOf.0.options.oneOf.0.polling.oneOf.1","typeLabel":"number"}],"uniqueKey":"variables.page.waitForFunction.oneOf.0.options.oneOf.0.polling","typeLabel":"enum\u003cstring> | number"},"timeout":{"type":"number","example":10000,"description":"Maximum time to wait in milliseconds.","minimum":1,"maximum":30000,"default":10000,"uniqueKey":"variables.page.waitForFunction.oneOf.0.options.oneOf.0.timeout","typeLabel":"number"}},"uniqueKey":"variables.page.waitForFunction.oneOf.0.options.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.page.waitForFunction.oneOf.0.options.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.waitForFunction.oneOf.0.options","typeLabel":"object | null"}},"uniqueKey":"variables.page.waitForFunction.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.page.waitForFunction.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.waitForFunction","typeLabel":"object | null"},"headers":{"oneOf":[{"type":"object","example":{"x-foo":"bar"},"description":"An object containing additional HTTP headers to be sent with every request. All header values must be strings.","uniqueKey":"variables.page.headers.oneOf.0","typeLabel":"object"},{"type":"null","example":{"x-foo":"bar"},"description":"An object containing additional HTTP headers to be sent with every request. All header values must be strings.","uniqueKey":"variables.page.headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.headers","typeLabel":"object | null"},"adblock":{"type":"boolean","example":true,"description":"Use our build-in adblocker.","default":true,"uniqueKey":"variables.page.adblock","typeLabel":"boolean"},"javascript":{"type":"boolean","example":true,"description":"Whether or not to enable JavaScript on the page.","default":true,"uniqueKey":"variables.page.javascript","typeLabel":"boolean"},"cookies":{"oneOf":[{"description":"Cookies added to the page, Also accepted as string inside `headers.cookie`.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Cookie name.","minLength":1,"maxLength":1024,"isRequired":true,"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","description":"Cookie value.","minLength":1,"maxLength":4096,"isRequired":true,"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].value","typeLabel":"string"},"domain":{"type":"string","description":"Cookie domain.","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].domain","typeLabel":"string"},"url":{"oneOf":[{"type":"string","description":"The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie. Should include the scheme, e.g. `https://`","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie. Should include the scheme, e.g. `https://`","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].url.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].url","typeLabel":"string | null"},"path":{"oneOf":[{"type":"string","description":"Cookie path.","minLength":1,"maxLength":512,"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].path.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cookie path.","minLength":1,"maxLength":512,"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].path.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].path","typeLabel":"string | null"},"secure":{"oneOf":[{"type":"boolean","description":"`true` if cookie is secure.","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].secure.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"`true` if cookie is secure.","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].secure.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].secure","typeLabel":"boolean | null"},"httpOnly":{"oneOf":[{"type":"boolean","description":"`true` if cookie is http-only.","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].httpOnly.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"`true` if cookie is http-only.","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].httpOnly.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].httpOnly","typeLabel":"boolean | null"},"sameSite":{"oneOf":[{"type":"string","description":"Cookie SameSite type.","enum":["Strict","Lax","None"],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].sameSite.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Cookie SameSite type.","enum":["Strict","Lax","None"],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].sameSite.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].sameSite","typeLabel":"enum\u003cstring> | null"},"expires":{"oneOf":[{"type":"number","description":"Cookie expiration date (UTC time in seconds, counted from January 1, 1970.), session cookie if not set. ","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].expires.oneOf.0","typeLabel":"number"},{"type":"null","description":"Cookie expiration date (UTC time in seconds, counted from January 1, 1970.), session cookie if not set. ","uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].expires.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX].expires","typeLabel":"number | null"}},"required":["name","value","domain"],"uniqueKey":"variables.page.cookies.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"variables.page.cookies.oneOf.0","typeLabel":"object[]"},{"description":"Cookies added to the page, Also accepted as string inside `headers.cookie`.","type":"null","items":{"type":"object","properties":{"name":{"type":"string","description":"Cookie name.","minLength":1,"maxLength":1024},"value":{"type":"string","description":"Cookie value.","minLength":1,"maxLength":4096},"domain":{"type":"string","description":"Cookie domain.","minLength":1,"maxLength":512},"url":{"oneOf":[{"type":"string","description":"The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie. Should include the scheme, e.g. `https://`"},{"type":"null","description":"The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie. Should include the scheme, e.g. `https://`"}]},"path":{"oneOf":[{"type":"string","description":"Cookie path.","minLength":1,"maxLength":512},{"type":"null","description":"Cookie path.","minLength":1,"maxLength":512}]},"secure":{"oneOf":[{"type":"boolean","description":"`true` if cookie is secure."},{"type":"null","description":"`true` if cookie is secure."}]},"httpOnly":{"oneOf":[{"type":"boolean","description":"`true` if cookie is http-only."},{"type":"null","description":"`true` if cookie is http-only."}]},"sameSite":{"oneOf":[{"type":"string","description":"Cookie SameSite type.","enum":["Strict","Lax","None"]},{"type":"null","description":"Cookie SameSite type.","enum":["Strict","Lax","None"]}]},"expires":{"oneOf":[{"type":"number","description":"Cookie expiration date (UTC time in seconds, counted from January 1, 1970.), session cookie if not set. "},{"type":"null","description":"Cookie expiration date (UTC time in seconds, counted from January 1, 1970.), session cookie if not set. "}]}},"required":["name","value","domain"]},"uniqueKey":"variables.page.cookies.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.cookies","typeLabel":"object[] | null"},"authentication":{"oneOf":[{"type":"object","description":"Provide credentials for `HTTP authentication`.","required":["username","password"],"properties":{"username":{"type":"string","minLength":1,"maxLength":1024,"isRequired":true,"uniqueKey":"variables.page.authentication.oneOf.0.username","typeLabel":"string"},"password":{"type":"string","minLength":1,"maxLength":4096,"isRequired":true,"uniqueKey":"variables.page.authentication.oneOf.0.password","typeLabel":"string"}},"uniqueKey":"variables.page.authentication.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.page.authentication.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.authentication","typeLabel":"object | null"},"colorScheme":{"oneOf":[{"type":"string","description":"Color-scheme to set on the page.","maxLength":20,"uniqueKey":"variables.page.colorScheme.oneOf.0","typeLabel":"string"},{"type":"null","description":"Color-scheme to set on the page.","maxLength":20,"uniqueKey":"variables.page.colorScheme.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.colorScheme","typeLabel":"string | null"},"mediaType":{"oneOf":[{"type":"string","description":"Changes the CSS media type of the page.","enum":["screen","print"],"uniqueKey":"variables.page.mediaType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Changes the CSS media type of the page.","enum":["screen","print"],"uniqueKey":"variables.page.mediaType.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.mediaType","typeLabel":"enum\u003cstring> | null"},"timezone":{"oneOf":[{"type":"string","description":"Changes the timezone of the page. See [ICU’s metaZones.txt](https://source.chromium.org/chromium/chromium/deps/icu.git/+/faee8bc70570192d82d2978a71e2a615788597d1:source/data/misc/metaZones.txt) for a list of supported timezone IDs.","uniqueKey":"variables.page.timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Changes the timezone of the page. See [ICU’s metaZones.txt](https://source.chromium.org/chromium/chromium/deps/icu.git/+/faee8bc70570192d82d2978a71e2a615788597d1:source/data/misc/metaZones.txt) for a list of supported timezone IDs.","uniqueKey":"variables.page.timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.page.timezone","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"variables.page","typeLabel":"object"},"screenshot":{"oneOf":[{"type":"object","properties":{"type":{"oneOf":[{"type":"string","example":"png","enum":["png","jpeg","webp"],"default":"png","uniqueKey":"variables.screenshot.oneOf.0.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"png","enum":["png","jpeg","webp"],"default":"png","uniqueKey":"variables.screenshot.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.type","typeLabel":"enum\u003cstring> | null"},"device":{"oneOf":[{"type":"string","example":"Macbook Pro 16","description":"Device preset to use, will not be set when `viewport` option is provided!","enum":["Blackberry PlayBook","Blackberry PlayBook landscape","BlackBerry Z30","BlackBerry Z30 landscape","Galaxy Note 3","Galaxy Note 3 landscape","Galaxy Note II","Galaxy Note II landscape","Galaxy S III","Galaxy S III landscape","Galaxy S5","Galaxy S5 landscape","Galaxy S8","Galaxy S8 landscape","Galaxy S9+","Galaxy S9+ landscape","Galaxy Tab S4","Galaxy Tab S4 landscape","iPad","iPad landscape","iPad (gen 6)","iPad (gen 6) landscape","iPad (gen 7)","iPad (gen 7) landscape","iPad Mini","iPad Mini landscape","iPad Pro","iPad Pro landscape","iPad Pro 11","iPad Pro 11 landscape","iPhone 4","iPhone 4 landscape","iPhone 5","iPhone 5 landscape","iPhone 6","iPhone 6 landscape","iPhone 6 Plus","iPhone 6 Plus landscape","iPhone 7","iPhone 7 landscape","iPhone 7 Plus","iPhone 7 Plus landscape","iPhone 8","iPhone 8 landscape","iPhone 8 Plus","iPhone 8 Plus landscape","iPhone SE","iPhone SE landscape","iPhone X","iPhone X landscape","iPhone XR","iPhone XR landscape","iPhone 11","iPhone 11 landscape","iPhone 11 Pro","iPhone 11 Pro landscape","iPhone 11 Pro Max","iPhone 11 Pro Max landscape","iPhone 12","iPhone 12 landscape","iPhone 12 Pro","iPhone 12 Pro landscape","iPhone 12 Pro Max","iPhone 12 Pro Max landscape","iPhone 12 Mini","iPhone 12 Mini landscape","iPhone 13","iPhone 13 landscape","iPhone 13 Pro","iPhone 13 Pro landscape","iPhone 13 Pro Max","iPhone 13 Pro Max landscape","iPhone 13 Mini","iPhone 13 Mini landscape","iPhone 14","iPhone 14 landscape","iPhone 14 Plus","iPhone 14 Plus landscape","iPhone 14 Pro","iPhone 14 Pro landscape","iPhone 14 Pro Max","iPhone 14 Pro Max landscape","iPhone 15","iPhone 15 landscape","iPhone 15 Plus","iPhone 15 Plus landscape","iPhone 15 Pro","iPhone 15 Pro landscape","iPhone 15 Pro Max","iPhone 15 Pro Max landscape","JioPhone 2","JioPhone 2 landscape","Kindle Fire HDX","Kindle Fire HDX landscape","LG Optimus L70","LG Optimus L70 landscape","Microsoft Lumia 550","Microsoft Lumia 950","Microsoft Lumia 950 landscape","Nexus 10","Nexus 10 landscape","Nexus 4","Nexus 4 landscape","Nexus 5","Nexus 5 landscape","Nexus 5X","Nexus 5X landscape","Nexus 6","Nexus 6 landscape","Nexus 6P","Nexus 6P landscape","Nexus 7","Nexus 7 landscape","Nokia Lumia 520","Nokia Lumia 520 landscape","Nokia N9","Nokia N9 landscape","Pixel 2","Pixel 2 landscape","Pixel 2 XL","Pixel 2 XL landscape","Pixel 3","Pixel 3 landscape","Pixel 4","Pixel 4 landscape","Pixel 4a (5G)","Pixel 4a (5G) landscape","Pixel 5","Pixel 5 landscape","Moto G4","Moto G4 landscape","Macbook Pro 13","Macbook Pro 15","Macbook Pro 16","iMac 21","iMac 21 4K","iMac 24 4.5K","iMac 27","iMac 27 5K"],"default":"Macbook Pro 16","uniqueKey":"variables.screenshot.oneOf.0.device.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"Macbook Pro 16","description":"Device preset to use, will not be set when `viewport` option is provided!","enum":["Blackberry PlayBook","Blackberry PlayBook landscape","BlackBerry Z30","BlackBerry Z30 landscape","Galaxy Note 3","Galaxy Note 3 landscape","Galaxy Note II","Galaxy Note II landscape","Galaxy S III","Galaxy S III landscape","Galaxy S5","Galaxy S5 landscape","Galaxy S8","Galaxy S8 landscape","Galaxy S9+","Galaxy S9+ landscape","Galaxy Tab S4","Galaxy Tab S4 landscape","iPad","iPad landscape","iPad (gen 6)","iPad (gen 6) landscape","iPad (gen 7)","iPad (gen 7) landscape","iPad Mini","iPad Mini landscape","iPad Pro","iPad Pro landscape","iPad Pro 11","iPad Pro 11 landscape","iPhone 4","iPhone 4 landscape","iPhone 5","iPhone 5 landscape","iPhone 6","iPhone 6 landscape","iPhone 6 Plus","iPhone 6 Plus landscape","iPhone 7","iPhone 7 landscape","iPhone 7 Plus","iPhone 7 Plus landscape","iPhone 8","iPhone 8 landscape","iPhone 8 Plus","iPhone 8 Plus landscape","iPhone SE","iPhone SE landscape","iPhone X","iPhone X landscape","iPhone XR","iPhone XR landscape","iPhone 11","iPhone 11 landscape","iPhone 11 Pro","iPhone 11 Pro landscape","iPhone 11 Pro Max","iPhone 11 Pro Max landscape","iPhone 12","iPhone 12 landscape","iPhone 12 Pro","iPhone 12 Pro landscape","iPhone 12 Pro Max","iPhone 12 Pro Max landscape","iPhone 12 Mini","iPhone 12 Mini landscape","iPhone 13","iPhone 13 landscape","iPhone 13 Pro","iPhone 13 Pro landscape","iPhone 13 Pro Max","iPhone 13 Pro Max landscape","iPhone 13 Mini","iPhone 13 Mini landscape","iPhone 14","iPhone 14 landscape","iPhone 14 Plus","iPhone 14 Plus landscape","iPhone 14 Pro","iPhone 14 Pro landscape","iPhone 14 Pro Max","iPhone 14 Pro Max landscape","iPhone 15","iPhone 15 landscape","iPhone 15 Plus","iPhone 15 Plus landscape","iPhone 15 Pro","iPhone 15 Pro landscape","iPhone 15 Pro Max","iPhone 15 Pro Max landscape","JioPhone 2","JioPhone 2 landscape","Kindle Fire HDX","Kindle Fire HDX landscape","LG Optimus L70","LG Optimus L70 landscape","Microsoft Lumia 550","Microsoft Lumia 950","Microsoft Lumia 950 landscape","Nexus 10","Nexus 10 landscape","Nexus 4","Nexus 4 landscape","Nexus 5","Nexus 5 landscape","Nexus 5X","Nexus 5X landscape","Nexus 6","Nexus 6 landscape","Nexus 6P","Nexus 6P landscape","Nexus 7","Nexus 7 landscape","Nokia Lumia 520","Nokia Lumia 520 landscape","Nokia N9","Nokia N9 landscape","Pixel 2","Pixel 2 landscape","Pixel 2 XL","Pixel 2 XL landscape","Pixel 3","Pixel 3 landscape","Pixel 4","Pixel 4 landscape","Pixel 4a (5G)","Pixel 4a (5G) landscape","Pixel 5","Pixel 5 landscape","Moto G4","Moto G4 landscape","Macbook Pro 13","Macbook Pro 15","Macbook Pro 16","iMac 21","iMac 21 4K","iMac 24 4.5K","iMac 27","iMac 27 5K"],"default":"Macbook Pro 16","uniqueKey":"variables.screenshot.oneOf.0.device.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.device","typeLabel":"enum\u003cstring> | null"},"viewport":{"oneOf":[{"type":"object","description":"Define an custom viewport, when defined the `device` option will be ignored!","required":["width","height"],"properties":{"width":{"type":"number","description":"The page width in CSS pixels.","minimum":0,"maximum":4480,"isRequired":true,"uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.0.width","typeLabel":"number"},"height":{"type":"number","description":"The page height in CSS pixels.","minimum":0,"maximum":2520,"isRequired":true,"uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.0.height","typeLabel":"number"},"deviceScaleFactor":{"type":"number","example":1,"description":"Specify device scale factor. See [devicePixelRatio](https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio) for more info.","default":1,"minimum":1,"maximum":3,"uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.0.deviceScaleFactor","typeLabel":"number"},"isMobile":{"type":"boolean","example":false,"description":"Whether the `meta viewport` tag is taken into account.","default":false,"uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.0.isMobile","typeLabel":"boolean"},"hasTouch":{"type":"boolean","example":false,"description":"Specify if the viewport supports touch events.","default":false,"uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.0.hasTouch","typeLabel":"boolean"},"isLandscape":{"type":"boolean","example":false,"description":"Specifies if the viewport is in landscape mode.","default":false,"uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.0.isLandscape","typeLabel":"boolean"}},"uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.screenshot.oneOf.0.viewport.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.viewport","typeLabel":"object | null"},"fullPage":{"type":"boolean","example":false,"description":"When `true`, takes a screenshot of the full page.","default":false,"uniqueKey":"variables.screenshot.oneOf.0.fullPage","typeLabel":"boolean"},"fromSurface":{"type":"boolean","example":true,"description":"Capture the screenshot from the surface, rather than the view.","default":true,"uniqueKey":"variables.screenshot.oneOf.0.fromSurface","typeLabel":"boolean"},"omitBackground":{"type":"boolean","example":false,"description":"Hides default white background and allows capturing screenshots with transparency.","default":false,"uniqueKey":"variables.screenshot.oneOf.0.omitBackground","typeLabel":"boolean"},"optimizeForSpeed":{"type":"boolean","example":true,"default":true,"uniqueKey":"variables.screenshot.oneOf.0.optimizeForSpeed","typeLabel":"boolean"},"quality":{"oneOf":[{"type":"number","description":"Quality of the image, between 0-100. Not applicable to `png` images.","minimum":0,"maximum":100,"uniqueKey":"variables.screenshot.oneOf.0.quality.oneOf.0","typeLabel":"number"},{"type":"null","description":"Quality of the image, between 0-100. Not applicable to `png` images.","minimum":0,"maximum":100,"uniqueKey":"variables.screenshot.oneOf.0.quality.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.quality","typeLabel":"number | null"},"captureBeyondViewport":{"type":"boolean","example":false,"description":"Capture the screenshot beyond the viewport. `false` if there is no `clip`. `true` otherwise.","default":false,"uniqueKey":"variables.screenshot.oneOf.0.captureBeyondViewport","typeLabel":"boolean"},"clip":{"oneOf":[{"type":"object","description":"Specifies the region of the page to clip.","required":["width","height","x","y"],"properties":{"width":{"type":"number","description":"The width of the element in pixels.","minimum":0,"maximum":4480,"isRequired":true,"uniqueKey":"variables.screenshot.oneOf.0.clip.oneOf.0.width","typeLabel":"number"},"height":{"type":"number","description":"The height of the element in pixels.","minimum":0,"maximum":2520,"isRequired":true,"uniqueKey":"variables.screenshot.oneOf.0.clip.oneOf.0.height","typeLabel":"number"},"x":{"type":"number","isRequired":true,"uniqueKey":"variables.screenshot.oneOf.0.clip.oneOf.0.x","typeLabel":"number"},"y":{"type":"number","isRequired":true,"uniqueKey":"variables.screenshot.oneOf.0.clip.oneOf.0.y","typeLabel":"number"},"scale":{"type":"number","example":1,"default":1,"minimum":0,"uniqueKey":"variables.screenshot.oneOf.0.clip.oneOf.0.scale","typeLabel":"number"}},"uniqueKey":"variables.screenshot.oneOf.0.clip.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.screenshot.oneOf.0.clip.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.clip","typeLabel":"object | null"},"element":{"oneOf":[{"type":"string","description":"It captures the DOM element matching the given CSS [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors). This will overwrite the `clip` property and set `fullPage` to `false`. Will wait for the element to become visible for a maximum of 15 seconds.","uniqueKey":"variables.screenshot.oneOf.0.element.oneOf.0","typeLabel":"string"},{"type":"null","description":"It captures the DOM element matching the given CSS [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors). This will overwrite the `clip` property and set `fullPage` to `false`. Will wait for the element to become visible for a maximum of 15 seconds.","uniqueKey":"variables.screenshot.oneOf.0.element.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.element","typeLabel":"string | null"},"overlay":{"oneOf":[{"type":"object","description":"Add an overlay to the image. Cannot be used together with the `fullPage` option!","properties":{"background":{"oneOf":[{"type":"string","description":"Color to apply as background, can be an an hexadecimal/rgb/rgba color code or CSS gradient.","uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.background.oneOf.0","typeLabel":"string"},{"type":"null","description":"Color to apply as background, can be an an hexadecimal/rgb/rgba color code or CSS gradient.","uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.background","typeLabel":"string | null"},"filter":{"oneOf":[{"type":"string","example":"none","description":"Apply [CSS Filter](https://developer.mozilla.org/en-US/docs/Web/CSS/filter) to background.","default":"none","uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.filter.oneOf.0","typeLabel":"string"},{"type":"null","example":"none","description":"Apply [CSS Filter](https://developer.mozilla.org/en-US/docs/Web/CSS/filter) to background.","default":"none","uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.filter.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.filter","typeLabel":"string | null"},"margin":{"type":"number","example":0.2,"description":"Margin to apply.","default":0.2,"minimum":0,"maximum":1,"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.margin","typeLabel":"number"},"browser":{"oneOf":[{"type":"string","description":"Browser to apply.","enum":["light","dark"],"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.browser.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Browser to apply.","enum":["light","dark"],"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.browser.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.browser","typeLabel":"enum\u003cstring> | null"},"screenshotBorderRadius":{"type":"number","example":0,"description":"The border radius, specified in CSS pixels, is applied to the screenshot only when the `device` option is not set.","default":0,"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0.screenshotBorderRadius","typeLabel":"number"}},"uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.screenshot.oneOf.0.overlay.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot.oneOf.0.overlay","typeLabel":"object | null"}},"uniqueKey":"variables.screenshot.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.screenshot.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.screenshot","typeLabel":"object | null"},"pdf":{"oneOf":[{"type":"object","properties":{"scale":{"type":"number","example":1,"description":"Scales the rendering of the web page. Amount must be between `0.1` and `2`.","minimum":0.1,"maximum":2,"default":1,"uniqueKey":"variables.pdf.oneOf.0.scale","typeLabel":"number"},"displayHeaderFooter":{"type":"boolean","example":false,"description":"Whether to show the header and footer.","default":false,"uniqueKey":"variables.pdf.oneOf.0.displayHeaderFooter","typeLabel":"boolean"},"headerHtml":{"oneOf":[{"type":"string","description":"HTML template for the print header. Should be valid HTML (base64 encoded) with the following classes used to inject values into them:\n- `date` formatted print date\n- `title` document title\n- `url` document location\n- `pageNumber` current page number\n- `totalPages` total pages in the document","uniqueKey":"variables.pdf.oneOf.0.headerHtml.oneOf.0","typeLabel":"string"},{"type":"null","description":"HTML template for the print header. Should be valid HTML (base64 encoded) with the following classes used to inject values into them:\n- `date` formatted print date\n- `title` document title\n- `url` document location\n- `pageNumber` current page number\n- `totalPages` total pages in the document","uniqueKey":"variables.pdf.oneOf.0.headerHtml.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.headerHtml","typeLabel":"string | null"},"footerHtml":{"oneOf":[{"type":"string","description":"HTML template for the print footer. Has the same constraints and support for special classes as `headerHtml`.","uniqueKey":"variables.pdf.oneOf.0.footerHtml.oneOf.0","typeLabel":"string"},{"type":"null","description":"HTML template for the print footer. Has the same constraints and support for special classes as `headerHtml`.","uniqueKey":"variables.pdf.oneOf.0.footerHtml.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.footerHtml","typeLabel":"string | null"},"printBackground":{"type":"boolean","example":false,"description":"Set to `true` to print background graphics.","default":false,"uniqueKey":"variables.pdf.oneOf.0.printBackground","typeLabel":"boolean"},"landscape":{"type":"boolean","example":false,"description":"Whether to print in landscape orientation.","default":false,"uniqueKey":"variables.pdf.oneOf.0.landscape","typeLabel":"boolean"},"pageRanges":{"oneOf":[{"type":"string","example":"1-5","description":"Paper ranges to print, e.g. `1-5, 8, 11-13`.","uniqueKey":"variables.pdf.oneOf.0.pageRanges.oneOf.0","typeLabel":"string"},{"type":"null","example":"1-5","description":"Paper ranges to print, e.g. `1-5, 8, 11-13`.","uniqueKey":"variables.pdf.oneOf.0.pageRanges.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.pageRanges","typeLabel":"string | null"},"format":{"type":"string","example":"letter","description":"If set, this takes priority over the `width` and `height` options.\n The sizes of each format are as follows:\n- `letter` 8.5in x 11in\n- `legal` 8.5in x 14in\n- `tabloid` 11in x 17in\n- `ledger` 17in x 11in\n- `a0` 33.1in x 46.8in\n- `a1` 23.4in x 33.1in\n- `a2` 16.54in x 23.4in\n- `a3` 11.7in x 16.54in\n- `a4` 8.27in x 11.7in\n- `a5` 5.83in x 8.27in\n- `a6` 4.13in x 5.83in","default":"letter","enum":["letter","legal","tabloid","ledger","a0","a1","a2","a3","a4","a5","a6"],"uniqueKey":"variables.pdf.oneOf.0.format","typeLabel":"enum\u003cstring>"},"width":{"oneOf":[{"type":"string","description":"Sets the width of paper. You can pass in a number or a string with a unit.","uniqueKey":"variables.pdf.oneOf.0.width.oneOf.0","typeLabel":"string"},{"type":"number","description":"Sets the width of paper. You can pass in a number or a string with a unit.","uniqueKey":"variables.pdf.oneOf.0.width.oneOf.1","typeLabel":"number"},{"type":"null","uniqueKey":"variables.pdf.oneOf.0.width.oneOf.2","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.width","typeLabel":"string | number | null"},"height":{"oneOf":[{"type":"string","description":"Sets the height of paper. You can pass in a number or a string with a unit.","uniqueKey":"variables.pdf.oneOf.0.height.oneOf.0","typeLabel":"string"},{"type":"number","description":"Sets the height of paper. You can pass in a number or a string with a unit.","uniqueKey":"variables.pdf.oneOf.0.height.oneOf.1","typeLabel":"number"},{"type":"null","uniqueKey":"variables.pdf.oneOf.0.height.oneOf.2","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.height","typeLabel":"string | number | null"},"preferCSSPageSize":{"type":"boolean","example":false,"description":"Give any CSS [@page](https://developer.mozilla.org/en-US/docs/Web/CSS/@page) size declared in the page priority over what is declared in the `width` or `height` or `format` option.","default":false,"uniqueKey":"variables.pdf.oneOf.0.preferCSSPageSize","typeLabel":"boolean"},"margin":{"oneOf":[{"type":"object","description":"Set the PDF margins.","properties":{"top":{"oneOf":[{"type":"string","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.top.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.top.oneOf.1","typeLabel":"number"},{"type":"null","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.top.oneOf.2","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.top","typeLabel":"string | number | null"},"bottom":{"oneOf":[{"type":"string","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.bottom.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.bottom.oneOf.1","typeLabel":"number"},{"type":"null","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.bottom.oneOf.2","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.bottom","typeLabel":"string | number | null"},"left":{"oneOf":[{"type":"string","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.left.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.left.oneOf.1","typeLabel":"number"},{"type":"null","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.left.oneOf.2","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.left","typeLabel":"string | number | null"},"right":{"oneOf":[{"type":"string","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.right.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.right.oneOf.1","typeLabel":"number"},{"type":"null","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.right.oneOf.2","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0.right","typeLabel":"string | number | null"}},"uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.pdf.oneOf.0.margin.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.pdf.oneOf.0.margin","typeLabel":"object | null"},"omitBackground":{"type":"boolean","example":false,"description":"Hides default white background and allows generating pdfs with transparency.","default":false,"uniqueKey":"variables.pdf.oneOf.0.omitBackground","typeLabel":"boolean"},"outline":{"type":"boolean","example":false,"description":"Generate document outline.\nIf this is enabled the PDF will also be tagged (accessible).","default":false,"uniqueKey":"variables.pdf.oneOf.0.outline","typeLabel":"boolean"},"tagged":{"type":"boolean","example":false,"description":"Generate tagged (accessible) PDF.\nThis is experimental and will increase the size of the PDF.","default":false,"uniqueKey":"variables.pdf.oneOf.0.tagged","typeLabel":"boolean"}},"uniqueKey":"variables.pdf.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"variables.pdf.oneOf.1","typeLabel":"null"}],"uniqueKey":"variables.pdf","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"variables","typeLabel":"object"}},"required":["id","name","output","createdAt","updatedAt","variables"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","output":"PDF","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","variables":{"page":{"url":"\u003cstring>","html":"\u003cstring>","htmlTemplate":"\u003cstring>","templateData":{},"waitUntil":"auto","waitForMilliseconds":2500,"waitForSelector":{"selector":"\u003cstring>","options":{"visible":false,"hidden":false,"timeout":10000}},"waitForFunction":{"pageFunction":"window.innerWidth \u003c 100","options":{"polling":"raf","timeout":10000}},"headers":{"x-foo":"bar"},"adblock":true,"javascript":true,"cookies":[{"name":"\u003cstring>","value":"\u003cstring>","domain":"\u003cstring>","url":"\u003cstring>","path":"\u003cstring>","secure":true,"httpOnly":true,"sameSite":"Strict","expires":123}],"authentication":{"username":"\u003cstring>","password":"\u003cstring>"},"colorScheme":"\u003cstring>","mediaType":"screen","timezone":"\u003cstring>"},"screenshot":{"type":"png","device":"Macbook Pro 16","viewport":{"width":2240,"height":1260,"deviceScaleFactor":1,"isMobile":false,"hasTouch":false,"isLandscape":false},"fullPage":false,"fromSurface":true,"omitBackground":false,"optimizeForSpeed":true,"quality":50,"captureBeyondViewport":false,"clip":{"width":2240,"height":1260,"x":123,"y":123,"scale":1},"element":"\u003cstring>","overlay":{"background":"\u003cstring>","filter":"none","margin":0.2,"browser":"light","screenshotBorderRadius":0}},"pdf":{"scale":1,"displayHeaderFooter":false,"headerHtml":"\u003cstring>","footerHtml":"\u003cstring>","printBackground":false,"landscape":false,"pageRanges":"1-5","format":"letter","width":"\u003cstring>","height":"\u003cstring>","preferCSSPageSize":false,"margin":{"top":"\u003cstring>","bottom":"\u003cstring>","left":"\u003cstring>","right":"\u003cstring>"},"omitBackground":false,"outline":false,"tagged":false}}}}},"exampleType":"generated"}},"exampleType":"generated"},"68bf7bb9-6d69-4627-916e-072882b9abf8":{"description":"Validations failed!","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Validations failed!","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","example":"api.validation","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"fields.additionalProperties","typeLabel":"string"},"example":{"page.url":"must be a URL address"},"isRequired":true,"uniqueKey":"fields","typeLabel":"object"}},"required":["message","code","fields"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Validations failed!","code":"api.validation","fields":{"page.url":"must be a URL address"}}}},"exampleType":"generated"}},"exampleType":"generated"},"3a1620d2-f125-40a8-adc9-e120c9e24773":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unauthorized","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"},"7989bb9a-2cc9-4c05-9356-c9daa8b36a06":{"description":"Reached subscription limit!","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Reached subscription limit!","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Reached subscription limit!"}}},"exampleType":"generated"}},"exampleType":"generated"},"a0d3c967-a361-4b32-826e-6dacbbaed0e4":{"description":"Token has no active subscription!","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Token has no active subscription!","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Token has no active subscription!"}}},"exampleType":"generated"}},"exampleType":"generated"},"036067a0-a435-428b-b808-5acd8c34ea7f":{"description":"Request body is too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Request body is too large","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Request body is too large"}}},"exampleType":"generated"}},"exampleType":"generated"},"cdbe2e90-bdae-4813-836a-b31a42cfd14e":{"description":"Too Many Requests!","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Too Many Requests!","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Too Many Requests!"}}},"exampleType":"generated"}},"exampleType":"generated"},"9fba3f74-a349-4cc3-b4e9-e654960323f5":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Internal server error","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Internal server error"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ae9b3245-4023-4092-86fe-513691b285df":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[]}}},"servers":{"57ffd971-71ce-487f-843d-609a50a44134":{"url":"https://api.doczilla.app","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"doczilla","siteName":"Doczilla","title":"Create new Template - Doczilla","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T23:53:07.618Z","originalFileLocation":"api-reference/endpoint/create-template.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create one template.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Doczilla\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/doczilla/csfu4QMhBrjo3cxh/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/doczilla/csfu4QMhBrjo3cxh/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/doczilla/csfu4QMhBrjo3cxh/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/doczilla/csfu4QMhBrjo3cxh/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/doczilla/csfu4QMhBrjo3cxh/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/doczilla/csfu4QMhBrjo3cxh/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/doczilla/csfu4QMhBrjo3cxh/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/doczilla/csfu4QMhBrjo3cxh/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/doczilla/csfu4QMhBrjo3cxh/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create new Template - Doczilla\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create one template.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Doczilla\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.doczilla.app/api-reference/endpoint/create-template\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://doczilla.mintlify.app/_mintlify/api/og/v2?division=Manage+Templates\u0026amp;title=Create+new+Template\u0026amp;description=Create+one+template.\u0026amp;theme=30ce5dc97ebef1a375a0ea5f\u0026amp;signature=3342f0682288a4de53273e6324a71ab1b83d07229cf1f8572dc6df2058df324d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create new Template - Doczilla\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create one template.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://doczilla.mintlify.app/_mintlify/api/og/v2?division=Manage+Templates\u0026amp;title=Create+new+Template\u0026amp;description=Create+one+template.\u0026amp;theme=30ce5dc97ebef1a375a0ea5f\u0026amp;signature=3342f0682288a4de53273e6324a71ab1b83d07229cf1f8572dc6df2058df324d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/doczilla/csfu4QMhBrjo3cxh/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Doczilla\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#17E286\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.doczilla.app/api-reference/endpoint/create-template\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/create-template.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.doczilla.app/#organization\",\"name\":\"Doczilla\",\"url\":\"https://docs.doczilla.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/doczilla/yA67lL7oehM3XiOm/images/logo.svg?fit=max\u0026auto=format\u0026n=yA67lL7oehM3XiOm\u0026q=85\u0026s=29829af5c66efb627f6a2394dd7e4fcc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.doczilla.app#website\",\"name\":\"Doczilla\",\"url\":\"https://docs.doczilla.app\",\"publisher\":{\"@id\":\"https://docs.doczilla.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.doczilla.app/api-reference/endpoint/create-template#webpage\",\"url\":\"https://docs.doczilla.app/api-reference/endpoint/create-template\",\"name\":\"Create new Template\",\"description\":\"Create one template.\",\"dateModified\":\"2026-01-06T23:53:07.618Z\",\"isPartOf\":{\"@id\":\"https://docs.doczilla.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.doczilla.app/api-reference/endpoint/create-template#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.doczilla.app/api-reference/endpoint/create-template#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Manage Templates\",\"item\":\"https://docs.doczilla.app/api-reference/endpoint/list-templates\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create new Template\",\"item\":\"https://docs.doczilla.app/api-reference/endpoint/create-template\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.doczilla.app/api-reference/endpoint/create-template#apireference\",\"headline\":\"Create new Template\",\"name\":\"Create new Template\",\"description\":\"Create one template.\",\"url\":\"https://docs.doczilla.app/api-reference/endpoint/create-template\",\"mainEntityOfPage\":{\"@id\":\"https://docs.doczilla.app/api-reference/endpoint/create-template#webpage\"},\"dateModified\":\"2026-01-06T23:53:07.618Z\",\"publisher\":{\"@id\":\"https://docs.doczilla.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.doczilla.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Doczilla\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Doczilla","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Quickstart","href":"/quickstart"},{"title":"Community","href":"/community"},{"title":"Common issues","href":"/common-issues"}]},{"group":"Templating","pages":[{"title":"Templating with Handlebars","sidebarTitle":"Introduction","href":"/templating/introduction"},{"title":"Available helpers","href":"/templating/helpers"}]},{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Render PDF or Screenshots from a Template","sidebarTitle":"Templates","href":"/api-reference/templates"},{"title":"Page options","href":"/api-reference/page-options"},{"title":"PDF options","href":"/api-reference/pdf-options"},{"title":"Screenshot options","href":"/api-reference/screenshot-options"}]},{"group":"Sync/Async options","pages":[{"title":"Storage options","href":"/api-reference/storage-options"},{"title":"Webhook options","href":"/api-reference/webhook-options"},{"title":"Webhook event","href":"/api-reference/webhook-event"}]},{"group":"Screenshot","pages":[{"title":"Create screenshot","openapi":"POST /v1/screenshot","href":"/api-reference/endpoint/screenshot"},{"title":"Create screenshot sync","openapi":"POST /v1/screenshot/sync","href":"/api-reference/endpoint/sync-screenshot"},{"title":"Create screenshot async","openapi":"POST /v1/screenshot/async","href":"/api-reference/endpoint/async-screenshot"}]},{"group":"PDF","pages":[{"title":"Create PDF","openapi":"POST /v1/pdf","href":"/api-reference/endpoint/pdf"},{"title":"Create PDF sync","openapi":"POST /v1/pdf/sync","href":"/api-reference/endpoint/sync-pdf"},{"title":"Create PDF async","openapi":"POST /v1/pdf/async","href":"/api-reference/endpoint/async-pdf"}]},{"group":"Template","pages":[{"title":"From Template","openapi":"POST /v1/template/{id}","href":"/api-reference/endpoint/template"},{"title":"From Template sync","openapi":"POST /v1/template/{id}/sync","href":"/api-reference/endpoint/sync-template"},{"title":"From Template async","openapi":"POST /v1/template/{id}/async","href":"/api-reference/endpoint/async-template"}]},{"group":"Manage Templates","pages":[{"title":"Get all Templates","openapi":"GET /v1/templates","description":"Get all templates.","href":"/api-reference/endpoint/list-templates"},{"title":"Create new Template","openapi":"POST /v1/templates","href":"/api-reference/endpoint/create-template"},{"title":"Get Template","openapi":"GET /v1/templates/{id}","description":"Get one template.","href":"/api-reference/endpoint/get-template"},{"title":"Update Template","openapi":"PUT /v1/templates/{id}","href":"/api-reference/endpoint/update-template"},{"title":"Delete Template","openapi":"DELETE /v1/templates/{id}","href":"/api-reference/endpoint/delete-template"}]}]},{"tab":"Examples","pages":[{"title":"Examples","href":"/examples/introduction"}]},{"tab":"Libraries","pages":[{"title":"Libraries","href":"/libraries/nodejs"}]}]},"title":"Create new Template - Doczilla","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}