Developers

API reference

Internal pilot

Request fields

Validation and normalization used by the internal Web Scraping API generator.

Actions

The current service accepts a POST JSON envelope with action. status reports execution availability. execute requires authorized staff access, a request object and an optional UUID requestId.

Request settings

FieldTypeBehavior
urlstringRequired public HTTP(S) URL, up to 2,048 characters. Ports 80/443 only; no embedded credentials.
proxyTypestringdatacenter or residential. The interface labels datacenter as Standard.
countrystringOptional supported two-letter code; empty means no preferred country.
formatstringhtml, json, markdown or ai.
renderbooleanEnable browser loading. Default true.
returnPageSourcebooleanReturn original page source; ignored when render is false.
cookiesstringOne line of name=value pairs, up to 4,096 characters. Not persisted in drafts.
jsSnippetstringBrowser-side code for the provider, up to 12,000 characters. Ignored without rendering; not persisted.
waitForSelectorstringCSS selector, up to 500 characters. Ignored without rendering.
extractPropertiesstringAI extraction description, up to 2,000 characters. Required for ai; ignored otherwise.
timeoutintegerProvider setting from 5 to 60 seconds. Default 60.

Example settings

Internal generator settings
{
  "action": "execute",
  "request": {
    "url": "https://example.com/",
    "proxyType": "datacenter",
    "country": "US",
    "format": "html",
    "render": false,
    "timeout": 30
  }
}

Request identifiers

A request ID prevents the same execution from being dispatched twice. Reusing an already submitted ID produces 409 duplicate. Use a new ID only when you intend a new provider request, which may consume credits.

Target validation

The target must resolve to public internet addresses. Private, local and reserved addresses are rejected. Keep requests within your authorization to access the destination.

Search documentation

Search guides, products and reference pages.