Input schema (JSON)
{
"type": "object",
"$defs": {
"ProxyType": {
"enum": [
"datacenter",
"residential",
"mix"
],
"type": "string",
"title": "ProxyType"
},
"WaitUntil": {
"enum": [
"commit",
"domcontentloaded",
"load",
"networkidle"
],
"type": "string",
"title": "WaitUntil"
},
"WaitConfig": {
"type": "object",
"title": "WaitConfig",
"properties": {
"wait_for": {
"anyOf": [
{
"type": "string",
"maxLength": 4096
},
{
"type": "null"
}
],
"title": "Wait For",
"default": null,
"description": "CSS selector or XPath expression to wait for before extracting the DOM. At least one matching element must become attached to the DOM for the wait to succeed. XPath expressions must start with `//` or `xpath=`; anything else is treated as a CSS selector. Applied after wait_until."
},
"wait_until": {
"anyOf": [
{
"$ref": "#/$defs/WaitUntil"
},
{
"type": "null"
}
],
"default": null,
"description": "Playwright page lifecycle event to wait for during navigation, before the selector wait or explicit delay. Accepted values: `commit` — response headers received and navigation committed; `domcontentloaded` — HTML parsed and DOM ready (no sub-resources); `load` — page and all sub-resources (images, scripts) fully loaded; `networkidle` — no network activity for 500 ms. When omitted, defaults to `domcontentloaded`."
},
"wait_timeout": {
"anyOf": [
{
"type": "integer",
"maximum": 30000,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Wait Timeout",
"default": null,
"description": "Deliberate pause in milliseconds inserted after wait_for resolves (or immediately after wait_until when wait_for is omitted), before the DOM is captured. Use to allow late-settling JavaScript to finish rendering. Range: 0–30 000 ms."
}
},
"description": "Explicit browser wait policy applied in order: wait_until → wait_for → wait_timeout.\nWhen a non-null WaitConfig is provided, the adaptive default settle phase is skipped\nand the caller owns the full wait sequence. Null fields inside the object are treated\nthe same as absence of that field."
},
"OutputFormat": {
"enum": [
"markdown",
"html"
],
"type": "string",
"title": "OutputFormat"
},
"ProxySettings": {
"type": "object",
"title": "ProxySettings",
"properties": {
"type": {
"$ref": "#/$defs/ProxyType",
"default": "residential",
"description": "Type of proxy to use (datacenter or residential). Defaults to 'residential' when omitted."
},
"country": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Z]{2}$"
},
{
"type": "null"
}
],
"title": "Country",
"default": null,
"description": "ISO 3166-1 alpha-2 country code for geo-targeting (e.g., 'US', 'GB'). Codes that are not backed by a geo-targeted proxy pool are rejected rather than silently ignored. If null, the server auto-resolves a country from the target URL (domain/path overrides first, then the TLD). If no country can be inferred, the upstream proxy provider picks the exit region."
}
}
},
"ExtractRequest": {
"type": "object",
"title": "ExtractRequest",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "Url",
"format": "uri",
"minLength": 1,
"description": "URL to extract content from"
},
"proxy": {
"anyOf": [
{
"$ref": "#/$defs/ProxySettings"
},
{
"type": "null"
}
],
"default": {
"type": "residential",
"country": null
},
"description": "Proxy configuration. Optional — when omitted or explicitly `null`, defaults are applied: residential type, country auto-resolved from the target URL (domain/path overrides first, then the TLD; if nothing matches, the upstream proxy provider picks the exit region). Send an object to override either field; individual fields inside the object may also be null (see ProxySettings)."
},
"formats": {
"type": "array",
"items": {
"$ref": "#/$defs/OutputFormat"
},
"title": "Formats",
"default": [
"html"
],
"description": "Output formats to return"
},
"headers": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Headers",
"default": null,
"description": "Custom HTTP headers to include in extraction request. `Accept-Language` is the one exception on browser-rendered requests: it is not forwarded verbatim, because it would override the header the browser derives from its locale and leave the wire value contradicting `navigator.language`. The language you ask for is still honoured — it selects the browser locale, paired with the proxy country's region, so `en-US` through a German proxy renders the page as `en-DE`. `Host` and `:authority` are dropped: the target host always comes from `url`."
},
"timeout": {
"anyOf": [
{
"type": "integer",
"minimum": 1000
},
{
"type": "null"
}
],
"title": "Timeout",
"default": null,
"description": "Milliseconds this request may take, counted from when we receive it and including any queue wait. A wait for the per-site rate limit or for a free thread uses the same time: when it does not fit, the request is refused with 429 instead of being held longer. On expiry the escalation chain stops rather than the response merely arriving sooner: no further browser is launched, and the request is not billed. Omit it to keep the system ceiling. Sync requests only: sending it with processing_mode=async is rejected rather than ignored, because an async caller holds a job id and polls at its own pace. Values above the ceiling are clamped to it."
},
"render_js": {
"type": "boolean",
"title": "Render Js",
"default": false,
"description": "If true, uses a headless browser to render the page (slower, more expensive)."
},
"wait_config": {
"anyOf": [
{
"$ref": "#/$defs/WaitConfig"
},
{
"type": "null"
}
],
"default": null,
"description": "Grouped browser wait policy. Optional: when omitted or null, browser requests use the adaptive default settle policy whenever a browser runs. Send a non-null object to opt into caller-owned explicit wait mode, which skips the adaptive default settle phase. Null fields inside wait_config behave the same as absence. If render_js is not set explicitly, any non-null wait_config auto-enables browser rendering and the effective render_js value is returned in metadata. If render_js=false is sent together with a non-null wait_config, the request is rejected as ambiguous."
},
"processing_mode": {
"$ref": "#/$defs/ProcessingMode",
"default": "sync",
"description": "Processing mode: sync (block until done) or async (starts job and return job ID)"
}
}
},
"ProcessingMode": {
"enum": [
"sync",
"async"
],
"type": "string",
"title": "ProcessingMode"
}
},
"title": "extractArguments",
"required": [
"extract_request"
],
"properties": {
"api_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Key",
"default": null
},
"extract_request": {
"$ref": "#/$defs/ExtractRequest"
}
}
}