Servers Playground How we check Add a server Log in

URLpipe

Working · 1.9 s

dev.urlpipe/mcpv1.4.0 Domain verified

Read any page with its JavaScript run: Markdown, screenshots, metadata, console errors, Lighthouse.

Web Search

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://urlpipe.dev/mcp

Authorization (required)

Bearer followed by a URLpipe organization token, created under Organization → MCP access at https://urlpipe.dev

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.

capture_console_errors

Exposes POST /console. Loads the page in headless Chrome and returns what it reported through console.error and console.warn during load, plus uncaught exceptions and unhandled promise rejections (not console.log). 1 credit. What you would open DevTools for: broken third-party scripts and client-side errors you cannot reproduce locally.

urlstring, required

The page to fetch. Must be a public http(s) URL.

project_idinteger, required

Which project this request belongs to. From list_projects.

syncboolean

Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.

labelsobject

Your own keys to find this request by later, e.g. {"client": "acme"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.

max_agestring

How fresh a stored result must be to be reused, e.g. "2 hours" or "3 days". Default 7 days, maximum 30. A reused result is free. Pass "0" to force a fresh fetch.

report_tostring

Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.

residentialboolean

Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic.

page_optionsobject

What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them.

idempotency_keystring

Makes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age "0". Up to 255 printable ASCII characters; a UUID is ideal.

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

URLpipe MCP server | mcptry

URLpipe

Working · 1.9 s

dev.urlpipe/mcpv1.4.0 Domain verified

Read any page with its JavaScript run: Markdown, screenshots, metadata, console errors, Lighthouse.

Web Search

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://urlpipe.dev/mcp

Authorization (required)

Bearer followed by a URLpipe organization token, created under Organization → MCP access at https://urlpipe.dev

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.

capture_console_errors

urlstring, required

The page to fetch. Must be a public http(s) URL.

project_idinteger, required

Which project this request belongs to. From list_projects.

syncboolean

Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.

labelsobject

max_agestring

How fresh a stored result must be to be reused, e.g. "2 hours" or "3 days". Default 7 days, maximum 30. A reused result is free. Pass "0" to force a fresh fetch.

report_tostring

Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.

residentialboolean

Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic.

page_optionsobject

idempotency_keystring

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Tools (17)

capture_console_errors

Argument	Type	Description
url*	string	The page to fetch. Must be a public http(s) URL.
sync	boolean	Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.
labels	object	Your own keys to find this request by later, e.g. {"client": "acme"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.
max_age	string	How fresh a stored result must be to be reused, e.g. "2 hours" or "3 days". Default 7 days, maximum 30. A reused result is free. Pass "0" to force a fresh fetch.
report_to	string	Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.
project_id*	integer	Which project this request belongs to. From list_projects.
residential	boolean	Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic.
page_options	object	What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them.
idempotency_key	string	Makes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age "0". Up to 255 printable ASCII characters; a UUID is ideal.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The page to fetch. Must be a public http(s) URL."
    },
    "sync": {
      "type": "boolean",
      "description": "Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result."
    },
    "labels": {
      "type": "object",
      "description": "Your own keys to find this request by later, e.g. {\"client\": \"acme\"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "max_age": {
      "type": "string",
      "description": "How fresh a stored result must be to be reused, e.g. \"2 hours\" or \"3 days\". Default 7 days, maximum 30. A reused result is free. Pass \"0\" to force a fresh fetch."
    },
    "report_to": {
      "type": "string",
      "description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one."
    },
    "project_id": {
      "type": "integer",
      "description": "Which project this request belongs to. From list_projects."
    },
    "residential": {
      "type": "boolean",
      "description": "Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic."
    },
    "page_options": {
      "type": "object",
      "properties": {
        "delay": {
          "type": "integer",
          "description": "Milliseconds to wait after the page has settled, 0 to 10000."
        },
        "block_ads": {
          "type": "boolean",
          "description": "Block the major ad networks and remove their slots from the page."
        },
        "block_popups": {
          "type": "boolean",
          "description": "Remove newsletter, app-install and promotional popups laid over the page."
        },
        "remove_selectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "CSS selectors of elements to remove from the page, up to 50."
        },
        "scroll_to_bottom": {
          "type": "boolean",
          "description": "Scroll down the page before reading it, for as long as scrolling loads more (up to 25s). For listings and feeds that load their content as they are scrolled."
        },
        "wait_for_selector": {
          "type": "string",
          "description": "Wait (up to 10s) for an element matching this CSS selector before reading the page."
        },
        "block_cookie_banners": {
          "type": "boolean",
          "description": "Remove cookie-consent banners from the page."
        }
      },
      "description": "What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Makes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age \"0\". Up to 255 printable ASCII characters; a UUID is ideal."
    }
  }
}

capture_pdf

Exposes POST /pdf. Prints the whole rendered page to a PDF — JavaScript executed, web fonts and lazy-loaded images included, its headings as bookmarks. 1 credit, whichever options you use. Use it to archive or hand on a page as a document: a receipt, an article, a report, terms as they stood today. pdf_options choose the paper, the orientation, the margins and the scale, whether backgrounds print, whether the page's print stylesheet or its on-screen look is used, and whether to cut it into sheets at all; page_options wait for the page and take ads and cookie banners out of it.

Argument	Type	Description
url*	string	The page to fetch. Must be a public http(s) URL.
sync	boolean	Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.
labels	object	Your own keys to find this request by later, e.g. {"client": "acme"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.
max_age	string	How fresh a stored result must be to be reused, e.g. "2 hours" or "3 days". Default 7 days, maximum 30. A reused result is free. Pass "0" to force a fresh fetch.
report_to	string	Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.
project_id*

capture_screenshot

Exposes POST /screenshot. Captures the whole rendered page as a PNG — JavaScript executed, web fonts and images included, exactly as a browser would draw it. 1 credit, whichever options you use. Use it to see a page rather than read it: layout, visual regressions, link previews, or checking what an anti-bot page actually showed us. screenshot_options size it (viewport, scale, one element, the fold only), encode it (png, jpeg or webp) and restyle it (dark mode, hidden elements, your own CSS); page_options wait for the page and take ads and cookie banners out of it.

Argument	Type	Description
url*	string	The page to fetch. Must be a public http(s) URL.
sync	boolean	Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.
labels	object	Your own keys to find this request by later, e.g. {"client": "acme"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.
max_age	string	How fresh a stored result must be to be reused, e.g. "2 hours" or "3 days". Default 7 days, maximum 30. A reused result is free. Pass "0" to force a fresh fetch.
report_to	string	Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.
project_id*

detect_technologies

Exposes POST /technologies. Detects what a page is built with — CMS, e-commerce platform, JavaScript frameworks and libraries, analytics and tag managers, advertising and marketing tools, CDN, web server, programming language, payment providers, chat widgets, consent managers and more — from an open database of over 7,000 fingerprints. Each technology comes with its version when the page gives it away, a confidence from 0 to 100, its categories, its website and CPE, and which signals gave it away (html, meta tags, headers, cookies, JavaScript globals, DOM, script URLs and contents, stylesheets, DNS records, robots.txt). The page is rendered first, so technologies loaded by JavaScript are found too. 1 credit.

Argument	Type	Description
url*	string	The page to fetch. Must be a public http(s) URL.
sync	boolean	Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.
labels	object	Your own keys to find this request by later, e.g. {"client": "acme"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.
max_age	string	How fresh a stored result must be to be reused, e.g. "2 hours" or "3 days". Default 7 days, maximum 30. A reused result is free. Pass "0" to force a fresh fetch.
report_to	string	Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.

extract_data

Exposes POST /extract. Reads the page and fills an object YOU define: pass `fields`, each with a name, a type and a description of what to take from the page, and get back exactly those keys in that order. Anything the page does not give comes back null — values are never guessed. Types: string, number, integer, boolean, date, datetime, url, email, object (with its own fields) and array (with items). Use it for product details, prices, contact data, job listings, event dates, lists of items with several attributes each. 24 credits: it reads the whole page with an AI model, so prefer extract_metadata when the standard metadata is all you need.

Argument	Type	Description
url*	string	The page to fetch. Must be a public http(s) URL.
sync	boolean	Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.
fields*	array	The fields to extract, at most 50 in all.
labels	object	Your own keys to find this request by later, e.g. {"client": "acme"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.
max_age	string	How fresh a stored result must be to be reused, e.g. "2 hours" or "3 days". Default 7 days, maximum 30. A reused result is free. Pass "0" to force a fresh fetch.
report_to

extract_keywords

Exposes POST /keywords. Returns the 5–15 terms and phrases that best represent the page, ordered by relevance — ranked by a language model, not by raw frequency. 15 credits. As with summarize_page: if you are going to reason over the result yourself, fetch_markdown costs 1 credit and gives you everything.

Argument	Type	Description
url*	string	The page to fetch. Must be a public http(s) URL.
sync	boolean	Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.
labels	object	Your own keys to find this request by later, e.g. {"client": "acme"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.
max_age	string	How fresh a stored result must be to be reused, e.g. "2 hours" or "3 days". Default 7 days, maximum 30. A reused result is free. Pass "0" to force a fresh fetch.
report_to	string	Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.
project_id*	integer	Which project this request belongs to. From list_projects.
residential

extract_metadata

Exposes POST /meta. Reads everything a page declares about itself — Open Graph, Twitter cards, meta tags, JSON-LD, microdata and links — into one object with the same keys on every page: title, description, site name, kind of page, language, authors, publication and update dates, share image and video, favicon and icons, logo, feeds, keywords, canonical URL, robots directives, hreflang alternates, oEmbed endpoint and structured-data types, plus the raw og: and twitter: tags. A value the page does not declare is null or an empty list. Values injected by JavaScript are included, because the page is rendered first. 1 credit.

Argument	Type	Description
url*	string	The page to fetch. Must be a public http(s) URL.
sync	boolean	Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.
labels	object	Your own keys to find this request by later, e.g. {"client": "acme"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.
max_age	string	How fresh a stored result must be to be reused, e.g. "2 hours" or "3 days". Default 7 days, maximum 30. A reused result is free. Pass "0" to force a fresh fetch.
report_to	string	Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.
project_id

fetch_html

Exposes POST /html. Returns the page's HTML after JavaScript has run and redirects have been followed — the DOM a real browser sees, not the empty shell curl returns. 1 credit. Use it when you need the markup itself: a specific attribute, a script tag, a structured-data block. If you want to read the page's content, fetch_markdown costs the same and returns a fraction of the text.

Argument	Type	Description
url*	string	The page to fetch. Must be a public http(s) URL.
sync	boolean	Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.
labels	object	Your own keys to find this request by later, e.g. {"client": "acme"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.
max_age	string	How fresh a stored result must be to be reused, e.g. "2 hours" or "3 days". Default 7 days, maximum 30. A reused result is free. Pass "0" to force a fresh fetch.
report_to	string	Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.
project_id*	integer	Which project this request belongs to. From list_projects.

fetch_markdown

Exposes POST /markdown. Renders the page in headless Chrome and converts its main content to clean Markdown — headings, lists, links and code kept, navigation, sidebars and cookie banners dropped. Start here when you want to READ a page. It is the cheapest operation we sell (1 credit) and by far the most compact thing to put in front of a model: fetch_html returns the whole DOM, which is usually many times larger and says nothing extra about what the page means.

Argument	Type	Description
url*	string	The page to fetch. Must be a public http(s) URL.
sync	boolean	Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.
labels	object	Your own keys to find this request by later, e.g. {"client": "acme"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.
max_age	string	How fresh a stored result must be to be reused, e.g. "2 hours" or "3 days". Default 7 days, maximum 30. A reused result is free. Pass "0" to force a fresh fetch.
report_to	string	Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.
project_id*	integer	Which project this request belongs to. From list_projects.

get_request

Everything about one past request except its result: what was asked for, how long each stage took, whether it came from the store, and how the webhook delivery went. This is the metadata; get_result returns the page itself. Reach for this one when a call did not do what you expected — it says whether the result was reused, why an analysis failed, and whether the delivery to the project's endpoint succeeded.

read-only

Argument	Type	Description
token*	string	The token the original call returned.
project_id*	integer	From list_projects.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id",
    "token"
  ],
  "properties": {
    "token": {
      "type": "string",
      "description": "The token the original call returned."
    },
    "project_id": {
      "type": "integer",
      "description": "From list_projects."
    }
  }
}

get_result

Exposes GET /result/:token. Returns the result of a past request, in the same form the call that made it would have returned — Markdown as Markdown, a structured operation as its object, a screenshot as an image, a PDF as an embedded application/pdf resource, a scrape as its combined object. This is how an async call is collected: any tool called without sync: true answers with a token, and this turns that token into the result. It also re-reads a result somebody already paid for, which is free — results are kept for 30 days. A request that has not finished yet answers {"status": "processing"}; call again in a moment.

read-only

Argument	Type	Description
token*	string	The token the original call returned.
project_id*	integer	From list_projects.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id",
    "token"
  ],
  "properties": {
    "token": {
      "type": "string",
      "description": "The token the original call returned."
    },
    "project_id": {
      "type": "integer",
      "description": "From list_projects."
    }
  }
}

get_usage

What the organization's plan allows, how much of it is left this period, and what each operation costs. Worth reading before a run of expensive calls: the operations differ by seventeen times in price, so the difference between fetch_markdown and summarize_page over a hundred pages is 100 credits against 1,700. It is also how to read a refusal — a call that comes back with quota_exceeded is telling you this number ran out.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [],
  "properties": {}
}

list_projects

The projects this token can reach, each with how many requests it has made in the last 30 days and where its results are delivered. Start here: every other tool takes a project_id from this list. A project is the unit a request is billed and recorded against — credits themselves belong to the organization, so which project you pick does not change what a call costs.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [],
  "properties": {}
}

list_requests

A project's recent requests, newest first, with each one's token. Look here before fetching a page: if somebody already pulled it, passing that token to get_result returns the same result for nothing. A /scrape appears as one entry — its per-operation children are internal, and the scrape's own token returns all of them. Pass labels to see only the requests made with them — every key given must match its value exactly.

read-only

Argument	Type	Description
url	string	Only requests for this exact URL.
limit	integer	How many to return. Default 25, maximum 100.
labels	object	Only requests made with all of these labels, each value matched exactly.
offset	integer	Skip this many, for paging.
operation	string	Only requests running this operation.
project_id*	integer	From list_projects.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "Only requests for this exact URL."
    },
    "limit": {
      "type": "integer",
      "description": "How many to return. Default 25, maximum 100."
    },
    "labels": {
      "type": "object",
      "description": "Only requests made with all of these labels, each value matched exactly.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "offset": {
      "type": "integer",
      "description": "Skip this many, for paging."
    },
    "operation": {
      "enum": [
        "html",
        "screenshot",
        "markdown",
        "meta",
        "summarize",
        "keywords",
        "lighthouse",
        "console",
        "technologies",
        "pdf",
        "extract",
        "scrape"
      ],
      "type": "string",
      "description": "Only requests running this operation."
    },
    "project_id": {
      "type": "integer",
      "description": "From list_projects."
    }
  }
}

run_lighthouse_audit

Exposes POST /lighthouse. Runs a real Google Lighthouse audit against the live page: performance, accessibility, best-practices and SEO scores plus Core Web Vitals. 2 credits — dearer than a page fetch because the audit runs in its own limited lane, so it also takes longer than anything else here. It fetches the page itself rather than sharing a visit, so asking for it inside scrape_url costs two page visits, not one.

Argument	Type	Description
url*	string	The page to fetch. Must be a public http(s) URL.
sync	boolean	Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.
device	string	Which profile to audit under. Default mobile.
labels	object	Your own keys to find this request by later, e.g. {"client": "acme"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.
max_age	string	How fresh a stored result must be to be reused, e.g. "2 hours" or "3 days". Default 7 days, maximum 30. A reused result is free. Pass "0" to force a fresh fetch.
report_to	string	Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.

scrape_url

Exposes POST /scrape. Runs any subset of the other operations in one request, served from a single page visit where possible. Each operation is billed and stored exactly as the individual call would be, so this is not a discount — with one exception, and it is the reason to use it: a residential exit is charged per page VISIT, so several results off one visit pay the surcharge once. Answers with one object keyed by operation, each entry carrying its own success and result, so a partial failure still returns everything that worked. lighthouse does not share the visit — it runs its own audit on its own engine — so including it means two page fetches, and two surcharges when residential is on. So does a screenshot whose screenshot_options set viewport_width, viewport_height, device_scale_factor, dark_mode or block_ads: those change how the page loads, so the screenshot gets a visit of its own.

Argument	Type	Description
url*	string	The page to fetch. Must be a public http(s) URL.
sync	boolean	Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.
device	string	Lighthouse only, when it is among the operations. Default mobile.
fields	array	extract only, and required when it is among the operations: the fields to fill, exactly as extract_data takes them.
labels	object	Your own keys to find this request by later, e.g. {"client": "acme"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.

summarize_page

Exposes POST /summarize. Returns a concise Markdown summary of the page's main content, with the navigation, ads and boilerplate left out. The most expensive operation we sell, at 17 credits, because it runs a language model over the page. If YOU are the model that will read it, fetch_markdown gives you the whole page for 1 credit and you can summarize it yourself — this tool is for when the summary is the artefact being produced, not a step on the way to one.

Argument	Type	Description
url*	string	The page to fetch. Must be a public http(s) URL.
sync	boolean	Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result.
labels	object	Your own keys to find this request by later, e.g. {"client": "acme"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.
max_age	string	How fresh a stored result must be to be reused, e.g. "2 hours" or "3 days". Default 7 days, maximum 30. A reused result is free. Pass "0" to force a fresh fetch.
report_to	string	Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.
project_id*	integer	Which project this request belongs to. From list_projects.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The page to fetch. Must be a public http(s) URL."
    },
    "sync": {
      "type": "boolean",
      "description": "Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result."
    },
    "labels": {
      "type": "object",
      "description": "Your own keys to find this request by later, e.g. {\"client\": \"acme\"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "max_age": {
      "type": "string",
      "description": "How fresh a stored result must be to be reused, e.g. \"2 hours\" or \"3 days\". Default 7 days, maximum 30. A reused result is free. Pass \"0\" to force a fresh fetch."
    },
    "report_to": {
      "type": "string",
      "description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one."
    },
    "project_id": {
      "type": "integer",
      "description": "Which project this request belongs to. From list_projects."
    },
    "pdf_options": {
      "type": "object",
      "properties": {
        "media": {
          "enum": [
            "print",
            "screen"
          ],
          "type": "string",
          "description": "print (default) uses the page's print stylesheet; screen prints it as a browser shows it."
        },
        "scale": {
          "type": "integer",
          "description": "Scale of the page, 10 to 200 percent. Default 100."
        },
        "margin": {
          "type": "integer",
          "description": "Margin on every side, 0 to 50 mm. Default 10."
        },
        "landscape": {
          "type": "boolean",
          "description": "Landscape orientation. Default false."
        },
        "paper_size": {
          "enum": [
            "letter",
            "legal",
            "tabloid",
            "a3",
            "a4",
            "a5"
          ],
          "type": "string",
          "description": "The paper. Default a4."
        },
        "single_page": {
          "type": "boolean",
          "description": "One page as wide as the browser window and as tall as the whole document, instead of paper-sized sheets. Default false."
        },
        "print_background": {
          "type": "boolean",
          "description": "Print background colours and images. Default true."
        }
      },
      "description": "How to print the PDF. Every key is optional; leave it out for A4 portrait."
    },
    "residential": {
      "type": "boolean",
      "description": "Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic."
    },
    "page_options": {
      "type": "object",
      "properties": {
        "delay": {
          "type": "integer",
          "description": "Milliseconds to wait after the page has settled, 0 to 10000."
        },
        "block_ads": {
          "type": "boolean",
          "description": "Block the major ad networks and remove their slots from the page."
        },
        "block_popups": {
          "type": "boolean",
          "description": "Remove newsletter, app-install and promotional popups laid over the page."
        },
        "remove_selectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "CSS selectors of elements to remove from the page, up to 50."
        },
        "scroll_to_bottom": {
          "type": "boolean",
          "description": "Scroll down the page before reading it, for as long as scrolling loads more (up to 25s). For listings and feeds that load their content as they are scrolled."
        },
        "wait_for_selector": {
          "type": "string",
          "description": "Wait (up to 10s) for an element matching this CSS selector before reading the page."
        },
        "block_cookie_banners": {
          "type": "boolean",
          "description": "Remove cookie-consent banners from the page."
        }
      },
      "description": "What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Makes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age \"0\". Up to 255 printable ASCII characters; a UUID is ideal."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The page to fetch. Must be a public http(s) URL."
    },
    "sync": {
      "type": "boolean",
      "description": "Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result."
    },
    "labels": {
      "type": "object",
      "description": "Your own keys to find this request by later, e.g. {\"client\": \"acme\"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "max_age": {
      "type": "string",
      "description": "How fresh a stored result must be to be reused, e.g. \"2 hours\" or \"3 days\". Default 7 days, maximum 30. A reused result is free. Pass \"0\" to force a fresh fetch."
    },
    "report_to": {
      "type": "string",
      "description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one."
    },
    "project_id": {
      "type": "integer",
      "description": "Which project this request belongs to. From list_projects."
    },
    "residential": {
      "type": "boolean",
      "description": "Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic."
    },
    "page_options": {
      "type": "object",
      "properties": {
        "delay": {
          "type": "integer",
          "description": "Milliseconds to wait after the page has settled, 0 to 10000."
        },
        "block_ads": {
          "type": "boolean",
          "description": "Block the major ad networks and remove their slots from the page."
        },
        "block_popups": {
          "type": "boolean",
          "description": "Remove newsletter, app-install and promotional popups laid over the page."
        },
        "remove_selectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "CSS selectors of elements to remove from the page, up to 50."
        },
        "scroll_to_bottom": {
          "type": "boolean",
          "description": "Scroll down the page before reading it, for as long as scrolling loads more (up to 25s). For listings and feeds that load their content as they are scrolled."
        },
        "wait_for_selector": {
          "type": "string",
          "description": "Wait (up to 10s) for an element matching this CSS selector before reading the page."
        },
        "block_cookie_banners": {
          "type": "boolean",
          "description": "Remove cookie-consent banners from the page."
        }
      },
      "description": "What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Makes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age \"0\". Up to 255 printable ASCII characters; a UUID is ideal."
    },
    "screenshot_options": {
      "type": "object",
      "properties": {
        "format": {
          "enum": [
            "png",
            "jpeg",
            "webp"
          ],
          "type": "string",
          "description": "Image format. Default png; webp is usually the smallest."
        },
        "styles": {
          "type": "string",
          "description": "CSS to inject into the page before capturing, up to 20000 characters."
        },
        "quality": {
          "type": "integer",
          "description": "jpeg and webp only, 1 to 100. Default 80."
        },
        "selector": {
          "type": "string",
          "description": "CSS selector of one element to capture instead of the page."
        },
        "dark_mode": {
          "type": "boolean",
          "description": "Render with prefers-color-scheme: dark."
        },
        "full_page": {
          "type": "boolean",
          "description": "Capture the whole page top to bottom (default true). false captures the viewport only."
        },
        "hide_selectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "CSS selectors of elements to hide before capturing, up to 50. They stay in the page's html; page_options.remove_selectors takes them out of it."
        },
        "viewport_width": {
          "type": "integer",
          "description": "Browser viewport width in CSS pixels, 320 to 1920. Default 1350."
        },
        "omit_background": {
          "type": "boolean",
          "description": "Transparent background where the page sets none. png and webp only."
        },
        "viewport_height": {
          "type": "integer",
          "description": "Browser viewport height in CSS pixels, 240 to 1080. Default 797."
        },
        "device_scale_factor": {
          "type": "integer",
          "description": "Pixel density, 1 to 3: 2 gives a retina image twice the size. Default 1."
        },
        "full_page_max_height": {
          "type": "integer",
          "description": "The tallest a full-page or element capture may be, in CSS pixels: 100 to 16384, the default."
        }
      },
      "description": "How to take the screenshot. Every key is optional; leave it out for a full-page PNG."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The page to fetch. Must be a public http(s) URL."
    },
    "sync": {
      "type": "boolean",
      "description": "Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result."
    },
    "labels": {
      "type": "object",
      "description": "Your own keys to find this request by later, e.g. {\"client\": \"acme\"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "max_age": {
      "type": "string",
      "description": "How fresh a stored result must be to be reused, e.g. \"2 hours\" or \"3 days\". Default 7 days, maximum 30. A reused result is free. Pass \"0\" to force a fresh fetch."
    },
    "report_to": {
      "type": "string",
      "description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one."
    },
    "project_id": {
      "type": "integer",
      "description": "Which project this request belongs to. From list_projects."
    },
    "residential": {
      "type": "boolean",
      "description": "Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic."
    },
    "page_options": {
      "type": "object",
      "properties": {
        "delay": {
          "type": "integer",
          "description": "Milliseconds to wait after the page has settled, 0 to 10000."
        },
        "block_ads": {
          "type": "boolean",
          "description": "Block the major ad networks and remove their slots from the page."
        },
        "block_popups": {
          "type": "boolean",
          "description": "Remove newsletter, app-install and promotional popups laid over the page."
        },
        "remove_selectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "CSS selectors of elements to remove from the page, up to 50."
        },
        "scroll_to_bottom": {
          "type": "boolean",
          "description": "Scroll down the page before reading it, for as long as scrolling loads more (up to 25s). For listings and feeds that load their content as they are scrolled."
        },
        "wait_for_selector": {
          "type": "string",
          "description": "Wait (up to 10s) for an element matching this CSS selector before reading the page."
        },
        "block_cookie_banners": {
          "type": "boolean",
          "description": "Remove cookie-consent banners from the page."
        }
      },
      "description": "What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Makes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age \"0\". Up to 255 printable ASCII characters; a UUID is ideal."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id",
    "url",
    "fields"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The page to fetch. Must be a public http(s) URL."
    },
    "sync": {
      "type": "boolean",
      "description": "Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "type"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The key in the result: letters, digits and underscores."
          },
          "type": {
            "enum": [
              "string",
              "number",
              "integer",
              "boolean",
              "date",
              "datetime",
              "url",
              "email",
              "object",
              "array"
            ],
            "type": "string"
          },
          "items": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "object"
              }
            ],
            "description": "For an array: what it holds — a type such as \"string\", or {\"type\": \"object\", \"fields\": [...]}."
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "For an object: its fields, shaped like this one."
          },
          "description": {
            "type": "string",
            "description": "What to take from the page. The more specific, the better."
          }
        }
      },
      "description": "The fields to extract, at most 50 in all."
    },
    "labels": {
      "type": "object",
      "description": "Your own keys to find this request by later, e.g. {\"client\": \"acme\"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "max_age": {
      "type": "string",
      "description": "How fresh a stored result must be to be reused, e.g. \"2 hours\" or \"3 days\". Default 7 days, maximum 30. A reused result is free. Pass \"0\" to force a fresh fetch."
    },
    "report_to": {
      "type": "string",
      "description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one."
    },
    "project_id": {
      "type": "integer",
      "description": "Which project this request belongs to. From list_projects."
    },
    "residential": {
      "type": "boolean",
      "description": "Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic."
    },
    "instructions": {
      "type": "string",
      "description": "Optional guidance that applies to every field, e.g. \"prices in EUR\"."
    },
    "page_options": {
      "type": "object",
      "properties": {
        "delay": {
          "type": "integer",
          "description": "Milliseconds to wait after the page has settled, 0 to 10000."
        },
        "block_ads": {
          "type": "boolean",
          "description": "Block the major ad networks and remove their slots from the page."
        },
        "block_popups": {
          "type": "boolean",
          "description": "Remove newsletter, app-install and promotional popups laid over the page."
        },
        "remove_selectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "CSS selectors of elements to remove from the page, up to 50."
        },
        "scroll_to_bottom": {
          "type": "boolean",
          "description": "Scroll down the page before reading it, for as long as scrolling loads more (up to 25s). For listings and feeds that load their content as they are scrolled."
        },
        "wait_for_selector": {
          "type": "string",
          "description": "Wait (up to 10s) for an element matching this CSS selector before reading the page."
        },
        "block_cookie_banners": {
          "type": "boolean",
          "description": "Remove cookie-consent banners from the page."
        }
      },
      "description": "What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Makes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age \"0\". Up to 255 printable ASCII characters; a UUID is ideal."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The page to fetch. Must be a public http(s) URL."
    },
    "sync": {
      "type": "boolean",
      "description": "Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result."
    },
    "labels": {
      "type": "object",
      "description": "Your own keys to find this request by later, e.g. {\"client\": \"acme\"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "max_age": {
      "type": "string",
      "description": "How fresh a stored result must be to be reused, e.g. \"2 hours\" or \"3 days\". Default 7 days, maximum 30. A reused result is free. Pass \"0\" to force a fresh fetch."
    },
    "report_to": {
      "type": "string",
      "description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one."
    },
    "project_id": {
      "type": "integer",
      "description": "Which project this request belongs to. From list_projects."
    },
    "residential": {
      "type": "boolean",
      "description": "Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic."
    },
    "page_options": {
      "type": "object",
      "properties": {
        "delay": {
          "type": "integer",
          "description": "Milliseconds to wait after the page has settled, 0 to 10000."
        },
        "block_ads": {
          "type": "boolean",
          "description": "Block the major ad networks and remove their slots from the page."
        },
        "block_popups": {
          "type": "boolean",
          "description": "Remove newsletter, app-install and promotional popups laid over the page."
        },
        "remove_selectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "CSS selectors of elements to remove from the page, up to 50."
        },
        "scroll_to_bottom": {
          "type": "boolean",
          "description": "Scroll down the page before reading it, for as long as scrolling loads more (up to 25s). For listings and feeds that load their content as they are scrolled."
        },
        "wait_for_selector": {
          "type": "string",
          "description": "Wait (up to 10s) for an element matching this CSS selector before reading the page."
        },
        "block_cookie_banners": {
          "type": "boolean",
          "description": "Remove cookie-consent banners from the page."
        }
      },
      "description": "What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Makes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age \"0\". Up to 255 printable ASCII characters; a UUID is ideal."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The page to fetch. Must be a public http(s) URL."
    },
    "sync": {
      "type": "boolean",
      "description": "Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result."
    },
    "labels": {
      "type": "object",
      "description": "Your own keys to find this request by later, e.g. {\"client\": \"acme\"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "max_age": {
      "type": "string",
      "description": "How fresh a stored result must be to be reused, e.g. \"2 hours\" or \"3 days\". Default 7 days, maximum 30. A reused result is free. Pass \"0\" to force a fresh fetch."
    },
    "report_to": {
      "type": "string",
      "description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one."
    },
    "project_id": {
      "type": "integer",
      "description": "Which project this request belongs to. From list_projects."
    },
    "residential": {
      "type": "boolean",
      "description": "Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic."
    },
    "page_options": {
      "type": "object",
      "properties": {
        "delay": {
          "type": "integer",
          "description": "Milliseconds to wait after the page has settled, 0 to 10000."
        },
        "block_ads": {
          "type": "boolean",
          "description": "Block the major ad networks and remove their slots from the page."
        },
        "block_popups": {
          "type": "boolean",
          "description": "Remove newsletter, app-install and promotional popups laid over the page."
        },
        "remove_selectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "CSS selectors of elements to remove from the page, up to 50."
        },
        "scroll_to_bottom": {
          "type": "boolean",
          "description": "Scroll down the page before reading it, for as long as scrolling loads more (up to 25s). For listings and feeds that load their content as they are scrolled."
        },
        "wait_for_selector": {
          "type": "string",
          "description": "Wait (up to 10s) for an element matching this CSS selector before reading the page."
        },
        "block_cookie_banners": {
          "type": "boolean",
          "description": "Remove cookie-consent banners from the page."
        }
      },
      "description": "What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Makes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age \"0\". Up to 255 printable ASCII characters; a UUID is ideal."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The page to fetch. Must be a public http(s) URL."
    },
    "sync": {
      "type": "boolean",
      "description": "Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result."
    },
    "labels": {
      "type": "object",
      "description": "Your own keys to find this request by later, e.g. {\"client\": \"acme\"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "max_age": {
      "type": "string",
      "description": "How fresh a stored result must be to be reused, e.g. \"2 hours\" or \"3 days\". Default 7 days, maximum 30. A reused result is free. Pass \"0\" to force a fresh fetch."
    },
    "report_to": {
      "type": "string",
      "description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one."
    },
    "project_id": {
      "type": "integer",
      "description": "Which project this request belongs to. From list_projects."
    },
    "residential": {
      "type": "boolean",
      "description": "Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic."
    },
    "page_options": {
      "type": "object",
      "properties": {
        "delay": {
          "type": "integer",
          "description": "Milliseconds to wait after the page has settled, 0 to 10000."
        },
        "block_ads": {
          "type": "boolean",
          "description": "Block the major ad networks and remove their slots from the page."
        },
        "block_popups": {
          "type": "boolean",
          "description": "Remove newsletter, app-install and promotional popups laid over the page."
        },
        "remove_selectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "CSS selectors of elements to remove from the page, up to 50."
        },
        "scroll_to_bottom": {
          "type": "boolean",
          "description": "Scroll down the page before reading it, for as long as scrolling loads more (up to 25s). For listings and feeds that load their content as they are scrolled."
        },
        "wait_for_selector": {
          "type": "string",
          "description": "Wait (up to 10s) for an element matching this CSS selector before reading the page."
        },
        "block_cookie_banners": {
          "type": "boolean",
          "description": "Remove cookie-consent banners from the page."
        }
      },
      "description": "What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Makes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age \"0\". Up to 255 printable ASCII characters; a UUID is ideal."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The page to fetch. Must be a public http(s) URL."
    },
    "sync": {
      "type": "boolean",
      "description": "Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result."
    },
    "labels": {
      "type": "object",
      "description": "Your own keys to find this request by later, e.g. {\"client\": \"acme\"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "max_age": {
      "type": "string",
      "description": "How fresh a stored result must be to be reused, e.g. \"2 hours\" or \"3 days\". Default 7 days, maximum 30. A reused result is free. Pass \"0\" to force a fresh fetch."
    },
    "report_to": {
      "type": "string",
      "description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one."
    },
    "project_id": {
      "type": "integer",
      "description": "Which project this request belongs to. From list_projects."
    },
    "residential": {
      "type": "boolean",
      "description": "Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic."
    },
    "page_options": {
      "type": "object",
      "properties": {
        "delay": {
          "type": "integer",
          "description": "Milliseconds to wait after the page has settled, 0 to 10000."
        },
        "block_ads": {
          "type": "boolean",
          "description": "Block the major ad networks and remove their slots from the page."
        },
        "block_popups": {
          "type": "boolean",
          "description": "Remove newsletter, app-install and promotional popups laid over the page."
        },
        "remove_selectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "CSS selectors of elements to remove from the page, up to 50."
        },
        "scroll_to_bottom": {
          "type": "boolean",
          "description": "Scroll down the page before reading it, for as long as scrolling loads more (up to 25s). For listings and feeds that load their content as they are scrolled."
        },
        "wait_for_selector": {
          "type": "string",
          "description": "Wait (up to 10s) for an element matching this CSS selector before reading the page."
        },
        "block_cookie_banners": {
          "type": "boolean",
          "description": "Remove cookie-consent banners from the page."
        }
      },
      "description": "What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Makes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age \"0\". Up to 255 printable ASCII characters; a UUID is ideal."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The page to fetch. Must be a public http(s) URL."
    },
    "sync": {
      "type": "boolean",
      "description": "Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result."
    },
    "device": {
      "enum": [
        "mobile",
        "desktop"
      ],
      "type": "string",
      "description": "Which profile to audit under. Default mobile."
    },
    "labels": {
      "type": "object",
      "description": "Your own keys to find this request by later, e.g. {\"client\": \"acme\"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "max_age": {
      "type": "string",
      "description": "How fresh a stored result must be to be reused, e.g. \"2 hours\" or \"3 days\". Default 7 days, maximum 30. A reused result is free. Pass \"0\" to force a fresh fetch."
    },
    "report_to": {
      "type": "string",
      "description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one."
    },
    "project_id": {
      "type": "integer",
      "description": "Which project this request belongs to. From list_projects."
    },
    "residential": {
      "type": "boolean",
      "description": "Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic."
    },
    "include_audits": {
      "type": "boolean",
      "description": "Include the full per-audit detail, not just scores and metrics. Much larger; default false."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Makes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age \"0\". Up to 255 printable ASCII characters; a UUID is ideal."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id",
    "url",
    "operations"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The page to fetch. Must be a public http(s) URL."
    },
    "sync": {
      "type": "boolean",
      "description": "Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result."
    },
    "device": {
      "enum": [
        "mobile",
        "desktop"
      ],
      "type": "string",
      "description": "Lighthouse only, when it is among the operations. Default mobile."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "type"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The key in the result: letters, digits and underscores."
          },
          "type": {
            "enum": [
              "string",
              "number",
              "integer",
              "boolean",
              "date",
              "datetime",
              "url",
              "email",
              "object",
              "array"
            ],
            "type": "string"
          },
          "items": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "object"
              }
            ],
            "description": "For an array: what it holds — a type such as \"string\", or {\"type\": \"object\", \"fields\": [...]}."
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "For an object: its fields, shaped like this one."
          },
          "description": {
            "type": "string",
            "description": "What to take from the page. The more specific, the better."
          }
        }
      },
      "description": "extract only, and required when it is among the operations: the fields to fill, exactly as extract_data takes them."
    },
    "labels": {
      "type": "object",
      "description": "Your own keys to find this request by later, e.g. {\"client\": \"acme\"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "max_age": {
      "type": "string",
      "description": "How fresh a stored result must be to be reused, e.g. \"2 hours\" or \"3 days\". Default 7 days, maximum 30. A reused result is free. Pass \"0\" to force a fresh fetch."
    },
    "report_to": {
      "type": "string",
      "description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one."
    },
    "operations": {
      "type": "array",
      "items": {
        "enum": [
          "html",
          "screenshot",
          "markdown",
          "meta",
          "summarize",
          "keywords",
          "lighthouse",
          "console",
          "technologies",
          "pdf",
          "extract"
        ],
        "type": "string"
      },
      "description": "Which operations to run off this page."
    },
    "project_id": {
      "type": "integer",
      "description": "Which project this request belongs to. From list_projects."
    },
    "pdf_options": {
      "type": "object",
      "properties": {
        "media": {
          "enum": [
            "print",
            "screen"
          ],
          "type": "string",
          "description": "print (default) uses the page's print stylesheet; screen prints it as a browser shows it."
        },
        "scale": {
          "type": "integer",
          "description": "Scale of the page, 10 to 200 percent. Default 100."
        },
        "margin": {
          "type": "integer",
          "description": "Margin on every side, 0 to 50 mm. Default 10."
        },
        "landscape": {
          "type": "boolean",
          "description": "Landscape orientation. Default false."
        },
        "paper_size": {
          "enum": [
            "letter",
            "legal",
            "tabloid",
            "a3",
            "a4",
            "a5"
          ],
          "type": "string",
          "description": "The paper. Default a4."
        },
        "single_page": {
          "type": "boolean",
          "description": "One page as wide as the browser window and as tall as the whole document, instead of paper-sized sheets. Default false."
        },
        "print_background": {
          "type": "boolean",
          "description": "Print background colours and images. Default true."
        }
      },
      "description": "PDF only, when it is among the operations: how to print it, exactly as capture_pdf takes it."
    },
    "residential": {
      "type": "boolean",
      "description": "Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic."
    },
    "instructions": {
      "type": "string",
      "description": "Optional guidance that applies to every field, e.g. \"prices in EUR\"."
    },
    "page_options": {
      "type": "object",
      "properties": {
        "delay": {
          "type": "integer",
          "description": "Milliseconds to wait after the page has settled, 0 to 10000."
        },
        "block_ads": {
          "type": "boolean",
          "description": "Block the major ad networks and remove their slots from the page."
        },
        "block_popups": {
          "type": "boolean",
          "description": "Remove newsletter, app-install and promotional popups laid over the page."
        },
        "remove_selectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "CSS selectors of elements to remove from the page, up to 50."
        },
        "scroll_to_bottom": {
          "type": "boolean",
          "description": "Scroll down the page before reading it, for as long as scrolling loads more (up to 25s). For listings and feeds that load their content as they are scrolled."
        },
        "wait_for_selector": {
          "type": "string",
          "description": "Wait (up to 10s) for an element matching this CSS selector before reading the page."
        },
        "block_cookie_banners": {
          "type": "boolean",
          "description": "Remove cookie-consent banners from the page."
        }
      },
      "description": "What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them."
    },
    "include_audits": {
      "type": "boolean",
      "description": "Lighthouse only: include the full per-audit detail. Default false."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Makes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age \"0\". Up to 255 printable ASCII characters; a UUID is ideal."
    },
    "screenshot_options": {
      "type": "object",
      "properties": {
        "format": {
          "enum": [
            "png",
            "jpeg",
            "webp"
          ],
          "type": "string",
          "description": "Image format. Default png; webp is usually the smallest."
        },
        "styles": {
          "type": "string",
          "description": "CSS to inject into the page before capturing, up to 20000 characters."
        },
        "quality": {
          "type": "integer",
          "description": "jpeg and webp only, 1 to 100. Default 80."
        },
        "selector": {
          "type": "string",
          "description": "CSS selector of one element to capture instead of the page."
        },
        "dark_mode": {
          "type": "boolean",
          "description": "Render with prefers-color-scheme: dark."
        },
        "full_page": {
          "type": "boolean",
          "description": "Capture the whole page top to bottom (default true). false captures the viewport only."
        },
        "hide_selectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "CSS selectors of elements to hide before capturing, up to 50. They stay in the page's html; page_options.remove_selectors takes them out of it."
        },
        "viewport_width": {
          "type": "integer",
          "description": "Browser viewport width in CSS pixels, 320 to 1920. Default 1350."
        },
        "omit_background": {
          "type": "boolean",
          "description": "Transparent background where the page sets none. png and webp only."
        },
        "viewport_height": {
          "type": "integer",
          "description": "Browser viewport height in CSS pixels, 240 to 1080. Default 797."
        },
        "device_scale_factor": {
          "type": "integer",
          "description": "Pixel density, 1 to 3: 2 gives a retina image twice the size. Default 1."
        },
        "full_page_max_height": {
          "type": "integer",
          "description": "The tallest a full-page or element capture may be, in CSS pixels: 100 to 16384, the default."
        }
      },
      "description": "Screenshot only, when it is among the operations: how to take it, exactly as capture_screenshot takes it."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The page to fetch. Must be a public http(s) URL."
    },
    "sync": {
      "type": "boolean",
      "description": "Wait for the result and return it (default false). When false the call returns a token immediately and you collect the result with get_result."
    },
    "labels": {
      "type": "object",
      "description": "Your own keys to find this request by later, e.g. {\"client\": \"acme\"}: they come back with the result, in the webhook and in list_requests, which can filter by them. Up to 16 keys of up to 40 letters, digits, _ - or .; string values up to 256 characters.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "max_age": {
      "type": "string",
      "description": "How fresh a stored result must be to be reused, e.g. \"2 hours\" or \"3 days\". Default 7 days, maximum 30. A reused result is free. Pass \"0\" to force a fresh fetch."
    },
    "report_to": {
      "type": "string",
      "description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one."
    },
    "project_id": {
      "type": "integer",
      "description": "Which project this request belongs to. From list_projects."
    },
    "residential": {
      "type": "boolean",
      "description": "Fetch the page from a residential (home ISP) exit instead of a datacentre one. Costs a surcharge per page visit — see get_usage. Use it for sites that block datacentre traffic."
    },
    "page_options": {
      "type": "object",
      "properties": {
        "delay": {
          "type": "integer",
          "description": "Milliseconds to wait after the page has settled, 0 to 10000."
        },
        "block_ads": {
          "type": "boolean",
          "description": "Block the major ad networks and remove their slots from the page."
        },
        "block_popups": {
          "type": "boolean",
          "description": "Remove newsletter, app-install and promotional popups laid over the page."
        },
        "remove_selectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "CSS selectors of elements to remove from the page, up to 50."
        },
        "scroll_to_bottom": {
          "type": "boolean",
          "description": "Scroll down the page before reading it, for as long as scrolling loads more (up to 25s). For listings and feeds that load their content as they are scrolled."
        },
        "wait_for_selector": {
          "type": "string",
          "description": "Wait (up to 10s) for an element matching this CSS selector before reading the page."
        },
        "block_cookie_banners": {
          "type": "boolean",
          "description": "Remove cookie-consent banners from the page."
        }
      },
      "description": "What to do to the page before anything is read off it. Applies to the result itself: removed ads and banners are gone from html, markdown and summaries too, and what scrolling loaded is in all of them."
    },
    "idempotency_key": {
      "type": "string",
      "description": "Makes the call safe to retry: sending it again with the same key within 24 hours returns the first call's token and result instead of starting (and charging for) new work, even with max_age \"0\". Up to 255 printable ASCII characters; a UUID is ideal."
    }
  }
}