{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/web-tools:browshot/get-account-info":{"get":{"operationId":"web_tools_browshot_get_account_info","summary":"Get information about your account","description":"GET /account/info","tags":["web-tools"],"parameters":[{"name":"details","in":"query","required":false,"description":"level of information returned","schema":{"type":"integer","default":1,"description":"level of information returned"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/create-batch":{"post":{"operationId":"web_tools_browshot_create_batch","summary":"Requests thousands of screenshtos at once","description":"POST /batch/ceate","tags":["web-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"hosting":{"type":"string","enum":["s3"],"description":"hosting option - s3 or browshot"},"hosting_height":{"type":"integer","description":"maximum height of the thumbnail to host"},"hosting_width":{"type":"integer","description":"maximum height of the thumbnail to host"},"hosting_scale":{"type":"number","default":1,"description":"scale of the thumbnail to host"},"hosting_bucket":{"type":"string","description":"S3 bucket to upload the screenshot or thumbnail (required for S3)"},"hosting_file":{"type":"string","description":"file name to use (for S3 only)"},"hosting_headers":{"type":"string","description":"list of headers to add to the S3 object (for S3 only)"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/get-batch-info":{"get":{"operationId":"web_tools_browshot_get_batch_info","summary":"Get the batch status","description":"GET /batch/info","tags":["web-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"batch ID","schema":{"type":"integer","description":"batch ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/get-browser-info":{"get":{"operationId":"web_tools_browshot_get_browser_info","summary":"Get information about a browser","description":"GET /browser/info","tags":["web-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"browser ID","schema":{"type":"integer","description":"browser ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/get-browsers-info":{"get":{"operationId":"web_tools_browshot_get_browsers_info","summary":"Get all browsers","description":"GET /browser/list","tags":["web-tools"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/get-instance-info":{"get":{"operationId":"web_tools_browshot_get_instance_info","summary":"Get information about an instance","description":"GET /instance/info","tags":["web-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"instance ID","schema":{"type":"integer","description":"instance ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/get-instances-info":{"get":{"operationId":"web_tools_browshot_get_instances_info","summary":"Get all instances","description":"GET /instance/list","tags":["web-tools"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/create-screenshot":{"get":{"operationId":"web_tools_browshot_create_screenshot","summary":"Request a screenshot","description":"GET /screenshot/create","tags":["web-tools"],"parameters":[{"name":"url","in":"query","required":true,"description":"URL of the page to get a screenshot for","schema":{"type":"string","description":"URL of the page to get a screenshot for"}},{"name":"instance_id","in":"query","required":true,"description":"instance ID to use","schema":{"type":"integer","description":"instance ID to use"}},{"name":"size","in":"query","required":false,"description":"screenshot size - \"screen\" (default) or \"page\"","schema":{"type":"string","enum":["screen","page"],"default":"screen","description":"screenshot size - \"screen\" (default) or \"page\""}},{"name":"cache","in":"query","required":false,"description":"use a previous screenshot (same URL, same instance) if it was done within seconds. The default value is 24hours. Specify cache=0 if you…","schema":{"type":"integer","default":86400,"description":"use a previous screenshot (same URL, same instance) if it was done within seconds. The default value is 24hours. Specify cache=0 if you…"}},{"name":"delay","in":"query","required":false,"description":"number of seconds to wait after the page has loaded. This is used to let JavaScript run longer before taking the screenshot. Use delay=0…","schema":{"type":"integer","default":5,"description":"number of seconds to wait after the page has loaded. This is used to let JavaScript run longer before taking the screenshot. Use delay=0…"}},{"name":"flash_delay","in":"query","required":false,"description":"number of seconds to wait after the page has loaded if Flash elements are present. Use flash_delay=0 to take screenshots faster.","schema":{"type":"integer","default":10,"description":"number of seconds to wait after the page has loaded if Flash elements are present. Use flash_delay=0 to take screenshots faster."}},{"name":"screen_width","in":"query","required":false,"description":"width of the browser window. For desktop browsers only.","schema":{"type":"integer","default":1024,"description":"width of the browser window. For desktop browsers only."}},{"name":"screen_height","in":"query","required":false,"description":"height of the browser window. For desktop browsers only. (Note: full-page screenshots can have a height of up to 15,000px)","schema":{"type":"integer","default":768,"description":"height of the browser window. For desktop browsers only. (Note: full-page screenshots can have a height of up to 15,000px)"}},{"name":"priority","in":"query","required":false,"description":"assign priority to the screenshot (for private instances only)","schema":{"type":"integer","description":"assign priority to the screenshot (for private instances only)"}},{"name":"referer","in":"query","required":false,"description":"use a custom referrer header - paid screenshots only","schema":{"type":"string","description":"use a custom referrer header - paid screenshots only"}},{"name":"post_data","in":"query","required":false,"description":"send a POST requests with post_data, useful for filling out forms - paid screenshots only","schema":{"type":"string","description":"send a POST requests with post_data, useful for filling out forms - paid screenshots only"}},{"name":"cookie","in":"query","required":false,"description":"set a cookie for the URL requested (see Custom POST Data, Referer and Cookie) Cookies should be separated by a ; - paid screenshots only","schema":{"type":"string","description":"set a cookie for the URL requested (see Custom POST Data, Referer and Cookie) Cookies should be separated by a ; - paid screenshots only"}},{"name":"script","in":"query","required":false,"description":"URL of javascript file to execute after the page load event","schema":{"type":"string","description":"URL of javascript file to execute after the page load event"}},{"name":"details","in":"query","required":false,"description":"level of information available with screenshot/info","schema":{"type":"integer","default":2,"description":"level of information available with screenshot/info"}},{"name":"html","in":"query","required":false,"description":"saves the HTML of the rendered page which can be retrieved by the API call screenshot/html. This feature costs *1 credit* per screenshot.","schema":{"type":"integer","default":0,"description":"saves the HTML of the rendered page which can be retrieved by the API call screenshot/html. This feature costs *1 credit* per screenshot."}},{"name":"max_wait","in":"query","required":false,"description":"maximum number of seconds to wait before triggering the PageLoad event. Note that delay will still be used. (default: 0 = disabled)","schema":{"type":"integer","default":0,"description":"maximum number of seconds to wait before triggering the PageLoad event. Note that delay will still be used. (default: 0 = disabled)"}},{"name":"headers","in":"query","required":false,"description":"any custom HTTP headers. (Not supported with Internet Explorer)","schema":{"type":"string","description":"any custom HTTP headers. (Not supported with Internet Explorer)"}},{"name":"shots","in":"query","required":false,"description":"take multiple screenshots of the same page. This costs 1 additional credit for every 2 additional screenshots.","schema":{"type":"integer","default":1,"description":"take multiple screenshots of the same page. This costs 1 additional credit for every 2 additional screenshots."}},{"name":"shot_interval","in":"query","required":false,"description":"number of seconds between 2 screenshots","schema":{"type":"integer","default":5,"description":"number of seconds between 2 screenshots"}},{"name":"hosting","in":"query","required":false,"description":"hosting option - s3 or browshot","schema":{"type":"string","enum":["s3","browshot"],"description":"hosting option - s3 or browshot"}},{"name":"hosting_height","in":"query","required":false,"description":"maximum height of the thumbnail to host","schema":{"type":"integer","description":"maximum height of the thumbnail to host"}},{"name":"hosting_width","in":"query","required":false,"description":"maximum height of the thumbnail to host","schema":{"type":"integer","description":"maximum height of the thumbnail to host"}},{"name":"hosting_scale","in":"query","required":false,"description":"scale of the thumbnail to host","schema":{"type":"number","default":1,"description":"scale of the thumbnail to host"}},{"name":"hosting_bucket","in":"query","required":false,"description":"S3 bucket to upload the screenshot or thumbnail (required for S3)","schema":{"type":"string","description":"S3 bucket to upload the screenshot or thumbnail (required for S3)"}},{"name":"hosting_file","in":"query","required":false,"description":"file name to use (for S3 only)","schema":{"type":"string","description":"file name to use (for S3 only)"}},{"name":"hosting_headers","in":"query","required":false,"description":"list of headers to add to the S3 object (for S3 only)","schema":{"type":"string","description":"list of headers to add to the S3 object (for S3 only)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/delete-screenshot":{"get":{"operationId":"web_tools_browshot_delete_screenshot","summary":"Delete screenshot data","description":"GET /screenshot/delete","tags":["web-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"screenshot ID","schema":{"type":"integer","description":"screenshot ID"}},{"name":"data","in":"query","required":false,"description":"data to remove. You can specify multiple of them (separated by a ,): *image* (image files), *url* (url requested), *metadata* (time added,…","schema":{"type":"string","default":"image","description":"data to remove. You can specify multiple of them (separated by a ,): *image* (image files), *url* (url requested), *metadata* (time added,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/host-screenshot":{"get":{"operationId":"web_tools_browshot_host_screenshot","summary":"Host thumbnails on your own S3 account or on Browshot.","description":"GET /screenshot/host","tags":["web-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"screenshot ID","schema":{"type":"integer","description":"screenshot ID"}},{"name":"hosting","in":"query","required":true,"description":"hosting option: s3 or browshot","schema":{"type":"string","enum":["s3","browshot"],"description":"hosting option: s3 or browshot"}},{"name":"width","in":"query","required":false,"description":"width of the thumbnail","schema":{"type":"integer","description":"width of the thumbnail"}},{"name":"height","in":"query","required":false,"description":"height of the thumbnail","schema":{"type":"integer","description":"height of the thumbnail"}},{"name":"scale","in":"query","required":false,"description":"scale of the thumbnail","schema":{"type":"number","default":1,"description":"scale of the thumbnail"}},{"name":"bucket","in":"query","required":false,"description":"S3 bucket to upload the screenshot or thumbnail - required with hosting=s3","schema":{"type":"string","description":"S3 bucket to upload the screenshot or thumbnail - required with hosting=s3"}},{"name":"file","in":"query","required":false,"description":"file name to use - optional, used with hosting=s3","schema":{"type":"string","description":"file name to use - optional, used with hosting=s3"}},{"name":"headers","in":"query","required":false,"description":"HTTP headers to add to your S3 object - optional, used with hosting=s3","schema":{"type":"string","description":"HTTP headers to add to your S3 object - optional, used with hosting=s3"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/get-html":{"get":{"operationId":"web_tools_browshot_get_html","summary":"Get the HTML code","description":"GET /screenshot/html","tags":["web-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"screenshot ID","schema":{"type":"integer","description":"screenshot ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/get-screenshot-info":{"get":{"operationId":"web_tools_browshot_get_screenshot_info","summary":"Query screenshot status","description":"GET /screenshot/info","tags":["web-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"screenshot ID received from /api/v1/screenshot/create","schema":{"type":"integer","description":"screenshot ID received from /api/v1/screenshot/create"}},{"name":"details","in":"query","required":false,"description":"level of details about the screenshot and the page","schema":{"type":"integer","default":2,"description":"level of details about the screenshot and the page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/get-multiple-screenshots-info":{"get":{"operationId":"web_tools_browshot_get_multiple_screenshots_info","summary":"Get information about screenshots","description":"GET /screenshot/list","tags":["web-tools"],"parameters":[{"name":"limit","in":"query","required":false,"description":"maximum number of screenshots' information to return","schema":{"type":"integer","default":100,"description":"maximum number of screenshots' information to return"}},{"name":"status","in":"query","required":false,"description":"get list of screenshot in a given status (error, finished, in_process)","schema":{"type":"string","enum":["error","finished","in_process"],"description":"get list of screenshot in a given status (error, finished, in_process)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/create-multiple-screenshots":{"get":{"operationId":"web_tools_browshot_create_multiple_screenshots","summary":"Request multiple screenshots","description":"GET /screenshot/multiple","tags":["web-tools"],"parameters":[{"name":"url","in":"query","required":true,"description":"URL of the page to get a screenshot for. You can specify multiple url parameters (up to 10).","schema":{"type":"string","description":"URL of the page to get a screenshot for. You can specify multiple url parameters (up to 10)."}},{"name":"instance_id","in":"query","required":true,"description":"instance ID to use. You can specify multiple instance_id parameters (up to 10).","schema":{"type":"integer","description":"instance ID to use. You can specify multiple instance_id parameters (up to 10)."}},{"name":"size","in":"query","required":false,"description":"screenshot size - \"screen\" (default) or \"page\"","schema":{"type":"string","enum":["screen","page"],"default":"screen","description":"screenshot size - \"screen\" (default) or \"page\""}},{"name":"cache","in":"query","required":false,"description":"use a previous screenshot (same URL, same instance) if it was done within seconds. The default value is 24hours. Specify cache=0 if you…","schema":{"type":"integer","default":86400,"description":"use a previous screenshot (same URL, same instance) if it was done within seconds. The default value is 24hours. Specify cache=0 if you…"}},{"name":"delay","in":"query","required":false,"description":"number of seconds to wait after the page has loaded. This is used to let JavaScript run longer before taking the screenshot. Use delay=0…","schema":{"type":"integer","default":5,"description":"number of seconds to wait after the page has loaded. This is used to let JavaScript run longer before taking the screenshot. Use delay=0…"}},{"name":"flash_delay","in":"query","required":false,"description":"number of seconds to wait after the page has loaded if Flash elements are present. Use flash_delay=0 to take screenshots faster.","schema":{"type":"integer","default":10,"description":"number of seconds to wait after the page has loaded if Flash elements are present. Use flash_delay=0 to take screenshots faster."}},{"name":"screen_width","in":"query","required":false,"description":"width of the browser window. For desktop browsers only.","schema":{"type":"integer","default":1024,"description":"width of the browser window. For desktop browsers only."}},{"name":"screen_height","in":"query","required":false,"description":"height of the browser window. For desktop browsers only. (Note: full-page screenshots can have a height of up to 15,000px)","schema":{"type":"integer","default":768,"description":"height of the browser window. For desktop browsers only. (Note: full-page screenshots can have a height of up to 15,000px)"}},{"name":"priority","in":"query","required":false,"description":"assign priority to the screenshot (for private instances only)","schema":{"type":"integer","description":"assign priority to the screenshot (for private instances only)"}},{"name":"referer","in":"query","required":false,"description":"use a custom referrer header - paid screenshots only","schema":{"type":"string","description":"use a custom referrer header - paid screenshots only"}},{"name":"post_data","in":"query","required":false,"description":"send a POST requests with post_data, useful for filling out forms - paid screenshots only","schema":{"type":"string","description":"send a POST requests with post_data, useful for filling out forms - paid screenshots only"}},{"name":"cookie","in":"query","required":false,"description":"set a cookie for the URL requested (see Custom POST Data, Referer and Cookie) Cookies should be separated by a ; - paid screenshots only","schema":{"type":"string","description":"set a cookie for the URL requested (see Custom POST Data, Referer and Cookie) Cookies should be separated by a ; - paid screenshots only"}},{"name":"script","in":"query","required":false,"description":"URL of javascript file to execute after the page load event","schema":{"type":"string","description":"URL of javascript file to execute after the page load event"}},{"name":"details","in":"query","required":false,"description":"level of information available with screenshot/info","schema":{"type":"integer","default":2,"description":"level of information available with screenshot/info"}},{"name":"html","in":"query","required":false,"description":"saves the HTML of the rendered page which can be retrieved by the API call screenshot/html. This feature costs *1 credit* per screenshot.","schema":{"type":"integer","default":0,"description":"saves the HTML of the rendered page which can be retrieved by the API call screenshot/html. This feature costs *1 credit* per screenshot."}},{"name":"max_wait","in":"query","required":false,"description":"maximum number of seconds to wait before triggering the PageLoad event. Note that delay will still be used. (default: 0 = disabled)","schema":{"type":"integer","default":0,"description":"maximum number of seconds to wait before triggering the PageLoad event. Note that delay will still be used. (default: 0 = disabled)"}},{"name":"headers","in":"query","required":false,"description":"any custom HTTP headers. (Not supported with Internet Explorer)","schema":{"type":"string","description":"any custom HTTP headers. (Not supported with Internet Explorer)"}},{"name":"hosting","in":"query","required":false,"description":"hosting option - s3 or browshot","schema":{"type":"string","enum":["s3","browshot"],"description":"hosting option - s3 or browshot"}},{"name":"hosting_height","in":"query","required":false,"description":"maximum height of the thumbnail to host","schema":{"type":"integer","description":"maximum height of the thumbnail to host"}},{"name":"hosting_width","in":"query","required":false,"description":"maximum height of the thumbnail to host","schema":{"type":"integer","description":"maximum height of the thumbnail to host"}},{"name":"hosting_scale","in":"query","required":false,"description":"scale of the thumbnail to host","schema":{"type":"number","default":1,"description":"scale of the thumbnail to host"}},{"name":"hosting_bucket","in":"query","required":false,"description":"S3 bucket to upload the screenshot or thumbnail (required for S3)","schema":{"type":"string","description":"S3 bucket to upload the screenshot or thumbnail (required for S3)"}},{"name":"hosting_file","in":"query","required":false,"description":"file name to use (for S3 only)","schema":{"type":"string","description":"file name to use (for S3 only)"}},{"name":"hosting_headers","in":"query","required":false,"description":"list of headers to add to the S3 object (for S3 only)","schema":{"type":"string","description":"list of headers to add to the S3 object (for S3 only)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/search-screenshot":{"get":{"operationId":"web_tools_browshot_search_screenshot","summary":"Search for screenshots","description":"GET /screenshot/search","tags":["web-tools"],"parameters":[{"name":"url","in":"query","required":true,"description":"look for a string matching the URL requested","schema":{"type":"string","description":"look for a string matching the URL requested"}},{"name":"limit","in":"query","required":false,"description":"maximum number of screenshots' information to return","schema":{"type":"integer","default":50,"description":"maximum number of screenshots' information to return"}},{"name":"status","in":"query","required":false,"description":"get list of screenshot in a given status (error, finished, in_process)","schema":{"type":"string","enum":["error","finished","in_process"],"description":"get list of screenshot in a given status (error, finished, in_process)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/share-screenshot":{"get":{"operationId":"web_tools_browshot_share_screenshot","summary":"Share a screenshot","description":"GET /screenshot/share","tags":["web-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"screenshot ID","schema":{"type":"integer","description":"screenshot ID"}},{"name":"note","in":"query","required":false,"description":"note to add on the sharing page","schema":{"type":"string","description":"note to add on the sharing page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/web-tools:browshot/get-thumbnail":{"get":{"operationId":"web_tools_browshot_get_thumbnail","summary":"Retrieve a thumbnail image","description":"GET /screenshot/thumbnail","tags":["web-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"screenshot ID","schema":{"type":"integer","description":"screenshot ID"}},{"name":"width","in":"query","required":false,"description":"width of the thumbnail","schema":{"type":"integer","description":"width of the thumbnail"}},{"name":"height","in":"query","required":false,"description":"height of the thumbnail","schema":{"type":"integer","description":"height of the thumbnail"}},{"name":"scale","in":"query","required":false,"description":"scale of the thumbnail","schema":{"type":"number","default":1,"description":"scale of the thumbnail"}},{"name":"zoom","in":"query","required":false,"description":"zoom 1 to 100 percent","schema":{"type":"integer","default":100,"description":"zoom 1 to 100 percent"}},{"name":"ratio","in":"query","required":false,"description":"Use fit to keep the original page ration, and fill to get a thumbnail for the exact width and height. specified. If you provide both width…","schema":{"type":"string","enum":["fit","fill"],"default":"fit","description":"Use fit to keep the original page ration, and fill to get a thumbnail for the exact width and height. specified. If you provide both width…"}},{"name":"left","in":"query","required":false,"description":"left edge of the area to be cropped","schema":{"type":"integer","default":0,"description":"left edge of the area to be cropped"}},{"name":"right","in":"query","required":false,"description":"right edge of the area to be cropped","schema":{"type":"integer","default":0,"description":"right edge of the area to be cropped"}},{"name":"top","in":"query","required":false,"description":"top edge of the area to be cropped","schema":{"type":"integer","default":0,"description":"top edge of the area to be cropped"}},{"name":"bottom","in":"query","required":false,"description":"bottom edge of the area to be cropped","schema":{"type":"integer","description":"bottom edge of the area to be cropped"}},{"name":"format","in":"query","required":false,"description":"image as PNG or JPEG","schema":{"type":"string","enum":["png","jpeg"],"default":"png","description":"image as PNG or JPEG"}},{"name":"shot","in":"query","required":false,"description":"get the second or third screenshot if multiple screenshots were requested","schema":{"type":"integer","default":1,"description":"get the second or third screenshot if multiple screenshots were requested"}},{"name":"quality","in":"query","required":false,"description":"JPEG quality factor (for JPEG thumbnails only)","schema":{"type":"integer","default":100,"description":"JPEG quality factor (for JPEG thumbnails only)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}