Web Tools and Web Tasks for AI agents. 100-credit MCP trial; API-key credits or x402.
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Runs actions against an open session and returns the resulting state. Actions: {navigate}, {click:{ref}}, {type:{ref,text,clear}}, {select:{ref,value}}, {press}, {scroll}, {wait}, {back}. The `ref` is the one `controls` gave you. It stops at the first failure and tells you where. $0.0005 (0.25 credit) per action, plus requested outputs and any outstanding browser time. API key and credits required. Reference for the oassis API: https://oassis.dev/openapi.json
What to do, in order: click, type, select, scroll, hover, press, navigate, wait. One to twenty-five per call.
The session to act on, from `web_session_open`.
Options for the `pdf` format: `format` (a4, letter, legal…), `landscape`, `printBackground`, `scale` 0.1 to 2.
Page to process.
For the `json` format: a `prompt` describing what to pull out, a JSON `schema` to fill, or both.
When to consider the page loaded: `until` (load, domcontentloaded, networkidle0, networkidle2), `selector` to wait for, `timeout` in ms.
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`.
Options for the `links` format: `visibleOnly`, `excludeExternal` to keep only internal links.
Accept an answer up to this many milliseconds old. A cache hit costs $0.0002 instead of the format price. Leave it out to force a fresh render.
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`.
How to make the request: `headers`, `cookies`, `userAgent`, and `auth` for basic authentication.
How a screenshot or a PDF comes back. `base64` is the only value today.
Options for the `controls` format: `visibleOnly`, and `limit` (1 to 1000) to cut the map.
The window to render in: `width`, `height`, `deviceScaleFactor`.
CSS selectors for the `elements` format.
Options for the `screenshot` format: `fullPage` for the whole page, `type` (png, jpeg, webp), `quality` 1-100 (not with png), `omitBackground`, `selector` to capture one element, and its own `viewport`.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Runs actions against an open session and returns the resulting state. Actions: {navigate}, {click:{ref}}, {type:{ref,text,clear}}, {select:{ref,value}}, {press}, {scroll}, {wait}, {back}. The `ref` is the one `controls` gave you. It stops at the first failure and tells you where. $0.0005 (0.25 credit) per action, plus requested outputs and any outstanding browser time. API key and credits required. Reference for the oassis API: https://oassis.dev/openapi.json
| Argument | Type | Description |
|---|---|---|
| object | Options for the `pdf` format: `format` (a4, letter, legal…), `landscape`, `printBackground`, `scale` 0.1 to 2. | |
| url | string | Page to process. |
| json | object | For the `json` format: a `prompt` describing what to pull out, a JSON `schema` to fill, or both. |
| wait | object | When to consider the page loaded: `until` (load, domcontentloaded, networkidle0, networkidle2), `selector` to wait for, `timeout` in ms. |
| block | object | 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`. |
| links | object | Options for the `links` format: `visibleOnly`, `excludeExternal` to keep only internal links. |
| maxAge | integer | Accept an answer up to this many milliseconds old. A cache hit costs $0.0002 instead of the format price. Leave it out to force a fresh render. |
| actions* | array | What to do, in order: click, type, select, scroll, hover, press, navigate, wait. One to twenty-five per call. |
| formats | array | 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`. |
| request | object | How to make the request: `headers`, `cookies`, `userAgent`, and `auth` for basic authentication. |
| binaryAs | string | How a screenshot or a PDF comes back. `base64` is the only value today. |
| controls | object | Options for the `controls` format: `visibleOnly`, and `limit` (1 to 1000) to cut the map. |
| viewport | object | The window to render in: `width`, `height`, `deviceScaleFactor`. |
| selectors | array | CSS selectors for the `elements` format. |
| sessionId* | string | The session to act on, from `web_session_open`. |
| screenshot | object | Options for the `screenshot` format: `fullPage` for the whole page, `type` (png, jpeg, webp), `quality` 1-100 (not with png), `omitBackground`, `selector` to capture one element, and its own `viewport`. |
{
"type": "object",
"required": [
"sessionId",
"actions"
],
"properties": {
"pdf": {
"type": "object",
"properties": {
"scale": {
"type": "number",
"maximum": 2,
"minimum": 0.1
},
"format": {
"enum": [
"letter",
"legal",
"tabloid",
"ledger",
"a0",
"a1",
"a2",
"a3",
"a4",
"a5",
"a6"
],
"type": "string"
},
"landscape": {
"type": "boolean"
},
"printBackground": {
"type": "boolean"
}
},
"description": "Options for the `pdf` format: `format` (a4, letter, legal…), `landscape`, `printBackground`, `scale` 0.1 to 2.",
"additionalProperties": false
},
"url": {
"type": "string",
"format": "uri",
"description": "Page to process."
},
"json": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"minLength": 1
},
"schema": {
"type": "object",
"additionalProperties": {}
}
},
"description": "For the `json` format: a `prompt` describing what to pull out, a JSON `schema` to fill, or both.",
"additionalProperties": false
},
"wait": {
"type": "object",
"properties": {
"until": {
"enum": [
"load",
"domcontentloaded",
"networkidle0",
"networkidle2"
],
"type": "string"
},
"timeout": {
"type": "integer",
"maximum": 60000,
"minimum": 100
},
"selector": {
"type": "string",
"minLength": 1
}
},
"description": "When to consider the page loaded: `until` (load, domcontentloaded, networkidle0, networkidle2), `selector` to wait for, `timeout` in ms.",
"additionalProperties": false
},
"block": {
"type": "object",
"properties": {
"urlPatterns": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"resourceTypes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"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`.",
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"visibleOnly": {
"type": "boolean"
},
"excludeExternal": {
"type": "boolean"
}
},
"description": "Options for the `links` format: `visibleOnly`, `excludeExternal` to keep only internal links.",
"additionalProperties": false
},
"maxAge": {
"type": "integer",
"maximum": 604800000,
"minimum": 0,
"description": "Accept an answer up to this many milliseconds old. A cache hit costs $0.0002 instead of the format price. Leave it out to force a fresh render."
},
"actions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"navigate"
],
"properties": {
"navigate": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"click"
],
"properties": {
"click": {
"type": "object",
"properties": {
"ref": {
"type": "string",
"minLength": 1
},
"selector": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "object",
"required": [
"text"
],
"properties": {
"ref": {
"type": "string",
"minLength": 1
},
"text": {
"type": "string"
},
"clear": {
"type": "boolean"
},
"selector": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"select"
],
"properties": {
"select": {
"type": "object",
"required": [
"value"
],
"properties": {
"ref": {
"type": "string",
"minLength": 1
},
"value": {
"type": "string"
},
"selector": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"press"
],
"properties": {
"press": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"scroll"
],
"properties": {
"scroll": {
"type": "object",
"properties": {
"by": {
"type": "number"
},
"to": {
"enum": [
"top",
"bottom"
],
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"wait"
],
"properties": {
"wait": {
"type": "object",
"properties": {
"ms": {
"type": "integer",
"maximum": 30000,
"minimum": 0
},
"selector": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"back"
],
"properties": {
"back": {
"type": "boolean",
"const": true
}
},
"additionalProperties": false
}
]
},
"maxItems": 25,
"minItems": 1,
"description": "What to do, in order: click, type, select, scroll, hover, press, navigate, wait. One to twenty-five per call."
},
"formats": {
"type": "array",
"items": {
"enum": [
"html",
"markdown",
"links",
"screenshot",
"pdf",
"elements",
"json",
"accessibility",
"controls"
],
"type": "string"
},
"default": [
"controls"
],
"maxItems": 9,
"minItems": 1,
"description": "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`."
},
"request": {
"type": "object",
"properties": {
"auth": {
"type": "object",
"required": [
"username",
"password"
],
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"cookies": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"path": {
"type": "string"
},
"value": {
"type": "string"
},
"domain": {
"type": "string"
},
"secure": {
"type": "boolean"
},
"httpOnly": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"userAgent": {
"type": "string",
"minLength": 1
}
},
"description": "How to make the request: `headers`, `cookies`, `userAgent`, and `auth` for basic authentication.",
"additionalProperties": false
},
"binaryAs": {
"enum": [
"base64"
],
"type": "string",
"default": "base64",
"description": "How a screenshot or a PDF comes back. `base64` is the only value today."
},
"controls": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1
},
"visibleOnly": {
"type": "boolean"
}
},
"description": "Options for the `controls` format: `visibleOnly`, and `limit` (1 to 1000) to cut the map.",
"additionalProperties": false
},
"viewport": {
"type": "object",
"required": [
"width",
"height"
],
"properties": {
"width": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"height": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"deviceScaleFactor": {
"type": "number",
"maximum": 3,
"minimum": 0.1
}
},
"description": "The window to render in: `width`, `height`, `deviceScaleFactor`.",
"additionalProperties": false
},
"selectors": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "CSS selectors for the `elements` format."
},
"sessionId": {
"type": "string",
"minLength": 1,
"description": "The session to act on, from `web_session_open`."
},
"screenshot": {
"type": "object",
"properties": {
"type": {
"enum": [
"png",
"jpeg",
"webp"
],
"type": "string"
},
"quality": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"fullPage": {
"type": "boolean"
},
"selector": {
"type": "string",
"minLength": 1
},
"viewport": {
"type": "object",
"required": [
"width",
"height"
],
"properties": {
"width": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"height": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"deviceScaleFactor": {
"type": "number",
"maximum": 3,
"minimum": 0.1
}
},
"additionalProperties": false
},
"omitBackground": {
"type": "boolean"
}
},
"description": "Options for the `screenshot` format: `fullPage` for the whole page, `type` (png, jpeg, webp), `quality` 1-100 (not with png), `omitBackground`, `selector` to capture one element, and its own `viewport`.",
"additionalProperties": false
}
}
}Checks a batch of scrapes: status, how many are done, and the results. Free for the owning account. Pass `cancel: true` to stop it.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | The batch, from web_scrape_batch. |
| limit | number | Results to return (default 50). |
| cancel | boolean | Stop pending pages and refund pages that never started. An in-flight read may finish and is billed; failed reads are refunded. |
{
"type": "object",
"required": [
"jobId"
],
"properties": {
"jobId": {
"type": "string",
"description": "The batch, from web_scrape_batch."
},
"limit": {
"type": "number",
"description": "Results to return (default 50)."
},
"cancel": {
"type": "boolean",
"description": "Stop pending pages and refund pages that never started. An in-flight read may finish and is billed; failed reads are refunded."
}
}
}Follows a site's links and reads every page. Returns a jobId; poll it with web_crawl_status. API key and credits required; `limit` controls the maximum pages charged. Use web_map first if you only need the urls. Reference for the oassis API: https://oassis.dev/openapi.json
| Argument | Type | Description |
|---|---|---|
| url* | string | Page to process. |
| json | object | For the `json` format: a `prompt` describing what to pull out, a JSON `schema` to fill, or both. |
| wait | object | When to consider the page loaded: `until` (load, domcontentloaded, networkidle0, networkidle2), `selector` to wait for, `timeout` in ms. |
| block | object | 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`. |
| limit | integer | Pages this crawl may read, up to 200. Charged up front; what it does not read comes back. |
| links | object | Options for the `links` format: `visibleOnly`, `excludeExternal` to keep only internal links. |
| maxAge | integer | Accept an answer up to this many milliseconds old. A cache hit costs $0.0002 instead of the format price. Leave it out to force a fresh render. |
Checks a crawl: status, pages read, discovered and still queued, and the pages themselves. Free for the owning account. Pass `cancel: true` to stop it.
| Argument | Type | Description |
|---|---|---|
| jobId* | string | The crawl, from web_crawl. |
| limit | number | Pages to return (default 50). |
| cancel | boolean | Stop pending pages and refund pages that never started. An in-flight read may finish and is billed; failed reads are refunded. |
{
"type": "object",
"required": [
"jobId"
],
"properties": {
"jobId": {
"type": "string",
"description": "The crawl, from web_crawl."
},
"limit": {
"type": "number",
"description": "Pages to return (default 50)."
},
"cancel": {
"type": "boolean",
"description": "Stop pending pages and refund pages that never started. An in-flight read may finish and is billed; failed reads are refunded."
}
}
}Tell us an answer was good or bad. FREE. Use it when a result is wrong — empty markdown, a control map missing a button, data that does not match the page — with the url or the jobId so it can be reproduced. It is the only way we learn that we read a page badly: our logs cannot tell that apart from a page that is simply like that. Reference for the oassis API: https://oassis.dev/openapi.json
| Argument | Type | Description |
|---|---|---|
| url | string | The page that came out wrong: usually the fastest way to reproduce it. |
| route | string | Which tool or endpoint it is about, as you called it. |
| comment | string | What you expected and what you got. |
| verdict* | string | Did the answer do the job or not. |
| reference | string | The jobId or sessionId it happened on, so it can be looked up. |
{
"type": "object",
"required": [
"verdict"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "The page that came out wrong: usually the fastest way to reproduce it."
},
"route": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Which tool or endpoint it is about, as you called it."
},
"comment": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "What you expected and what you got."
},
"verdict": {
"enum": [
"good",
"bad"
],
"type": "string",
"description": "Did the answer do the job or not."
},
"reference": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The jobId or sessionId it happened on, so it can be looked up."
}
}
}Every url of a site, fast and cheap: its sitemap plus, optionally, the links on the page. Use it BEFORE crawling, to see what is there and decide what is worth reading. 1 credit ($0.002) with `includePage: false` (no browser at all), 1.5 credits ($0.003) with the page. Reference for the oassis API: https://oassis.dev/openapi.json
| Argument | Type | Description |
|---|---|---|
| url* | string | Page to process. |
| limit | integer | Urls to return. Up to 5000. |
| search | string | Keep only urls containing this text. |
| includePage | boolean | Render the page too, to catch urls the sitemap does not list. `false` uses no browser at all, so it costs less: $0.002 against $0.003. |
| excludePaths | array | Discard urls whose path contains one of these. Up to twenty. It wins over `includePaths`. |
| includePaths | array | Keep only urls whose path contains one of these. Up to twenty. |
| includeSubdomains | boolean | Treat subdomains of the same site as part of it. |
Processes a page and returns every output you ask for at once: markdown, html, links, screenshot, PDF, accessibility tree, elements by selector, AI-structured data, and `controls` (what can be clicked). One call, and a partial failure does not void the rest. From 1 credit ($0.002) per output. A url pointing at a PDF, Word, Excel or CSV file is converted to markdown instead, with no browser, for $0.002. Reference for the oassis API: https://oassis.dev/openapi.json
| Argument | Type | Description |
|---|---|---|
| object | Options for the `pdf` format: `format` (a4, letter, legal…), `landscape`, `printBackground`, `scale` 0.1 to 2. | |
| url | string | Page to process. |
| html | string | Raw HTML instead of `url`, for a page you already have. Nothing leaves for the network. |
| json | object | For the `json` format: a `prompt` describing what to pull out, a JSON `schema` to fill, or both. |
| wait | object | When to consider the page loaded: `until` (load, domcontentloaded, networkidle0, networkidle2), `selector` to wait for, `timeout` in ms. |
| block | object | 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`. |
A batch OF SCRAPES: reads a list of urls YOU give it (2 to 50, from any sites) and returns a jobId. It discovers nothing on its own — for that use web_crawl. API key and credits required. Poll it with web_batch_status.
| Argument | Type | Description |
|---|---|---|
| json | object | For the `json` format: a `prompt` describing what to pull out, a JSON `schema` to fill, or both. |
| urls* | array | The pages of this batch. Two to fifty, no duplicates: a batch charges per url. |
| wait | object | When to consider the page loaded: `until` (load, domcontentloaded, networkidle0, networkidle2), `selector` to wait for, `timeout` in ms. |
| block | object | 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`. |
| links | object | Options for the `links` format: `visibleOnly`, `excludeExternal` to keep only internal links. |
| maxAge | integer | Accept an answer up to this many milliseconds old. A cache hit costs $0.0002 instead of the format price. Leave it out to force a fresh render. |
| formats | array |
Search the web with Exa's index: a query instead of a url, for when you do not know where to look. Returns title, url and a snippet per result. To read the pages, pass the urls to web_scrape_batch. The engine is named because the price is Exa's, passed through with no markup and read from its own payment challenge on every call — the quote is read at execution time and is not a guaranteed fixed price. API key and credits required over MCP.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results to return. Up to 50. |
| query* | string | What to search for. |
| since | string | Only results published after this ISO date. |
| domains | array | Only these domains, subdomains included: `example.com` also matches `docs.example.com`. |
| snippets | boolean | Text alongside each result. On by default: a bare url is rarely enough. |
| excludeDomains | array | Never these domains, subdomains included. |
{
"type": "object",
"required": [
"query"
],
"properties": {
"limit": {
"type": "integer",
"default": 10,
"maximum": 50,
"minimum": 1,
"description": "Results to return. Up to 50."
},
"query": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "What to search for."
},
"since": {
"type": "string",
"maxLength": 30,
"minLength": 4,
"description": "Only results published after this ISO date."
},
"domains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 20,
"description": "Only these domains, subdomains included: `example.com` also matches `docs.example.com`."
},
"snippets": {
"type": "boolean",
"description": "Text alongside each result. On by default: a bare url is rarely enough."
},
"excludeDomains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 20,
"description": "Never these domains, subdomains included."
}
}
}Closes the browser session and stops its time. HTTP equivalent: POST /web/v1/session/{id}/close. No additional close fee; outstanding browser time is settled when applicable. If you do not close it, it closes itself after a minute without use.
| Argument | Type | Description |
|---|---|---|
| sessionId* | string | The session to close, from web_session_open. |
{
"type": "object",
"required": [
"sessionId"
],
"properties": {
"sessionId": {
"type": "string",
"description": "The session to close, from web_session_open."
}
}
}Opens a browser session and returns the map of controls. Opening costs 2.5 credits plus the requested outputs; the first minute is included. Further started minutes cost 2 credits with an account key. Use web_act to interact and web_session_close when done. API key and credits required. Reference: https://oassis.dev/openapi.json
| Argument | Type | Description |
|---|---|---|
| object | Options for the `pdf` format: `format` (a4, letter, legal…), `landscape`, `printBackground`, `scale` 0.1 to 2. | |
| url* | string | Page to process. |
| json | object | For the `json` format: a `prompt` describing what to pull out, a JSON `schema` to fill, or both. |
| wait | object | When to consider the page loaded: `until` (load, domcontentloaded, networkidle0, networkidle2), `selector` to wait for, `timeout` in ms. |
| block | object | 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`. |
| links | object | Options for the `links` format: `visibleOnly`, `excludeExternal` to keep only internal links. |
| maxAge | integer | Accept an answer up to this many milliseconds old. A cache hit costs $0.0002 instead of the format price. Leave it out to force a fresh render. |
Stops a task using its owning API key, or its legacy access_token. No new operations start. Cancellation is free; unused account credit reservations are released. Cancelling a finished task changes nothing.
| Argument | Type | Description |
|---|---|---|
| id* | string | The task id, from web_task_start. |
| access_token | string | Task-scoped access token returned by web_task_start; not an API key. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The task id, from web_task_start."
},
"access_token": {
"type": "string",
"description": "Task-scoped access token returned by web_task_start; not an API key."
}
}
}Starts a research task: a question answered by reading public pages, with sources, progress and cost. Requires an API key and credits. The maximum budget is reserved, actual execution cost is charged, and unused credits are released. Returns a task id: check it with web_task_status.
| Argument | Type | Description |
|---|---|---|
| mode | string | Only research is available: read public pages and answer. |
| task* | string | What to find out, in plain words. Be specific about what to compare. |
| urls | array | Pages to read first, up to 5. Public http or https urls only. |
| limits | object | Bounds on cost, time and steps. |
{
"type": "object",
"required": [
"task"
],
"properties": {
"mode": {
"enum": [
"research"
],
"type": "string",
"default": "research",
"description": "Only research is available: read public pages and answer."
},
"task": {
"type": "string",
"maxLength": 2000,
"minLength": 10,
"description": "What to find out, in plain words. Be specific about what to compare."
},
"urls": {
"type": "array",
"items": {
"type": "string",
"format": "uri",
"maxLength": 500
},
"default": [],
"maxItems": 5,
"description": "Pages to read first, up to 5. Public http or https urls only."
},
"limits": {
"type": "object",
"default": {},
"properties": {
"max_steps": {
"type": "integer",
"default": 10,
"maximum": 20,
"minimum": 1,
"description": "Most decisions the planner may take."
},
"max_cost_usd": {
"type": "number",
"default": 0.1,
"maximum": 1,
"minimum": 0.03,
"description": "Most the task may cost, in USD. Execution budget. Reserved against account credits over MCP/HTTP with an API key; charged as a fixed package over HTTP/x402. No automatic on-chain refund."
},
"max_duration_seconds": {
"type": "integer",
"default": 180,
"maximum": 900,
"minimum": 30,
"description": "Longest the task may run, in seconds."
}
},
"description": "Bounds on cost, time and steps.",
"additionalProperties": false
}
}
}Returns a task's status, progress, sources, limitations, result and billing. Only your own tasks.
| Argument | Type | Description |
|---|---|---|
| id* | string | The task id, from web_task_start. |
| access_token | string | Task-scoped access token returned by web_task_start; not an API key. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The task id, from web_task_start."
},
"access_token": {
"type": "string",
"description": "Task-scoped access token returned by web_task_start; not an API key."
}
}
}| formats | array | 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. |
| request | object | How to make the request: `headers`, `cookies`, `userAgent`, and `auth` for basic authentication. |
| binaryAs | string | How a screenshot or a PDF comes back. `base64` is the only value today. |
| controls | object | Options for the `controls` format: `visibleOnly`, and `limit` (1 to 1000) to cut the map. |
| maxDepth | integer | How far from the starting page to follow links. 0 reads only the starting page. |
| viewport | object | The window to render in: `width`, `height`, `deviceScaleFactor`. |
| selectors | array | CSS selectors for the `elements` format. |
| excludePaths | array | Discard urls whose path contains one of these. Up to twenty. It wins over `includePaths`. |
| includePaths | array | Keep only urls whose path contains one of these. Up to twenty. |
| includeSubdomains | boolean | Treat subdomains of the same site as part of it. |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Page to process."
},
"json": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"minLength": 1
},
"schema": {
"type": "object",
"additionalProperties": {}
}
},
"description": "For the `json` format: a `prompt` describing what to pull out, a JSON `schema` to fill, or both.",
"additionalProperties": false
},
"wait": {
"type": "object",
"properties": {
"until": {
"enum": [
"load",
"domcontentloaded",
"networkidle0",
"networkidle2"
],
"type": "string"
},
"timeout": {
"type": "integer",
"maximum": 60000,
"minimum": 100
},
"selector": {
"type": "string",
"minLength": 1
}
},
"description": "When to consider the page loaded: `until` (load, domcontentloaded, networkidle0, networkidle2), `selector` to wait for, `timeout` in ms.",
"additionalProperties": false
},
"block": {
"type": "object",
"properties": {
"urlPatterns": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"resourceTypes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"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`.",
"additionalProperties": false
},
"limit": {
"type": "integer",
"default": 25,
"maximum": 200,
"minimum": 1,
"description": "Pages this crawl may read, up to 200. Charged up front; what it does not read comes back."
},
"links": {
"type": "object",
"properties": {
"visibleOnly": {
"type": "boolean"
},
"excludeExternal": {
"type": "boolean"
}
},
"description": "Options for the `links` format: `visibleOnly`, `excludeExternal` to keep only internal links.",
"additionalProperties": false
},
"maxAge": {
"type": "integer",
"maximum": 604800000,
"minimum": 0,
"description": "Accept an answer up to this many milliseconds old. A cache hit costs $0.0002 instead of the format price. Leave it out to force a fresh render."
},
"formats": {
"type": "array",
"items": {
"enum": [
"html",
"markdown",
"links",
"elements",
"json",
"accessibility",
"controls"
],
"type": "string"
},
"description": "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."
},
"request": {
"type": "object",
"properties": {
"auth": {
"type": "object",
"required": [
"username",
"password"
],
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"cookies": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"path": {
"type": "string"
},
"value": {
"type": "string"
},
"domain": {
"type": "string"
},
"secure": {
"type": "boolean"
},
"httpOnly": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"userAgent": {
"type": "string",
"minLength": 1
}
},
"description": "How to make the request: `headers`, `cookies`, `userAgent`, and `auth` for basic authentication.",
"additionalProperties": false
},
"binaryAs": {
"enum": [
"base64"
],
"type": "string",
"default": "base64",
"description": "How a screenshot or a PDF comes back. `base64` is the only value today."
},
"controls": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1
},
"visibleOnly": {
"type": "boolean"
}
},
"description": "Options for the `controls` format: `visibleOnly`, and `limit` (1 to 1000) to cut the map.",
"additionalProperties": false
},
"maxDepth": {
"type": "integer",
"default": 2,
"maximum": 5,
"minimum": 0,
"description": "How far from the starting page to follow links. 0 reads only the starting page."
},
"viewport": {
"type": "object",
"required": [
"width",
"height"
],
"properties": {
"width": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"height": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"deviceScaleFactor": {
"type": "number",
"maximum": 3,
"minimum": 0.1
}
},
"description": "The window to render in: `width`, `height`, `deviceScaleFactor`.",
"additionalProperties": false
},
"selectors": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "CSS selectors for the `elements` format."
},
"excludePaths": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 20,
"description": "Discard urls whose path contains one of these. Up to twenty. It wins over `includePaths`."
},
"includePaths": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 20,
"description": "Keep only urls whose path contains one of these. Up to twenty."
},
"includeSubdomains": {
"type": "boolean",
"description": "Treat subdomains of the same site as part of it."
}
}
}{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Page to process."
},
"limit": {
"type": "integer",
"default": 1000,
"maximum": 5000,
"minimum": 1,
"description": "Urls to return. Up to 5000."
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Keep only urls containing this text."
},
"includePage": {
"type": "boolean",
"description": "Render the page too, to catch urls the sitemap does not list. `false` uses no browser at all, so it costs less: $0.002 against $0.003."
},
"excludePaths": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 20,
"description": "Discard urls whose path contains one of these. Up to twenty. It wins over `includePaths`."
},
"includePaths": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 20,
"description": "Keep only urls whose path contains one of these. Up to twenty."
},
"includeSubdomains": {
"type": "boolean",
"description": "Treat subdomains of the same site as part of it."
}
}
}| links |
| object |
| Options for the `links` format: `visibleOnly`, `excludeExternal` to keep only internal links. |
| maxAge | integer | Accept an answer up to this many milliseconds old. A cache hit costs $0.0002 instead of the format price. Leave it out to force a fresh render. |
| formats | array | 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`. |
| request | object | How to make the request: `headers`, `cookies`, `userAgent`, and `auth` for basic authentication. |
| binaryAs | string | How a screenshot or a PDF comes back. `base64` is the only value today. |
| controls | object | Options for the `controls` format: `visibleOnly`, and `limit` (1 to 1000) to cut the map. |
| viewport | object | The window to render in: `width`, `height`, `deviceScaleFactor`. |
| selectors | array | CSS selectors for the `elements` format. |
| screenshot | object | Options for the `screenshot` format: `fullPage` for the whole page, `type` (png, jpeg, webp), `quality` 1-100 (not with png), `omitBackground`, `selector` to capture one element, and its own `viewport`. |
{
"type": "object",
"properties": {
"pdf": {
"type": "object",
"properties": {
"scale": {
"type": "number",
"maximum": 2,
"minimum": 0.1
},
"format": {
"enum": [
"letter",
"legal",
"tabloid",
"ledger",
"a0",
"a1",
"a2",
"a3",
"a4",
"a5",
"a6"
],
"type": "string"
},
"landscape": {
"type": "boolean"
},
"printBackground": {
"type": "boolean"
}
},
"description": "Options for the `pdf` format: `format` (a4, letter, legal…), `landscape`, `printBackground`, `scale` 0.1 to 2.",
"additionalProperties": false
},
"url": {
"type": "string",
"format": "uri",
"description": "Page to process."
},
"html": {
"type": "string",
"minLength": 1,
"description": "Raw HTML instead of `url`, for a page you already have. Nothing leaves for the network."
},
"json": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"minLength": 1
},
"schema": {
"type": "object",
"additionalProperties": {}
}
},
"description": "For the `json` format: a `prompt` describing what to pull out, a JSON `schema` to fill, or both.",
"additionalProperties": false
},
"wait": {
"type": "object",
"properties": {
"until": {
"enum": [
"load",
"domcontentloaded",
"networkidle0",
"networkidle2"
],
"type": "string"
},
"timeout": {
"type": "integer",
"maximum": 60000,
"minimum": 100
},
"selector": {
"type": "string",
"minLength": 1
}
},
"description": "When to consider the page loaded: `until` (load, domcontentloaded, networkidle0, networkidle2), `selector` to wait for, `timeout` in ms.",
"additionalProperties": false
},
"block": {
"type": "object",
"properties": {
"urlPatterns": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"resourceTypes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"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`.",
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"visibleOnly": {
"type": "boolean"
},
"excludeExternal": {
"type": "boolean"
}
},
"description": "Options for the `links` format: `visibleOnly`, `excludeExternal` to keep only internal links.",
"additionalProperties": false
},
"maxAge": {
"type": "integer",
"maximum": 604800000,
"minimum": 0,
"description": "Accept an answer up to this many milliseconds old. A cache hit costs $0.0002 instead of the format price. Leave it out to force a fresh render."
},
"formats": {
"type": "array",
"items": {
"enum": [
"html",
"markdown",
"links",
"screenshot",
"pdf",
"elements",
"json",
"accessibility",
"controls"
],
"type": "string"
},
"default": [
"markdown"
],
"maxItems": 9,
"minItems": 1,
"description": "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`."
},
"request": {
"type": "object",
"properties": {
"auth": {
"type": "object",
"required": [
"username",
"password"
],
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"cookies": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"path": {
"type": "string"
},
"value": {
"type": "string"
},
"domain": {
"type": "string"
},
"secure": {
"type": "boolean"
},
"httpOnly": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"userAgent": {
"type": "string",
"minLength": 1
}
},
"description": "How to make the request: `headers`, `cookies`, `userAgent`, and `auth` for basic authentication.",
"additionalProperties": false
},
"binaryAs": {
"enum": [
"base64"
],
"type": "string",
"default": "base64",
"description": "How a screenshot or a PDF comes back. `base64` is the only value today."
},
"controls": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1
},
"visibleOnly": {
"type": "boolean"
}
},
"description": "Options for the `controls` format: `visibleOnly`, and `limit` (1 to 1000) to cut the map.",
"additionalProperties": false
},
"viewport": {
"type": "object",
"required": [
"width",
"height"
],
"properties": {
"width": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"height": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"deviceScaleFactor": {
"type": "number",
"maximum": 3,
"minimum": 0.1
}
},
"description": "The window to render in: `width`, `height`, `deviceScaleFactor`.",
"additionalProperties": false
},
"selectors": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "CSS selectors for the `elements` format."
},
"screenshot": {
"type": "object",
"properties": {
"type": {
"enum": [
"png",
"jpeg",
"webp"
],
"type": "string"
},
"quality": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"fullPage": {
"type": "boolean"
},
"selector": {
"type": "string",
"minLength": 1
},
"viewport": {
"type": "object",
"required": [
"width",
"height"
],
"properties": {
"width": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"height": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"deviceScaleFactor": {
"type": "number",
"maximum": 3,
"minimum": 0.1
}
},
"additionalProperties": false
},
"omitBackground": {
"type": "boolean"
}
},
"description": "Options for the `screenshot` format: `fullPage` for the whole page, `type` (png, jpeg, webp), `quality` 1-100 (not with png), `omitBackground`, `selector` to capture one element, and its own `viewport`.",
"additionalProperties": false
}
}
}| 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. |
| request | object | How to make the request: `headers`, `cookies`, `userAgent`, and `auth` for basic authentication. |
| binaryAs | string | How a screenshot or a PDF comes back. `base64` is the only value today. |
| controls | object | Options for the `controls` format: `visibleOnly`, and `limit` (1 to 1000) to cut the map. |
| viewport | object | The window to render in: `width`, `height`, `deviceScaleFactor`. |
| selectors | array | CSS selectors for the `elements` format. |
{
"type": "object",
"required": [
"urls"
],
"properties": {
"json": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"minLength": 1
},
"schema": {
"type": "object",
"additionalProperties": {}
}
},
"description": "For the `json` format: a `prompt` describing what to pull out, a JSON `schema` to fill, or both.",
"additionalProperties": false
},
"urls": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"maxItems": 50,
"minItems": 2,
"description": "The pages of this batch. Two to fifty, no duplicates: a batch charges per url."
},
"wait": {
"type": "object",
"properties": {
"until": {
"enum": [
"load",
"domcontentloaded",
"networkidle0",
"networkidle2"
],
"type": "string"
},
"timeout": {
"type": "integer",
"maximum": 60000,
"minimum": 100
},
"selector": {
"type": "string",
"minLength": 1
}
},
"description": "When to consider the page loaded: `until` (load, domcontentloaded, networkidle0, networkidle2), `selector` to wait for, `timeout` in ms.",
"additionalProperties": false
},
"block": {
"type": "object",
"properties": {
"urlPatterns": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"resourceTypes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"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`.",
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"visibleOnly": {
"type": "boolean"
},
"excludeExternal": {
"type": "boolean"
}
},
"description": "Options for the `links` format: `visibleOnly`, `excludeExternal` to keep only internal links.",
"additionalProperties": false
},
"maxAge": {
"type": "integer",
"maximum": 604800000,
"minimum": 0,
"description": "Accept an answer up to this many milliseconds old. A cache hit costs $0.0002 instead of the format price. Leave it out to force a fresh render."
},
"formats": {
"type": "array",
"items": {
"enum": [
"html",
"markdown",
"links",
"elements",
"json",
"accessibility",
"controls"
],
"type": "string"
},
"description": "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."
},
"request": {
"type": "object",
"properties": {
"auth": {
"type": "object",
"required": [
"username",
"password"
],
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"cookies": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"path": {
"type": "string"
},
"value": {
"type": "string"
},
"domain": {
"type": "string"
},
"secure": {
"type": "boolean"
},
"httpOnly": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"userAgent": {
"type": "string",
"minLength": 1
}
},
"description": "How to make the request: `headers`, `cookies`, `userAgent`, and `auth` for basic authentication.",
"additionalProperties": false
},
"binaryAs": {
"enum": [
"base64"
],
"type": "string",
"default": "base64",
"description": "How a screenshot or a PDF comes back. `base64` is the only value today."
},
"controls": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1
},
"visibleOnly": {
"type": "boolean"
}
},
"description": "Options for the `controls` format: `visibleOnly`, and `limit` (1 to 1000) to cut the map.",
"additionalProperties": false
},
"viewport": {
"type": "object",
"required": [
"width",
"height"
],
"properties": {
"width": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"height": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"deviceScaleFactor": {
"type": "number",
"maximum": 3,
"minimum": 0.1
}
},
"description": "The window to render in: `width`, `height`, `deviceScaleFactor`.",
"additionalProperties": false
},
"selectors": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "CSS selectors for the `elements` format."
}
}
}| formats | array | 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`. |
| request | object | How to make the request: `headers`, `cookies`, `userAgent`, and `auth` for basic authentication. |
| binaryAs | string | How a screenshot or a PDF comes back. `base64` is the only value today. |
| controls | object | Options for the `controls` format: `visibleOnly`, and `limit` (1 to 1000) to cut the map. |
| viewport | object | The window to render in: `width`, `height`, `deviceScaleFactor`. |
| selectors | array | CSS selectors for the `elements` format. |
| screenshot | object | Options for the `screenshot` format: `fullPage` for the whole page, `type` (png, jpeg, webp), `quality` 1-100 (not with png), `omitBackground`, `selector` to capture one element, and its own `viewport`. |
{
"type": "object",
"required": [
"url"
],
"properties": {
"pdf": {
"type": "object",
"properties": {
"scale": {
"type": "number",
"maximum": 2,
"minimum": 0.1
},
"format": {
"enum": [
"letter",
"legal",
"tabloid",
"ledger",
"a0",
"a1",
"a2",
"a3",
"a4",
"a5",
"a6"
],
"type": "string"
},
"landscape": {
"type": "boolean"
},
"printBackground": {
"type": "boolean"
}
},
"description": "Options for the `pdf` format: `format` (a4, letter, legal…), `landscape`, `printBackground`, `scale` 0.1 to 2.",
"additionalProperties": false
},
"url": {
"type": "string",
"format": "uri",
"description": "Page to process."
},
"json": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"minLength": 1
},
"schema": {
"type": "object",
"additionalProperties": {}
}
},
"description": "For the `json` format: a `prompt` describing what to pull out, a JSON `schema` to fill, or both.",
"additionalProperties": false
},
"wait": {
"type": "object",
"properties": {
"until": {
"enum": [
"load",
"domcontentloaded",
"networkidle0",
"networkidle2"
],
"type": "string"
},
"timeout": {
"type": "integer",
"maximum": 60000,
"minimum": 100
},
"selector": {
"type": "string",
"minLength": 1
}
},
"description": "When to consider the page loaded: `until` (load, domcontentloaded, networkidle0, networkidle2), `selector` to wait for, `timeout` in ms.",
"additionalProperties": false
},
"block": {
"type": "object",
"properties": {
"urlPatterns": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"resourceTypes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"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`.",
"additionalProperties": false
},
"links": {
"type": "object",
"properties": {
"visibleOnly": {
"type": "boolean"
},
"excludeExternal": {
"type": "boolean"
}
},
"description": "Options for the `links` format: `visibleOnly`, `excludeExternal` to keep only internal links.",
"additionalProperties": false
},
"maxAge": {
"type": "integer",
"maximum": 604800000,
"minimum": 0,
"description": "Accept an answer up to this many milliseconds old. A cache hit costs $0.0002 instead of the format price. Leave it out to force a fresh render."
},
"formats": {
"type": "array",
"items": {
"enum": [
"html",
"markdown",
"links",
"screenshot",
"pdf",
"elements",
"json",
"accessibility",
"controls"
],
"type": "string"
},
"default": [
"controls"
],
"maxItems": 9,
"minItems": 1,
"description": "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`."
},
"request": {
"type": "object",
"properties": {
"auth": {
"type": "object",
"required": [
"username",
"password"
],
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
},
"cookies": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"path": {
"type": "string"
},
"value": {
"type": "string"
},
"domain": {
"type": "string"
},
"secure": {
"type": "boolean"
},
"httpOnly": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"userAgent": {
"type": "string",
"minLength": 1
}
},
"description": "How to make the request: `headers`, `cookies`, `userAgent`, and `auth` for basic authentication.",
"additionalProperties": false
},
"binaryAs": {
"enum": [
"base64"
],
"type": "string",
"default": "base64",
"description": "How a screenshot or a PDF comes back. `base64` is the only value today."
},
"controls": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1
},
"visibleOnly": {
"type": "boolean"
}
},
"description": "Options for the `controls` format: `visibleOnly`, and `limit` (1 to 1000) to cut the map.",
"additionalProperties": false
},
"viewport": {
"type": "object",
"required": [
"width",
"height"
],
"properties": {
"width": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"height": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"deviceScaleFactor": {
"type": "number",
"maximum": 3,
"minimum": 0.1
}
},
"description": "The window to render in: `width`, `height`, `deviceScaleFactor`.",
"additionalProperties": false
},
"selectors": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "CSS selectors for the `elements` format."
},
"screenshot": {
"type": "object",
"properties": {
"type": {
"enum": [
"png",
"jpeg",
"webp"
],
"type": "string"
},
"quality": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"fullPage": {
"type": "boolean"
},
"selector": {
"type": "string",
"minLength": 1
},
"viewport": {
"type": "object",
"required": [
"width",
"height"
],
"properties": {
"width": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"height": {
"type": "integer",
"maximum": 4096,
"minimum": 1
},
"deviceScaleFactor": {
"type": "number",
"maximum": 3,
"minimum": 0.1
}
},
"additionalProperties": false
},
"omitBackground": {
"type": "boolean"
}
},
"description": "Options for the `screenshot` format: `fullPage` for the whole page, `type` (png, jpeg, webp), `quality` 1-100 (not with png), `omitBackground`, `selector` to capture one element, and its own `viewport`.",
"additionalProperties": false
}
}
}