Raw schema
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "An http(s) URL."
},
"mode": {
"type": "string",
"enum": [
"standard",
"research"
],
"description": "The declared identity the page is read under: standard (default) or research. A hosted server holds no saved logins, so it has no authed mode."
},
"allowlistedDomains": {
"type": "array",
"items": {
"type": "string"
}
},
"formats": {
"type": "array",
"minItems": 1,
"description": "What to return (default markdown): markdown, links, html, rawHtml, images, tables, json, attributes ({ selectors }), list ({ itemSelector?, fields? }: a record per repeated item, detected without itemSelector), screenshot or screenshot@fullPage (browser only). This connection has no browser lane, so it offers no screenshot.",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"markdown",
"links",
"json",
"html",
"rawHtml",
"images",
"tables"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "json"
},
"schema": {
"type": "object"
},
"prompt": {
"type": "string",
"maxLength": 4000
},
"modelFallback": {
"type": "boolean"
}
},
"required": [
"type",
"schema"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "attributes"
},
"selectors": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"items": {
"type": "object",
"properties": {
"selector": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"attribute": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[A-Za-z_][A-Za-z0-9_:.-]*$"
}
},
"required": [
"selector",
"attribute"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"selectors"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "list"
},
"itemSelector": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"fields": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"selector": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"attribute": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_:.-]*$"
}
},
"required": [
"name"
],
"additionalProperties": false
}
}
},
"required": [
"type"
],
"additionalProperties": false
}
]
}
},
"includeLinks": {
"type": "boolean",
"description": "Also return the page's links. Default false."
},
"debug": {
"type": "boolean",
"description": "Return the full audit: trace, ladderTrace and every attempt."
},
"markdownOffset": {
"type": "integer",
"minimum": 0,
"description": "Read on from a cut markdown's truncatedAt."
},
"onlyMainContent": {
"type": "boolean",
"description": "false also keeps header, navigation and footer. Default true."
},
"timeout": {
"type": "integer",
"minimum": 1000,
"maximum": 180000,
"description": "Deadline in milliseconds for the whole scrape. When it fires the result is partial with the content so far, or failed/timeout. Here by default 120000, max 180000; a longer one is lowered to it."
},
"maxFileBytes": {
"type": "integer",
"minimum": 1,
"maximum": 5242880,
"description": "Largest file to download; a larger one is failed/body_too_large."
},
"includeTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "CSS selectors of the only elements to keep, whatever onlyMainContent says (no sibling combinators, :nth-child or :has)."
},
"excludeTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "CSS selectors removed with their contents."
},
"headers": {
"type": "object",
"maxProperties": 32,
"additionalProperties": {
"type": "string",
"maxLength": 4096
},
"description": "Extra headers to the page's origin, recorded; User-Agent, client hints, authorization and cookie refused."
},
"mobile": {
"type": "boolean",
"description": "Read as declared mobile Chrome (Android UA, 412x915). Default false."
},
"fastMode": {
"type": "boolean",
"description": "HTTP only: a page needing scripts gets the HTTP verdict (a shell: failed/empty_unverified). Default false."
},
"blockAds": {
"type": "boolean",
"description": "Block ad hosts, ads and cookie banners in the browser. Default true."
},
"removeBase64Images": {
"type": "boolean",
"description": "Drop data: URI images from the Markdown, keeping alt text. Default true."
},
"verify": {
"type": "object",
"description": "Checks on final delivery; passed covers configured checks only. Inspect failure/readiness before retrying. tableRowsMin needs tables format (zero-based columns); recordFields uniqueBy counts complete extracted identities; markdownExcludes needs another check beside it. Markdown checks need markdown format.",
"properties": {
"checks": {
"type": "array",
"minItems": 1,
"maxItems": 32,
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"markdownIncludes",
"markdownExcludes",
"markdownMatches",
"markdownCountMin",
"minTables",
"tableRowsMin",
"listRecordsMin",
"recordFields",
"field"
]
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"pattern": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"flags": {
"type": "string",
"pattern": "^[imsuy]*$"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"fields": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1000
}
},
"uniqueBy": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1000
}
},
"tableIndex": {
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"columns": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"uniqueItems": true,
"items": {
"type": "integer",
"minimum": 0,
"maximum": 1000000
}
},
"equals": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"in": {
"type": "array",
"minItems": 1,
"maxItems": 32,
"items": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"present": {
"type": "boolean"
}
},
"required": [
"type"
],
"additionalProperties": false
}
},
"emptyOk": {
"type": "boolean",
"description": "An empty result (empty_verified, e.g. no search hits) passes. Default false."
}
},
"required": [
"checks"
],
"additionalProperties": false
},
"integration": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[\\x21-\\x7e]+$",
"description": "Your workflow label; recorded, not sent to sites."
}
},
"required": [
"url"
],
"additionalProperties": false
}