Server definition
- Hash
- sha256:4908b1c37ff0f20ee066ef2f0bbd9251bf41b60b999d244f3e073cb778c5fce4
- What it is
- What a remote MCP server returned when asked what it offers: 14 tools
The blob, as servednamed by its sha256
{
"instructions": "URLpipe turns a URL into clean data — Markdown, rendered HTML, a screenshot,\npage metadata, an AI summary or keywords, console output, or a Lighthouse\naudit. Pages are fetched with a real headless browser, so JavaScript-rendered\nsites work.\n\nThese tools are the URLpipe HTTP API — same arguments, same responses. The\none addition is project_id, because this credential reaches the whole\norganization rather than one project.\n\nStart with list_projects to get a project_id.\n\nASYNC IS THE DEFAULT. A call returns a token straight away and the work\ncontinues in the background; pass sync: true when you want to wait and be\nhanded the result. Either way, get_result turns a token into the result. An\nasync call also delivers to the project's webhook, if it has one configured.\n\nCOST. Every call spends credits from one monthly allowance, and the\noperations are not priced alike: fetch_markdown, fetch_html,\nextract_metadata, capture_screenshot and capture_console_errors cost 1,\nrun_lighthouse_audit 2, extract_keywords 15, summarize_page 17. get_usage\nhas the live numbers.\n\nSo: to READ a page, use fetch_markdown. It is the cheapest operation and the\nmost compact input for a model — reach for summarize_page or\nextract_keywords only when the summary or the keyword list is the artefact\nyou are producing, rather than a step towards reasoning you would do\nyourself.\n\nA repeated request is free. Results are stored for 30 days and reused when\nthey are fresher than max_age (7 days by default), so re-fetching a page\ncosts nothing unless you ask for a shorter window. A repeat of a request\nthat is still running waits for it, also for free. list_requests shows what\nthis project has already fetched.\n\nTo retry a call safely, pass the same idempotency_key: within 24 hours it\nreturns the first call's token and result rather than starting new work.\n\nscrape_url runs several operations off one page visit. That is not a\ndiscount — each operation is billed as usual — except when residential is\non, where the exit surcharge is charged per visit rather than per operation.\n\nEvery fetching tool takes labels: your own keys for the request, e.g.\n{\"client\": \"acme\"}. They come back with the result, and list_requests\nfilters by them, so work done for one client or project can be found again.",
"tools": [
{
"description": "Exposes POST /console. Loads the page in headless Chrome and returns\nwhat it reported through console.error and console.warn during load, plus\nuncaught exceptions and unhandled promise rejections (not console.log). 1 credit.\n\nWhat you would open DevTools for: broken third-party scripts and\nclient-side errors you cannot reproduce locally.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"idempotency_key": {
"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.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"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.",
"type": "object"
},
"max_age": {
"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.",
"type": "string"
},
"page_options": {
"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.",
"properties": {
"block_ads": {
"description": "Block the major ad networks and remove their slots from the page.",
"type": "boolean"
},
"block_cookie_banners": {
"description": "Remove cookie-consent banners from the page.",
"type": "boolean"
},
"delay": {
"description": "Milliseconds to wait after the page has settled, 0 to 10000.",
"type": "integer"
},
"remove_selectors": {
"description": "CSS selectors of elements to remove from the page, up to 50.",
"items": {
"type": "string"
},
"type": "array"
},
"wait_for_selector": {
"description": "Wait (up to 10s) for an element matching this CSS selector before reading the page.",
"type": "string"
}
},
"type": "object"
},
"project_id": {
"description": "Which project this request belongs to. From list_projects.",
"type": "integer"
},
"report_to": {
"description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.",
"type": "string"
},
"residential": {
"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.",
"type": "boolean"
},
"sync": {
"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.",
"type": "boolean"
},
"url": {
"description": "The page to fetch. Must be a public http(s) URL.",
"type": "string"
}
},
"required": [
"project_id",
"url"
],
"type": "object"
},
"name": "capture_console_errors",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"properties": {
"entries": {
"items": {
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"error",
"warning",
"exception"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"entries"
],
"type": "object"
},
{
"properties": {
"labels": {
"type": "object"
},
"status": {
"const": "accepted",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"status"
],
"type": "object"
}
],
"type": "object"
}
},
{
"description": "Exposes POST /screenshot. Captures the whole rendered page as a PNG —\nJavaScript executed, web fonts and images included, exactly as a browser\nwould draw it. 1 credit, whichever options you use.\n\nUse it to see a page rather than read it: layout, visual regressions,\nlink previews, or checking what an anti-bot page actually showed us.\nscreenshot_options size it (viewport, scale, one element, the fold\nonly), encode it (png, jpeg or webp) and restyle it (dark mode, hidden\nelements, your own CSS); page_options wait for the page and take ads\nand cookie banners out of it.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"idempotency_key": {
"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.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"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.",
"type": "object"
},
"max_age": {
"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.",
"type": "string"
},
"page_options": {
"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.",
"properties": {
"block_ads": {
"description": "Block the major ad networks and remove their slots from the page.",
"type": "boolean"
},
"block_cookie_banners": {
"description": "Remove cookie-consent banners from the page.",
"type": "boolean"
},
"delay": {
"description": "Milliseconds to wait after the page has settled, 0 to 10000.",
"type": "integer"
},
"remove_selectors": {
"description": "CSS selectors of elements to remove from the page, up to 50.",
"items": {
"type": "string"
},
"type": "array"
},
"wait_for_selector": {
"description": "Wait (up to 10s) for an element matching this CSS selector before reading the page.",
"type": "string"
}
},
"type": "object"
},
"project_id": {
"description": "Which project this request belongs to. From list_projects.",
"type": "integer"
},
"report_to": {
"description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.",
"type": "string"
},
"residential": {
"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.",
"type": "boolean"
},
"screenshot_options": {
"description": "How to take the screenshot. Every key is optional; leave it out for a full-page PNG.",
"properties": {
"dark_mode": {
"description": "Render with prefers-color-scheme: dark.",
"type": "boolean"
},
"device_scale_factor": {
"description": "Pixel density, 1 to 3: 2 gives a retina image twice the size. Default 1.",
"type": "integer"
},
"format": {
"description": "Image format. Default png; webp is usually the smallest.",
"enum": [
"png",
"jpeg",
"webp"
],
"type": "string"
},
"full_page": {
"description": "Capture the whole page top to bottom (default true). false captures the viewport only.",
"type": "boolean"
},
"full_page_max_height": {
"description": "The tallest a full-page or element capture may be, in CSS pixels: 100 to 16384, the default.",
"type": "integer"
},
"hide_selectors": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"omit_background": {
"description": "Transparent background where the page sets none. png and webp only.",
"type": "boolean"
},
"quality": {
"description": "jpeg and webp only, 1 to 100. Default 80.",
"type": "integer"
},
"selector": {
"description": "CSS selector of one element to capture instead of the page.",
"type": "string"
},
"styles": {
"description": "CSS to inject into the page before capturing.",
"type": "string"
},
"viewport_height": {
"description": "Browser viewport height in CSS pixels, 240 to 1080. Default 797.",
"type": "integer"
},
"viewport_width": {
"description": "Browser viewport width in CSS pixels, 320 to 1920. Default 1350.",
"type": "integer"
}
},
"type": "object"
},
"sync": {
"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.",
"type": "boolean"
},
"url": {
"description": "The page to fetch. Must be a public http(s) URL.",
"type": "string"
}
},
"required": [
"project_id",
"url"
],
"type": "object"
},
"name": "capture_screenshot",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"properties": {
"mime_type": {
"description": "The image's type. The image itself is the image content block.",
"type": "string"
},
"result_url": {
"description": "A link to the image that needs no key.",
"type": [
"string",
"null"
]
}
},
"required": [
"mime_type"
],
"type": "object"
},
{
"properties": {
"labels": {
"type": "object"
},
"status": {
"const": "accepted",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"status"
],
"type": "object"
}
],
"type": "object"
}
},
{
"description": "Exposes POST /keywords. Returns the 5–15 terms and phrases that best\nrepresent the page, ordered by relevance — ranked by a language model,\nnot by raw frequency. 15 credits.\n\nAs with summarize_page: if you are going to reason over the result\nyourself, fetch_markdown costs 1 credit and gives you everything.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"idempotency_key": {
"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.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"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.",
"type": "object"
},
"max_age": {
"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.",
"type": "string"
},
"page_options": {
"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.",
"properties": {
"block_ads": {
"description": "Block the major ad networks and remove their slots from the page.",
"type": "boolean"
},
"block_cookie_banners": {
"description": "Remove cookie-consent banners from the page.",
"type": "boolean"
},
"delay": {
"description": "Milliseconds to wait after the page has settled, 0 to 10000.",
"type": "integer"
},
"remove_selectors": {
"description": "CSS selectors of elements to remove from the page, up to 50.",
"items": {
"type": "string"
},
"type": "array"
},
"wait_for_selector": {
"description": "Wait (up to 10s) for an element matching this CSS selector before reading the page.",
"type": "string"
}
},
"type": "object"
},
"project_id": {
"description": "Which project this request belongs to. From list_projects.",
"type": "integer"
},
"report_to": {
"description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.",
"type": "string"
},
"residential": {
"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.",
"type": "boolean"
},
"sync": {
"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.",
"type": "boolean"
},
"url": {
"description": "The page to fetch. Must be a public http(s) URL.",
"type": "string"
}
},
"required": [
"project_id",
"url"
],
"type": "object"
},
"name": "extract_keywords",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"properties": {
"keywords": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"keywords"
],
"type": "object"
},
{
"properties": {
"labels": {
"type": "object"
},
"status": {
"const": "accepted",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"status"
],
"type": "object"
}
],
"type": "object"
}
},
{
"description": "Exposes POST /meta. Reads everything a page declares about itself —\nOpen Graph, Twitter cards, meta tags, JSON-LD, microdata and links — into\none object with the same keys on every page: title, description, site\nname, kind of page, language, authors, publication and update dates, share\nimage and video, favicon and icons, logo, feeds, keywords, canonical URL,\nrobots directives, hreflang alternates, oEmbed endpoint and structured-data\ntypes, plus the raw og: and twitter: tags. A value the page does not\ndeclare is null or an empty list. Values injected by JavaScript are\nincluded, because the page is rendered first. 1 credit.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"idempotency_key": {
"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.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"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.",
"type": "object"
},
"max_age": {
"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.",
"type": "string"
},
"page_options": {
"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.",
"properties": {
"block_ads": {
"description": "Block the major ad networks and remove their slots from the page.",
"type": "boolean"
},
"block_cookie_banners": {
"description": "Remove cookie-consent banners from the page.",
"type": "boolean"
},
"delay": {
"description": "Milliseconds to wait after the page has settled, 0 to 10000.",
"type": "integer"
},
"remove_selectors": {
"description": "CSS selectors of elements to remove from the page, up to 50.",
"items": {
"type": "string"
},
"type": "array"
},
"wait_for_selector": {
"description": "Wait (up to 10s) for an element matching this CSS selector before reading the page.",
"type": "string"
}
},
"type": "object"
},
"project_id": {
"description": "Which project this request belongs to. From list_projects.",
"type": "integer"
},
"report_to": {
"description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.",
"type": "string"
},
"residential": {
"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.",
"type": "boolean"
},
"sync": {
"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.",
"type": "boolean"
},
"url": {
"description": "The page to fetch. Must be a public http(s) URL.",
"type": "string"
}
},
"required": [
"project_id",
"url"
],
"type": "object"
},
"name": "extract_metadata",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"additionalProperties": false,
"properties": {
"alternates": {
"items": {
"additionalProperties": false,
"properties": {
"hreflang": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"hreflang",
"url"
],
"type": "object"
},
"type": "array"
},
"authors": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"profiles": {
"items": {
"type": "string"
},
"type": "array"
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url",
"profiles"
],
"type": "object"
},
"type": "array"
},
"canonical_url": {
"description": "The page's canonical URL, absolute.",
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"favicon_url": {
"type": [
"string",
"null"
]
},
"feeds": {
"items": {
"additionalProperties": false,
"properties": {
"title": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"url",
"type",
"title"
],
"type": "object"
},
"type": "array"
},
"final_url": {
"description": "The address the page ended on, after its redirects.",
"type": [
"string",
"null"
]
},
"generator": {
"type": [
"string",
"null"
]
},
"icons": {
"items": {
"additionalProperties": false,
"properties": {
"rel": {
"type": "string"
},
"sizes": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"url",
"rel",
"sizes",
"type"
],
"type": "object"
},
"type": "array"
},
"image": {
"additionalProperties": false,
"properties": {
"alt": {
"type": [
"string",
"null"
]
},
"height": {
"type": [
"integer",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
},
"width": {
"type": [
"integer",
"null"
]
}
},
"required": [
"url",
"width",
"height",
"alt",
"type"
],
"type": [
"object",
"null"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"language": {
"description": "ISO 639-1 code of the language the content is written in.",
"type": [
"string",
"null"
]
},
"locale": {
"description": "The most specific language tag the page declares for that language, BCP 47 (en-US).",
"type": [
"string",
"null"
]
},
"logo_url": {
"type": [
"string",
"null"
]
},
"manifest_url": {
"type": [
"string",
"null"
]
},
"modified_at": {
"description": "ISO 8601, as published_at.",
"type": [
"string",
"null"
]
},
"oembed_url": {
"type": [
"string",
"null"
]
},
"open_graph": {
"additionalProperties": false,
"description": "The page's og: tags as declared.",
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"image": {
"type": [
"string",
"null"
]
},
"locale": {
"type": [
"string",
"null"
]
},
"site_name": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"title",
"description",
"image",
"url",
"type",
"site_name",
"locale"
],
"type": "object"
},
"published_at": {
"description": "ISO 8601: a date (2024-05-01) or a moment with its offset.",
"type": [
"string",
"null"
]
},
"robots": {
"additionalProperties": false,
"properties": {
"follow": {
"type": "boolean"
},
"index": {
"type": "boolean"
}
},
"required": [
"index",
"follow"
],
"type": "object"
},
"site_name": {
"type": [
"string",
"null"
]
},
"structured_data_types": {
"items": {
"type": "string"
},
"type": "array"
},
"theme_color": {
"type": [
"string",
"null"
]
},
"title": {
"description": "The page's own title, without the site's name around it.",
"type": [
"string",
"null"
]
},
"twitter": {
"additionalProperties": false,
"description": "The page's twitter: tags as declared.",
"properties": {
"card": {
"type": [
"string",
"null"
]
},
"creator": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"image": {
"type": [
"string",
"null"
]
},
"site": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
}
},
"required": [
"card",
"site",
"creator",
"title",
"description",
"image"
],
"type": "object"
},
"type": {
"description": "The kind of page, as the page declares it.",
"enum": [
"article",
"website",
"profile",
"book",
"product",
"video",
"music",
"place",
"event",
"recipe",
null
],
"type": [
"string",
"null"
]
},
"video": {
"additionalProperties": false,
"properties": {
"height": {
"type": [
"integer",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
},
"width": {
"type": [
"integer",
"null"
]
}
},
"required": [
"url",
"type",
"width",
"height"
],
"type": [
"object",
"null"
]
}
},
"required": [
"final_url",
"canonical_url",
"title",
"description",
"site_name",
"type",
"language",
"locale",
"authors",
"published_at",
"modified_at",
"image",
"video",
"favicon_url",
"icons",
"logo_url",
"feeds",
"keywords",
"theme_color",
"generator",
"manifest_url",
"robots",
"open_graph",
"twitter",
"alternates",
"oembed_url",
"structured_data_types"
],
"type": "object"
},
{
"properties": {
"labels": {
"type": "object"
},
"status": {
"const": "accepted",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"status"
],
"type": "object"
}
],
"type": "object"
}
},
{
"description": "Exposes POST /html. Returns the page's HTML after JavaScript has run and\nredirects have been followed — the DOM a real browser sees, not the empty\nshell curl returns. 1 credit.\n\nUse it when you need the markup itself: a specific attribute, a script\ntag, a structured-data block. If you want to read the page's content,\nfetch_markdown costs the same and returns a fraction of the text.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"idempotency_key": {
"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.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"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.",
"type": "object"
},
"max_age": {
"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.",
"type": "string"
},
"page_options": {
"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.",
"properties": {
"block_ads": {
"description": "Block the major ad networks and remove their slots from the page.",
"type": "boolean"
},
"block_cookie_banners": {
"description": "Remove cookie-consent banners from the page.",
"type": "boolean"
},
"delay": {
"description": "Milliseconds to wait after the page has settled, 0 to 10000.",
"type": "integer"
},
"remove_selectors": {
"description": "CSS selectors of elements to remove from the page, up to 50.",
"items": {
"type": "string"
},
"type": "array"
},
"wait_for_selector": {
"description": "Wait (up to 10s) for an element matching this CSS selector before reading the page.",
"type": "string"
}
},
"type": "object"
},
"project_id": {
"description": "Which project this request belongs to. From list_projects.",
"type": "integer"
},
"report_to": {
"description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.",
"type": "string"
},
"residential": {
"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.",
"type": "boolean"
},
"sync": {
"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.",
"type": "boolean"
},
"url": {
"description": "The page to fetch. Must be a public http(s) URL.",
"type": "string"
}
},
"required": [
"project_id",
"url"
],
"type": "object"
},
"name": "fetch_html",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"properties": {
"html": {
"description": "The rendered HTML.",
"type": "string"
}
},
"required": [
"html"
],
"type": "object"
},
{
"properties": {
"labels": {
"type": "object"
},
"status": {
"const": "accepted",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"status"
],
"type": "object"
}
],
"type": "object"
}
},
{
"description": "Exposes POST /markdown. Renders the page in headless Chrome and converts\nits main content to clean Markdown — headings, lists, links and code\nkept, navigation, sidebars and cookie banners dropped.\n\nStart here when you want to READ a page. It is the cheapest operation we\nsell (1 credit) and by far the most compact thing to put in front of a\nmodel: fetch_html returns the whole DOM, which is usually many times\nlarger and says nothing extra about what the page means.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"idempotency_key": {
"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.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"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.",
"type": "object"
},
"max_age": {
"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.",
"type": "string"
},
"page_options": {
"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.",
"properties": {
"block_ads": {
"description": "Block the major ad networks and remove their slots from the page.",
"type": "boolean"
},
"block_cookie_banners": {
"description": "Remove cookie-consent banners from the page.",
"type": "boolean"
},
"delay": {
"description": "Milliseconds to wait after the page has settled, 0 to 10000.",
"type": "integer"
},
"remove_selectors": {
"description": "CSS selectors of elements to remove from the page, up to 50.",
"items": {
"type": "string"
},
"type": "array"
},
"wait_for_selector": {
"description": "Wait (up to 10s) for an element matching this CSS selector before reading the page.",
"type": "string"
}
},
"type": "object"
},
"project_id": {
"description": "Which project this request belongs to. From list_projects.",
"type": "integer"
},
"report_to": {
"description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.",
"type": "string"
},
"residential": {
"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.",
"type": "boolean"
},
"sync": {
"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.",
"type": "boolean"
},
"url": {
"description": "The page to fetch. Must be a public http(s) URL.",
"type": "string"
}
},
"required": [
"project_id",
"url"
],
"type": "object"
},
"name": "fetch_markdown",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"properties": {
"markdown": {
"description": "The page's main content as Markdown.",
"type": "string"
}
},
"required": [
"markdown"
],
"type": "object"
},
{
"properties": {
"labels": {
"type": "object"
},
"status": {
"const": "accepted",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"status"
],
"type": "object"
}
],
"type": "object"
}
},
{
"description": "Everything about one past request except its result: what was asked for,\nhow long each stage took, whether it came from the store, and how the\nwebhook delivery went.\n\nThis is the metadata; get_result returns the page itself. Reach for this\none when a call did not do what you expected — it says whether the result\nwas reused, why an analysis failed, and whether the delivery to the\nproject's endpoint succeeded.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"project_id": {
"description": "From list_projects.",
"type": "integer"
},
"token": {
"description": "The token the original call returned.",
"type": "string"
}
},
"required": [
"project_id",
"token"
],
"type": "object"
},
"name": "get_request",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"async": {
"type": [
"boolean",
"null"
]
},
"created_at": {
"type": "string"
},
"credits": {
"type": "integer"
},
"duration_ms": {
"type": "integer"
},
"final_url": {
"description": "Where the page ended up after its redirects.",
"type": "string"
},
"finished_at": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"max_age": {
"type": [
"integer",
"null"
]
},
"meta": {
"description": "What the HTTP response headers would say: cache, cost, quota, result_url, final_url.",
"type": "object"
},
"operation": {
"type": [
"string",
"null"
]
},
"operations": {
"items": {
"properties": {
"created_at": {
"type": "string"
},
"credits": {
"type": "integer"
},
"duration_ms": {
"type": "integer"
},
"final_url": {
"description": "Where the page ended up after its redirects.",
"type": "string"
},
"finished_at": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"operation": {
"type": [
"string",
"null"
]
},
"served_from_cache": {
"type": [
"boolean",
"null"
]
},
"status": {
"type": "string"
},
"success": {
"type": [
"boolean",
"null"
]
},
"token": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"token",
"url",
"status"
],
"type": "object"
},
"type": "array"
},
"outcome": {
"type": [
"object",
"null"
]
},
"report_to": {
"type": [
"string",
"null"
]
},
"request_options": {
"type": [
"object",
"null"
]
},
"served_from_cache": {
"type": [
"boolean",
"null"
]
},
"status": {
"type": "string"
},
"success": {
"type": [
"boolean",
"null"
]
},
"token": {
"type": "string"
},
"url": {
"type": "string"
},
"webhook_delivered_at": {
"type": [
"string",
"null"
]
},
"webhook_error": {
"type": [
"string",
"null"
]
},
"webhook_status": {
"type": [
"string",
"null"
]
}
},
"required": [
"token",
"url",
"status"
],
"type": "object"
}
},
{
"description": "Exposes GET /result/:token. Returns the result of a past request, in the\nsame form the call that made it would have returned — Markdown as\nMarkdown, a structured operation as its object, a screenshot as an image,\na scrape as its combined object.\n\nThis is how an async call is collected: any tool called without\nsync: true answers with a token, and this turns that token into the\nresult. It also re-reads a result somebody already paid for, which is\nfree — results are kept for 30 days.\n\nA request that has not finished yet answers {\"status\": \"processing\"};\ncall again in a moment.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"project_id": {
"description": "From list_projects.",
"type": "integer"
},
"token": {
"description": "The token the original call returned.",
"type": "string"
}
},
"required": [
"project_id",
"token"
],
"type": "object"
},
"name": "get_result",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"properties": {
"markdown": {
"description": "The page's main content as Markdown.",
"type": "string"
}
},
"required": [
"markdown"
],
"type": "object"
},
{
"properties": {
"html": {
"description": "The rendered HTML.",
"type": "string"
}
},
"required": [
"html"
],
"type": "object"
},
{
"properties": {
"summary": {
"description": "A Markdown summary of the page.",
"type": "string"
}
},
"required": [
"summary"
],
"type": "object"
},
{
"properties": {
"keywords": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"keywords"
],
"type": "object"
},
{
"properties": {
"entries": {
"items": {
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"error",
"warning",
"exception"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"entries"
],
"type": "object"
},
{
"properties": {
"mime_type": {
"description": "The image's type. The image itself is the image content block.",
"type": "string"
},
"result_url": {
"description": "A link to the image that needs no key.",
"type": [
"string",
"null"
]
}
},
"required": [
"mime_type"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"alternates": {
"items": {
"additionalProperties": false,
"properties": {
"hreflang": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"hreflang",
"url"
],
"type": "object"
},
"type": "array"
},
"authors": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"profiles": {
"items": {
"type": "string"
},
"type": "array"
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url",
"profiles"
],
"type": "object"
},
"type": "array"
},
"canonical_url": {
"description": "The page's canonical URL, absolute.",
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"favicon_url": {
"type": [
"string",
"null"
]
},
"feeds": {
"items": {
"additionalProperties": false,
"properties": {
"title": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"url",
"type",
"title"
],
"type": "object"
},
"type": "array"
},
"final_url": {
"description": "The address the page ended on, after its redirects.",
"type": [
"string",
"null"
]
},
"generator": {
"type": [
"string",
"null"
]
},
"icons": {
"items": {
"additionalProperties": false,
"properties": {
"rel": {
"type": "string"
},
"sizes": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"url",
"rel",
"sizes",
"type"
],
"type": "object"
},
"type": "array"
},
"image": {
"additionalProperties": false,
"properties": {
"alt": {
"type": [
"string",
"null"
]
},
"height": {
"type": [
"integer",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
},
"width": {
"type": [
"integer",
"null"
]
}
},
"required": [
"url",
"width",
"height",
"alt",
"type"
],
"type": [
"object",
"null"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": "array"
},
"language": {
"description": "ISO 639-1 code of the language the content is written in.",
"type": [
"string",
"null"
]
},
"locale": {
"description": "The most specific language tag the page declares for that language, BCP 47 (en-US).",
"type": [
"string",
"null"
]
},
"logo_url": {
"type": [
"string",
"null"
]
},
"manifest_url": {
"type": [
"string",
"null"
]
},
"modified_at": {
"description": "ISO 8601, as published_at.",
"type": [
"string",
"null"
]
},
"oembed_url": {
"type": [
"string",
"null"
]
},
"open_graph": {
"additionalProperties": false,
"description": "The page's og: tags as declared.",
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"image": {
"type": [
"string",
"null"
]
},
"locale": {
"type": [
"string",
"null"
]
},
"site_name": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"title",
"description",
"image",
"url",
"type",
"site_name",
"locale"
],
"type": "object"
},
"published_at": {
"description": "ISO 8601: a date (2024-05-01) or a moment with its offset.",
"type": [
"string",
"null"
]
},
"robots": {
"additionalProperties": false,
"properties": {
"follow": {
"type": "boolean"
},
"index": {
"type": "boolean"
}
},
"required": [
"index",
"follow"
],
"type": "object"
},
"site_name": {
"type": [
"string",
"null"
]
},
"structured_data_types": {
"items": {
"type": "string"
},
"type": "array"
},
"theme_color": {
"type": [
"string",
"null"
]
},
"title": {
"description": "The page's own title, without the site's name around it.",
"type": [
"string",
"null"
]
},
"twitter": {
"additionalProperties": false,
"description": "The page's twitter: tags as declared.",
"properties": {
"card": {
"type": [
"string",
"null"
]
},
"creator": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"image": {
"type": [
"string",
"null"
]
},
"site": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
}
},
"required": [
"card",
"site",
"creator",
"title",
"description",
"image"
],
"type": "object"
},
"type": {
"description": "The kind of page, as the page declares it.",
"enum": [
"article",
"website",
"profile",
"book",
"product",
"video",
"music",
"place",
"event",
"recipe",
null
],
"type": [
"string",
"null"
]
},
"video": {
"additionalProperties": false,
"properties": {
"height": {
"type": [
"integer",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
},
"width": {
"type": [
"integer",
"null"
]
}
},
"required": [
"url",
"type",
"width",
"height"
],
"type": [
"object",
"null"
]
}
},
"required": [
"final_url",
"canonical_url",
"title",
"description",
"site_name",
"type",
"language",
"locale",
"authors",
"published_at",
"modified_at",
"image",
"video",
"favicon_url",
"icons",
"logo_url",
"feeds",
"keywords",
"theme_color",
"generator",
"manifest_url",
"robots",
"open_graph",
"twitter",
"alternates",
"oembed_url",
"structured_data_types"
],
"type": "object"
},
{
"properties": {
"audits": {
"type": "object"
},
"categories": {
"type": "object"
},
"device": {
"type": "string"
},
"fetchTime": {
"type": "string"
},
"metrics": {
"type": "object"
},
"url": {
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"final_url": {
"description": "The address the page ended on, after its redirects.",
"type": [
"string",
"null"
]
},
"operations": {
"additionalProperties": {
"properties": {
"cached": {
"type": "boolean"
},
"error": {
"type": "string"
},
"result": {},
"success": {
"type": "boolean"
}
},
"type": "object"
},
"description": "One key per operation requested, in the order asked for.",
"type": "object"
},
"url": {
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"labels": {
"type": "object"
},
"status": {
"const": "processing",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"status"
],
"type": "object"
}
],
"type": "object"
}
},
{
"description": "What the organization's plan allows, how much of it is left this period,\nand what each operation costs.\n\nWorth reading before a run of expensive calls: the operations differ by\nseventeen times in price, so the difference between fetch_markdown and\nsummarize_page over a hundred pages is 100 credits against 1,700. It is\nalso how to read a refusal — a call that comes back with quota_exceeded\nis telling you this number ran out.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"required": [],
"type": "object"
},
"name": "get_usage",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"concurrency_limit": {
"type": "integer"
},
"cost_per_operation": {
"additionalProperties": {
"type": "integer"
},
"type": "object"
},
"credits": {
"properties": {
"limit": {
"description": "A number, or \"unlimited\".",
"type": [
"integer",
"string"
]
},
"remaining": {
"description": "A number, or \"unlimited\".",
"type": [
"integer",
"string"
]
},
"resets_at": {
"type": "string"
},
"used": {
"type": "integer"
}
},
"type": "object"
},
"plan": {
"type": "string"
},
"plan_name": {
"type": "string"
},
"residential_surcharge_per_page_visit": {
"type": "integer"
}
},
"required": [
"plan",
"credits",
"cost_per_operation"
],
"type": "object"
}
},
{
"description": "The projects this token can reach, each with how many requests it has\nmade in the last 30 days and where its results are delivered.\n\nStart here: every other tool takes a project_id from this list. A project\nis the unit a request is billed and recorded against — credits themselves\nbelong to the organization, so which project you pick does not change\nwhat a call costs.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"required": [],
"type": "object"
},
"name": "list_projects",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"organization": {
"type": "string"
},
"projects": {
"items": {
"properties": {
"default_webhook_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"requests_last_30_days": {
"type": "integer"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"organization",
"projects"
],
"type": "object"
}
},
{
"description": "A project's recent requests, newest first, with each one's token.\n\nLook here before fetching a page: if somebody already pulled it, passing\nthat token to get_result returns the same result for nothing. A /scrape\nappears as one entry — its per-operation children are internal, and the\nscrape's own token returns all of them.\n\nPass labels to see only the requests made with them — every key given\nmust match its value exactly.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Only requests made with all of these labels, each value matched exactly.",
"type": "object"
},
"limit": {
"description": "How many to return. Default 25, maximum 100.",
"type": "integer"
},
"offset": {
"description": "Skip this many, for paging.",
"type": "integer"
},
"operation": {
"description": "Only requests running this operation.",
"enum": [
"html",
"screenshot",
"markdown",
"meta",
"summarize",
"keywords",
"lighthouse",
"console",
"scrape"
],
"type": "string"
},
"project_id": {
"description": "From list_projects.",
"type": "integer"
},
"url": {
"description": "Only requests for this exact URL.",
"type": "string"
}
},
"required": [
"project_id"
],
"type": "object"
},
"name": "list_requests",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"offset": {
"type": "integer"
},
"project_id": {
"type": "integer"
},
"requests": {
"items": {
"properties": {
"created_at": {
"type": "string"
},
"credits": {
"type": "integer"
},
"duration_ms": {
"type": "integer"
},
"final_url": {
"description": "Where the page ended up after its redirects.",
"type": "string"
},
"finished_at": {
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"operation": {
"type": [
"string",
"null"
]
},
"served_from_cache": {
"type": [
"boolean",
"null"
]
},
"status": {
"type": "string"
},
"success": {
"type": [
"boolean",
"null"
]
},
"token": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"token",
"url",
"status"
],
"type": "object"
},
"type": "array"
},
"total": {
"type": "integer"
}
},
"required": [
"project_id",
"total",
"offset",
"requests"
],
"type": "object"
}
},
{
"description": "Exposes POST /lighthouse. Runs a real Google Lighthouse audit against the\nlive page: performance, accessibility, best-practices and SEO scores plus\nCore Web Vitals. 2 credits — dearer than a page fetch because the audit\nruns in its own limited lane, so it also takes longer than anything else\nhere.\n\nIt fetches the page itself rather than sharing a visit, so asking for it\ninside scrape_url costs two page visits, not one.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"device": {
"description": "Which profile to audit under. Default mobile.",
"enum": [
"mobile",
"desktop"
],
"type": "string"
},
"idempotency_key": {
"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.",
"type": "string"
},
"include_audits": {
"description": "Include the full per-audit detail, not just scores and metrics. Much larger; default false.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"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.",
"type": "object"
},
"max_age": {
"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.",
"type": "string"
},
"project_id": {
"description": "Which project this request belongs to. From list_projects.",
"type": "integer"
},
"report_to": {
"description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.",
"type": "string"
},
"residential": {
"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.",
"type": "boolean"
},
"sync": {
"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.",
"type": "boolean"
},
"url": {
"description": "The page to fetch. Must be a public http(s) URL.",
"type": "string"
}
},
"required": [
"project_id",
"url"
],
"type": "object"
},
"name": "run_lighthouse_audit",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"properties": {
"audits": {
"type": "object"
},
"categories": {
"type": "object"
},
"device": {
"type": "string"
},
"fetchTime": {
"type": "string"
},
"metrics": {
"type": "object"
},
"url": {
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"labels": {
"type": "object"
},
"status": {
"const": "accepted",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"status"
],
"type": "object"
}
],
"type": "object"
}
},
{
"description": "Exposes POST /scrape. Runs any subset of the other operations in one\nrequest, served from a single page visit where possible. Each operation\nis billed and stored exactly as the individual call would be, so this is\nnot a discount — with one exception, and it is the reason to use it: a\nresidential exit is charged per page VISIT, so several results off one\nvisit pay the surcharge once.\n\nAnswers with one object keyed by operation, each entry carrying its own\nsuccess and result, so a partial failure still returns everything that\nworked.\n\nlighthouse does not share the visit — it runs its own audit on its own\nengine — so including it means two page fetches, and two surcharges when\nresidential is on. So does a screenshot whose screenshot_options set\nviewport_width, viewport_height, device_scale_factor, dark_mode or\nblock_ads: those change how the page loads, so the screenshot gets a\nvisit of its own.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"device": {
"description": "Lighthouse only, when it is among the operations. Default mobile.",
"enum": [
"mobile",
"desktop"
],
"type": "string"
},
"idempotency_key": {
"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.",
"type": "string"
},
"include_audits": {
"description": "Lighthouse only: include the full per-audit detail. Default false.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"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.",
"type": "object"
},
"max_age": {
"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.",
"type": "string"
},
"operations": {
"description": "Which operations to run off this page.",
"items": {
"enum": [
"html",
"screenshot",
"markdown",
"meta",
"summarize",
"keywords",
"lighthouse",
"console"
],
"type": "string"
},
"type": "array"
},
"page_options": {
"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.",
"properties": {
"block_ads": {
"description": "Block the major ad networks and remove their slots from the page.",
"type": "boolean"
},
"block_cookie_banners": {
"description": "Remove cookie-consent banners from the page.",
"type": "boolean"
},
"delay": {
"description": "Milliseconds to wait after the page has settled, 0 to 10000.",
"type": "integer"
},
"remove_selectors": {
"description": "CSS selectors of elements to remove from the page, up to 50.",
"items": {
"type": "string"
},
"type": "array"
},
"wait_for_selector": {
"description": "Wait (up to 10s) for an element matching this CSS selector before reading the page.",
"type": "string"
}
},
"type": "object"
},
"project_id": {
"description": "Which project this request belongs to. From list_projects.",
"type": "integer"
},
"report_to": {
"description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.",
"type": "string"
},
"residential": {
"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.",
"type": "boolean"
},
"screenshot_options": {
"description": "Screenshot only, when it is among the operations: how to take it, exactly as capture_screenshot takes it.",
"properties": {
"dark_mode": {
"description": "Render with prefers-color-scheme: dark.",
"type": "boolean"
},
"device_scale_factor": {
"description": "Pixel density, 1 to 3: 2 gives a retina image twice the size. Default 1.",
"type": "integer"
},
"format": {
"description": "Image format. Default png; webp is usually the smallest.",
"enum": [
"png",
"jpeg",
"webp"
],
"type": "string"
},
"full_page": {
"description": "Capture the whole page top to bottom (default true). false captures the viewport only.",
"type": "boolean"
},
"full_page_max_height": {
"description": "The tallest a full-page or element capture may be, in CSS pixels: 100 to 16384, the default.",
"type": "integer"
},
"hide_selectors": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"omit_background": {
"description": "Transparent background where the page sets none. png and webp only.",
"type": "boolean"
},
"quality": {
"description": "jpeg and webp only, 1 to 100. Default 80.",
"type": "integer"
},
"selector": {
"description": "CSS selector of one element to capture instead of the page.",
"type": "string"
},
"styles": {
"description": "CSS to inject into the page before capturing.",
"type": "string"
},
"viewport_height": {
"description": "Browser viewport height in CSS pixels, 240 to 1080. Default 797.",
"type": "integer"
},
"viewport_width": {
"description": "Browser viewport width in CSS pixels, 320 to 1920. Default 1350.",
"type": "integer"
}
},
"type": "object"
},
"sync": {
"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.",
"type": "boolean"
},
"url": {
"description": "The page to fetch. Must be a public http(s) URL.",
"type": "string"
}
},
"required": [
"project_id",
"url",
"operations"
],
"type": "object"
},
"name": "scrape_url",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"properties": {
"final_url": {
"description": "The address the page ended on, after its redirects.",
"type": [
"string",
"null"
]
},
"operations": {
"additionalProperties": {
"properties": {
"cached": {
"type": "boolean"
},
"error": {
"type": "string"
},
"result": {},
"success": {
"type": "boolean"
}
},
"type": "object"
},
"description": "One key per operation requested, in the order asked for.",
"type": "object"
},
"url": {
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"labels": {
"type": "object"
},
"status": {
"const": "accepted",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"status"
],
"type": "object"
}
],
"type": "object"
}
},
{
"description": "Exposes POST /summarize. Returns a concise Markdown summary of the page's\nmain content, with the navigation, ads and boilerplate left out.\n\nThe most expensive operation we sell, at 17 credits, because it runs a\nlanguage model over the page. If YOU are the model that will read it,\nfetch_markdown gives you the whole page for 1 credit and you can\nsummarize it yourself — this tool is for when the summary is the artefact\nbeing produced, not a step on the way to one.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"idempotency_key": {
"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.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"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.",
"type": "object"
},
"max_age": {
"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.",
"type": "string"
},
"page_options": {
"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.",
"properties": {
"block_ads": {
"description": "Block the major ad networks and remove their slots from the page.",
"type": "boolean"
},
"block_cookie_banners": {
"description": "Remove cookie-consent banners from the page.",
"type": "boolean"
},
"delay": {
"description": "Milliseconds to wait after the page has settled, 0 to 10000.",
"type": "integer"
},
"remove_selectors": {
"description": "CSS selectors of elements to remove from the page, up to 50.",
"items": {
"type": "string"
},
"type": "array"
},
"wait_for_selector": {
"description": "Wait (up to 10s) for an element matching this CSS selector before reading the page.",
"type": "string"
}
},
"type": "object"
},
"project_id": {
"description": "Which project this request belongs to. From list_projects.",
"type": "integer"
},
"report_to": {
"description": "Async only: a webhook URL to deliver the result to. Defaults to the project's configured endpoint, if it has one.",
"type": "string"
},
"residential": {
"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.",
"type": "boolean"
},
"sync": {
"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.",
"type": "boolean"
},
"url": {
"description": "The page to fetch. Must be a public http(s) URL.",
"type": "string"
}
},
"required": [
"project_id",
"url"
],
"type": "object"
},
"name": "summarize_page",
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"properties": {
"summary": {
"description": "A Markdown summary of the page.",
"type": "string"
}
},
"required": [
"summary"
],
"type": "object"
},
{
"properties": {
"labels": {
"type": "object"
},
"status": {
"const": "accepted",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"status"
],
"type": "object"
}
],
"type": "object"
}
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:4908b1c37ff0f20ee066ef2f0bbd9251bf41b60b999d244f3e073cb778c5fce4 | sha256sum