API reference · DataForSEO

dataforseo/v3/on_page/page_screenshot

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APISynchronousOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDdataforseo/v3/on_page/page_screenshot

Input Schema

11 parameters · 1 required · 10 optional

Parameter	Type	Required	Description
`url`	string	Required	page url required field absolute URL of the page to capture a screenshot of example: https://dataforseo.com/apis
`switch_pool`	boolean	Optional	switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data
`browser_preset`	string	Optional	preset for browser screen parameters optional field possible values: desktop, mobile, tablet desktop: 1920x1080, scale 1 mobile: 390x844, scale 3 tablet: 1024x1366, scale 2
`accept_language`	string	Optional	language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) Note: if you do not specify this parameter, some websites may deny access
`ip_pool_for_scan`	string	Optional	proxy pool location optional field possible values: us, de
`custom_user_agent`	string	Optional	custom user agent optional field custom user agent for crawling a website default value: Mozilla/5.0 (compatible; RSiteAuditor)
`browser_screen_width`	integer	Optional	browser screen width in pixels optional field minimum value: 240 maximum value: 9999 if set, browser_preset is ignored
`disable_cookie_popup`	boolean	Optional	disable the cookie popup optional field set to true to dismiss cookie consent dialogs default value: false
`full_page_screenshot`	boolean	Optional	take a screenshot of the full page optional field set to false to capture only the visible viewport default value: true
`browser_screen_height`	integer	Optional	browser screen height in pixels optional field minimum value: 240 maximum value: 9999 if set, browser_preset is ignored
`browser_screen_scale_factor`	number	Optional	browser screen scale factor optional field minimum value: 0.5 maximum value: 3 if set, browser_preset is ignored

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Code Examples

Ready-to-run snippets

curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "dataforseo/v3/on_page/page_screenshot",
  "prompt": "a beautiful sunset over mountains"
}'

← Back to OnPage Page Screenshot