{"openapi":"3.2.0","info":{"title":"Website Screenshot API","description":"Capture pixel-perfect screenshots of any website or HTML with a real Chromium browser. Full-page and 4K viewports, PNG/JPEG/WebP/PDF, CSS selectors, JS/CSS injection, ad and cookie-banner blocking. Free plan includes 1,500 captures per month.","version":"1.0.0"},"servers":[{"url":"https://jzawe.jojapi.net"}],"security":[{"ApiKeyAuth":[]}],"x-agent-commerce":{"catalog_url":"https://jzawe.jojapi.net/_jojapi/agent/plans","discovery_url":"https://jzawe.jojapi.net/.well-known/x402","directory_url":"https://agents.jojapi.net/apis/website-screenshot","docs":"https://docs.jojapi.com/consumers/agents"},"paths":{"/api/v1/screenshot":{"get":{"operationId":"get_api_v1_screenshot","summary":"Take Screenshot","description":"Receives a URL, takes the screenshot and return the image","responses":{"200":{"description":"The screenshot image from the website","content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"examples":{"Example_1":{"value":{"url":"https://kassellabs.us-east-1.linodeobjects.com/screenshots-dev/57vYx5Ox9GoZUE3BEOtXlxP6g40eBBCdRHv9-dmOUM.png"}}}}}},"401":{"description":"Unauthorized — missing or invalid credentials"}},"parameters":[{"name":"httpHeaders","in":"query","description":"A JSON Object with httpHeaders to be sent to the requested page. It should have a pattern of {\"Header Name\": \"Header Value\"}","required":false,"schema":{"type":"string"}},{"name":"screenshotWidth","in":"query","description":"The screenshot clip width (leave blank if you want full page screenshot)","required":false,"schema":{"type":"number"}},{"name":"url","in":"query","description":"The website to take the screenshot","required":false,"schema":{"type":"string","example":"https://google.com"}},{"name":"screenshotHeight","in":"query","description":"The screenshot clip height (leave blank if you want full page screenshot)","required":false,"schema":{"type":"number"}},{"name":"preRenderCode","in":"query","description":"Code to execute before taking the screenshot","required":false,"schema":{"type":"string"}},{"name":"readyEvent","in":"query","description":"Which browser event to wait before taking the screenshot.","required":false,"schema":{"type":"string","example":"load","default":"load"}},{"name":"html","in":"query","description":"A html code to use instead of a page to take the screenshot from (You are required to send a \"html\" OR a \"url\")","required":false,"schema":{"type":"string"}},{"name":"format","in":"query","description":"Which image format should be returned","required":false,"schema":{"type":"string","example":"image/png","default":"image/png"}},{"name":"viewportHeight","in":"query","description":"The screenshot website desired viewport height","required":false,"schema":{"type":"number","example":1080,"default":1080}},{"name":"selectorToScreenshot","in":"query","description":"CSS Selector to screenshot in the page (defaults to the entire page)","required":false,"schema":{"type":"string"}},{"name":"screenshotY","in":"query","description":"The screenshot Y clip position (leave blank if you want full page screenshot)","required":false,"schema":{"type":"number"}},{"name":"screenshotX","in":"query","description":"The screenshot X clip position (leave blank if you want full page screenshot)","required":false,"schema":{"type":"number"}},{"name":"cookies","in":"query","description":"A JSON Object with cookies to be used in the requested page. It should have a pattern of {\"Header Name\": \"Header Value\"}","required":false,"schema":{"type":"string"}},{"name":"omitBackground","in":"query","description":"Turn non colored parts of the background transparent in the screenshot","required":false,"schema":{"type":"boolean","example":true,"default":true}},{"name":"userAgent","in":"query","description":"Custom User Agent to Simulate","required":false,"schema":{"type":"string"}},{"name":"responseType","in":"query","description":"Which way should the response be received","required":false,"schema":{"type":"string","example":"file","default":"file"}},{"name":"viewportWidth","in":"query","description":"The screenshot website desired viewport height","required":false,"schema":{"type":"number","example":1920,"default":1920}}]},"post":{"operationId":"post_api_v1_screenshot","summary":"Take Screenshot","description":"Receives a URL, takes the screenshot and return the image","responses":{"200":{"description":"The screenshot image from the website","content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}},"examples":{"Example_1":{"value":{"url":"https://example.com/screenshot.png"}}}}}},"401":{"description":"Unauthorized — missing or invalid credentials"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"required":false,"type":"string"},"html":{"required":false,"type":"string"},"httpHeaders":{"required":false,"type":"string"},"cookies":{"required":false,"type":"string"},"viewportWidth":{"required":false,"default":1920,"type":"integer"},"viewportHeight":{"required":false,"default":1080,"type":"integer"},"screenshotX":{"required":false,"type":"integer"},"screenshotY":{"required":false,"type":"integer"},"screenshotWidth":{"required":false,"type":"integer"},"screenshotHeight":{"required":false,"type":"integer"},"preRenderCode":{"required":false,"type":"string"},"selectorToScreenshot":{"required":false,"type":"string"},"omitBackground":{"required":false,"default":true,"type":"boolean"},"userAgent":{"required":false,"type":"string"},"readyEvent":{"required":false,"type":"string","default":"load","enum":["load","domcontentloaded","networkidle"]},"format":{"required":false,"type":"string","default":"image/png","enum":["image/png","image/jpg","image/jpeg","image/gif","image/webp","image/jp2","image/tiff"]},"responseType":{"required":false,"type":"string","default":"file","enum":["url","file"]}}},"example":{"url":"https://google.com"}}}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-JoJAPI-Key","description":"Your JoJ API key."}}}}