addedInput schema / properties / binaryAs
Added value: +{
+ "default": "base64",
+ "description": "How a screenshot or a PDF comes back. `base64` is the only value today.",
+ "enum": [
+ "base64",
+ "url"
+ ],
+ "type": "string"
+}
addedInput schema / properties / block
Added value: +{
+ "additionalProperties": false,
+ "description": "What not to load, which makes a render faster and cheaper. `resourceTypes` takes image, font, stylesheet, media… and `urlPatterns` are regular expressions, not globs: `\\.svg$`, not `*.svg`.",
+ "properties": {
+ "resourceTypes": {
+ "items": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "urlPatterns": {
+ "items": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+}
addedInput schema / properties / controls
Added value: +{
+ "additionalProperties": false,
+ "description": "Options for the `controls` format: `visibleOnly`, and `limit` (1 to 1000) to cut the map.",
+ "properties": {
+ "limit": {
+ "maximum": 1000,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "visibleOnly": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+}
addedInput schema / properties / excludePaths / description
Added value: +"Discard urls whose path contains one of these. Up to twenty. It wins over `includePaths`."
addedInput schema / properties / excludePaths / items / minLength
Added value: +1
addedInput schema / properties / excludePaths / maxItems
Added value: +20
changedInput schema / properties / formats / description
Previous value: -"Outputs you want in the same response. `controls` is the map of what can be clicked; `elements` needs `selectors`; `json` needs `json.prompt`."New value: +"Outputs you want in the same response. `controls` is the map of what can be clicked; `elements` needs `selectors`; `json` needs `json.prompt` or `json.schema`. A screenshot or a PDF is not available here: every result is kept until you collect it. Ask for those one url at a time on web_scrape."
changedInput schema / properties / formats / items / enum
Previous value: -[
- "html",
- "markdown",
- "links",
- "screenshot",
- "pdf",
- "elements",
- "json",
- "accessibility",
- "controls"
-]New value: +[
+ "html",
+ "markdown",
+ "links",
+ "elements",
+ "json",
+ "accessibility",
+ "controls"
+]
addedInput schema / properties / includePaths / description
Added value: +"Keep only urls whose path contains one of these. Up to twenty."
addedInput schema / properties / includePaths / items / minLength
Added value: +1
addedInput schema / properties / includePaths / maxItems
Added value: +20
addedInput schema / properties / includeSubdomains / description
Added value: +"Treat subdomains of the same site as part of it."
addedInput schema / properties / json
Added value: +{
+ "additionalProperties": false,
+ "description": "For the `json` format: a `prompt` describing what to pull out, a JSON `schema` to fill, or both.",
+ "properties": {
+ "model": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "prompt": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "schema": {
+ "additionalProperties": {},
+ "type": "object"
+ }
+ },
+ "type": "object"
+}
addedInput schema / properties / limit / default
Added value: +25
changedInput schema / properties / limit / description
Previous value: -"Pages it may read (default 25, max 200)."New value: +"Pages this crawl may read, up to 200. Charged up front; what it does not read comes back."
addedInput schema / properties / limit / maximum
Added value: +200
addedInput schema / properties / limit / minimum
Added value: +1
changedInput schema / properties / limit / type
Previous value: -"number"New value: +"integer"
addedInput schema / properties / links
Added value: +{
+ "additionalProperties": false,
+ "description": "Options for the `links` format: `visibleOnly`, `excludeExternal` to keep only internal links.",
+ "properties": {
+ "excludeExternal": {
+ "type": "boolean"
+ },
+ "visibleOnly": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+}
addedInput schema / properties / maxAge / maximum
Added value: +604800000
addedInput schema / properties / maxAge / minimum
Added value: +0
changedInput schema / properties / maxAge / type
Previous value: -"number"New value: +"integer"
addedInput schema / properties / maxDepth / default
Added value: +2
changedInput schema / properties / maxDepth / description
Previous value: -"How far to follow links (default 2, max 5)."New value: +"How far from the starting page to follow links. 0 reads only the starting page."
addedInput schema / properties / maxDepth / maximum
Added value: +5
addedInput schema / properties / maxDepth / minimum
Added value: +0
changedInput schema / properties / maxDepth / type
Previous value: -"number"New value: +"integer"
addedInput schema / properties / request
Added value: +{
+ "additionalProperties": false,
+ "description": "How to make the request: `headers`, `cookies`, `userAgent`, and `auth` for basic authentication.",
+ "properties": {
+ "auth": {
+ "additionalProperties": false,
+ "properties": {
+ "password": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "username",
+ "password"
+ ],
+ "type": "object"
+ },
+ "cookies": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "domain": {
+ "type": "string"
+ },
+ "httpOnly": {
+ "type": "boolean"
+ },
+ "name": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "secure": {
+ "type": "boolean"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "value"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "headers": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "userAgent": {
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "type": "object"
+}
addedInput schema / properties / selectors
Added value: +{
+ "description": "CSS selectors for the `elements` format.",
+ "items": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "minItems": 1,
+ "type": "array"
+}
changedInput schema / properties / url / description
Previous value: -"Where to start."New value: +"Page to process."
addedInput schema / properties / url / format
Added value: +"uri"
addedInput schema / properties / viewport
Added value: +{
+ "additionalProperties": false,
+ "description": "The window to render in: `width`, `height`, `deviceScaleFactor`.",
+ "properties": {
+ "deviceScaleFactor": {
+ "maximum": 3,
+ "minimum": 0.1,
+ "type": "number"
+ },
+ "height": {
+ "maximum": 4096,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "width": {
+ "maximum": 4096,
+ "minimum": 1,
+ "type": "integer"
+ }
+ },
+ "required": [
+ "width",
+ "height"
+ ],
+ "type": "object"
+}
addedInput schema / properties / wait
Added value: +{
+ "additionalProperties": false,
+ "description": "When to consider the page loaded: `until` (load, domcontentloaded, networkidle0, networkidle2), `selector` to wait for, `timeout` in ms.",
+ "properties": {
+ "selector": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "timeout": {
+ "maximum": 60000,
+ "minimum": 100,
+ "type": "integer"
+ },
+ "until": {
+ "enum": [
+ "load",
+ "domcontentloaded",
+ "networkidle0",
+ "networkidle2"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+}