Screenshot
Render a public webpage as PNG, JPEG, or WebP with controls for the viewport, page readiness, and capture area.
The success response is image binary data, not JSON. Save the response body to a file, return it from your own service, or create a browser object URL for preview.
Use full_page to capture the whole document, or selector to capture one visible element. These options cannot be enabled together.
Choose Full-page PNG, Page element as WebP, or Dark-mode viewport in the request example selector below. The cURL example writes the binary response to a correctly named image file; the official SDK examples return bytes plus the response content type and request ID.
The target must be a public HTTP or HTTPS URL without embedded credentials. Requests for private or special-use network addresses are rejected with 403 Forbidden.
A successful screenshot costs 2 credits. Failed requests are not charged.
Authorization
bearerAuth In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
urilength <= 4096"png"Value in
- "png"
- "jpeg"
- "webp"
falseDefault
{ "width": 1440, "height": 900, "device_scale_factor": 1}"load"Value in
- "domcontentloaded"
- "load"
- "networkidle"
1 <= length <= 5001 <= length <= 5000 <= value <= 500001000 <= value <= 30000200001 <= value <= 100false"light"Value in
- "light"
- "dark"
"disabled"Value in
- "disabled"
- "allow"
Response Body
application/json
application/json
application/problem+json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/screenshot" \ -H "Content-Type: application/json" \ -d '{ "url": "https://s1.dev", "format": "png", "full_page": true, "wait_until": "load", "delay_ms": 1000, "timeout_ms": 30000 }' \ --output "screenshot.png""string"{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}