API reference · DataForSEO
dataforseo/v3/on_page/instant_pages
Integrate this model through SandBase's unified API, with production-ready schemas and examples.
Production endpoint
Send your first request
OpenAI-compatible endpoint with unified authentication and usage tracking.
POST
https://api.sandbase.ai/v1/runModel ID
dataforseo/v3/on_page/instant_pages01
Input Schema
19 parameters · 1 required · 18 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
url | string | Required | target page url required field absolute URL of the target page; Note #1: results will be returned for the specified URL only; Note #2: to prevent denial-of-service events, tasks that contain a duplica... |
custom_js | string | Optional | custom javascript optional fieldNote that the execution time for the script you enter here should be 700 ms maximum; for example, you can use the following JS snippet to check if the website contains ... |
enable_xhr | boolean | Optional | enable XMLHttpRequest on a page optional field set to true if you want our crawler to request data from a web server using the XMLHttpRequest object default value: falseif you use this field, enable_j... |
check_spell | boolean | Optional | check spelling optional field set to true to check spelling on a website using Hunspell library default value: false |
switch_pool | boolean | Optional | switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasi... |
browser_preset | string | Optional | preset for browser screen parameters optional field if you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values: desktop, ... |
load_resources | boolean | Optional | load resources optional field set to true if you want to load image, stylesheets, scripts, and broken resources default value: false Note: if you use this parameter, additional charges will apply; lea... |
store_raw_html | boolean | Optional | store HTML of a crawled page optional field set to true if you want get the HTML of the page using the OnPage Raw HTML endpoint default value: false |
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; in this c... |
checks_threshold | array | Optional | custom threshold values for checks optional field you can specify custom threshold values for the parameters included in the checks array of OnPage API responses; Note: only integer threshold values c... |
ip_pool_for_scan | string | Optional | proxy pool optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations,... |
custom_user_agent | string | Optional | custom user agent optional field custom user agent for crawling a website example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/53... |
browser_screen_width | integer | Optional | browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don't need to indicate browser_preset as it will be i... |
disable_cookie_popup | boolean | Optional | disable the cookie popup optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false |
validate_micromarkup | boolean | Optional | enable microdata validation optional field if set to true, you can use the OnPage API Microdata endpoint with the id of the task; default value: false |
browser_screen_height | integer | Optional | browser screen height optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don't need to indicate browser_preset as it will be... |
return_despite_timeout | boolean | Optional | return data on pages despite the timeout error optional field if true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error; default value: fals... |
enable_browser_rendering | boolean | Optional | emulate browser rendering to measure Core Web Vitals optional field by using this parameter you will be able to emulate a browser when loading a web page; enable_browser_rendering loads styles, images... |
browser_screen_scale_factor | number | Optional | browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don't need to indicate browser_pres... |
02
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 |
03
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/instant_pages",
"prompt": "a beautiful sunset over mountains"
}'