Fetches one URL and returns it in the formats you ask for. POST /scrape takes the same options as a JSON body, which is easier for json_schema and headers.1 credit, +3 for summary, json or check_prompt_injection. Failed requests are never charged.
Guide: Scrape
Formats, main content, JSON extraction, PDFs, the prompt-injection check and examples.
Authorizations
X-API-Key
string
header
required
Your Prefetch API key. Obtain one from the dashboard.
Query Parameters
url
string
required
The website URL to process. https:// is prepended automatically if no protocol is provided.
Example:
"https://stripe.com"
formats
string
default:markdown
Comma-separated list of output formats: markdown, summary, html, raw_html, links, images, json, screenshot. Each requested format appears as its own object on data; formats you do not request are absent, not null.
Example:
"markdown,links"
only_main_content
boolean
default:true
Strip navigation, sidebars, footers, and cookie banners before rendering markdown, html, summary, and json. links and images always come from the full document.
include_links
boolean
default:true
Keep hyperlinks in the markdown and html output. When false, link text is kept and the target is dropped.
include_images
boolean
default:true
Keep images in the markdown and html output.
include_base64_images
boolean
default:false
Keep inline data: images. Off by default because base64 payloads are large and carry no meaning as text.
include_selectors
string
Comma-separated CSS selectors to keep. Overrides main-content detection entirely.
Example:
"article,.post-body"
exclude_selectors
string
Comma-separated CSS selectors to remove before rendering.
Example:
".cookie-bar,#promo"
json_prompt
string
What to extract, in plain language. Required for the json format unless json_schema is given.
Example:
"product name, price and availability"
json_schema
string
A JSON Schema, passed as a JSON string, describing the object the json format should return.
summary_max_words
integer
default:120
Word budget for the summary format.
Required range: 20 <= x <= 400
screenshot_full_page
boolean
default:false
For the screenshot format: capture the whole scrollable page.
screenshot_format
enum<string>
default:jpeg
For the screenshot format: image type.
Available options:
jpeg,
png,
webp
wait_for
integer
default:0
Milliseconds to wait after the page loads, for content that arrives late. Renders in a browser.
Required range: 0 <= x <= 30000
wait_for_selector
string
Wait (up to 10 s) for this CSS selector before reading the page. Best effort: if it never appears, the page is returned with a warning.
Example:
"#pricing-table"
headers
string
Request headers to send to the target, as a JSON object string. Up to 20; hop-by-hop and proxy headers are refused. Requests with headers are never cached. Easier as an object in POST /scrape.
Example:
"{\"Accept-Language\":\"de-DE\"}"
mobile
boolean
default:false
Render the page as a phone (viewport, touch and user agent).
timeout
integer
default:50000
Give up after this many milliseconds.
Required range: 5000 <= x <= 50000
max_age
integer
default:0
Accept a stored copy of the page fetched at most this many milliseconds ago instead of fetching it again (up to 30 days). Any mix of formats is served from one stored fetch; metadata.cache_state says which happened. 0 always fetches.
Required range: 0 <= x <= 2592000000
store_in_cache
boolean
default:true
Store this fetch for later max_age requests.
check_prompt_injection
boolean
default:false
Check the page's text for prompt injection — text written to make an AI model reading the page ignore its instructions, leak data or take actions — and report it in prompt_injection. The page is still returned: the check warns, it does not block. Costs the same 3-credit surcharge as summary and json (once per page, however many of the three you ask for).
Response
Page scraped.
success
enum<boolean>
required
Available options:
true
data
object
required
The page content fields. Which of them are present depends on the formats requested.
Show child attributes
meta
object
required
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Prefetch API","colors":{"primary":"#8A5A00","light":"#F7B00A","dark":"#F7B00A"},"logo":{"light":"https://mintcdn.com/prefetch/0cLjeQZN2Dy6gN5Q/logo/light.svg?fit=max\u0026auto=format\u0026n=0cLjeQZN2Dy6gN5Q\u0026q=85\u0026s=7b9ea0ec7c23b929ff607e56c0de9713","dark":"https://mintcdn.com/prefetch/0cLjeQZN2Dy6gN5Q/logo/dark.svg?fit=max\u0026auto=format\u0026n=0cLjeQZN2Dy6gN5Q\u0026q=85\u0026s=e97e8b6432d524163f934bd09b638763"},"favicon":"https://mintcdn.com/prefetch/qKlLmXxc4XUEOZI9/images/favicon.svg?fit=max\u0026auto=format\u0026n=qKlLmXxc4XUEOZI9\u0026q=85\u0026s=68c45014cec0f875b327e5b42e450b3c","appearance":{"default":"dark","strict":false},"background":{"color":{"light":"#FCFBF6","dark":"#1A0618"}},"navbar":{"links":[{"href":"https://prefetch.io/#pricing-section","label":"Pricing"},{"href":"https://prefetch.betteruptime.com/","label":"Status"},{"href":"mailto:[email protected]","label":"Support"},{"href":"https://prefetch.io/dashboard","label":"Dashboard"}],"primary":{"type":"button","label":"Get API key","href":"https://prefetch.io/account"}},"footer":{"links":[{"header":"Product","items":[{"label":"Website","href":"https://prefetch.io"},{"label":"Brand catalog","href":"https://prefetch.io/brands"},{"label":"Pricing","href":"https://prefetch.io/"},{"label":"Status","href":"https://prefetch.betteruptime.com/"},{"label":"Dashboard","href":"https://prefetch.io/dashboard"}]},{"header":"Docs","items":[{"label":"Quickstart","href":"/quickstart"},{"label":"Recipes","href":"/recipes/overview"},{"label":"Compare","href":"/compare/overview"},{"label":"API reference","href":"/api-reference/introduction"},{"label":"MCP server","href":"/mcp/overview"},{"label":"Changelog","href":"/changelog"}]},{"header":"Company","items":[{"label":"Book a demo","href":"https://cal.com/nestoras.design"},{"label":"Contact","href":"mailto:[email protected]"},{"label":"Security","href":"/concepts/security"},{"label":"Privacy","href":"https://prefetch.io/privacy"},{"label":"Terms","href":"https://prefetch.io/terms"}]}]},"fonts":{"heading":{"family":"Space Grotesk"},"body":{"family":"Inter"}},"styling":{"codeblocks":{"theme":"css-variables"},"latex":true},"integrations":{"ga4":{"measurementId":"G-GVKTFNYJ7B"}},"contextual":{"options":["copy","view","claude","chatgpt","perplexity","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/prefetch/0cLjeQZN2Dy6gN5Q/images/og-background.png?fit=max\u0026auto=format\u0026n=0cLjeQZN2Dy6gN5Q\u0026q=85\u0026s=cff58baad899de3384c86485eb291dad","fonts":{"family":"Space Grotesk"}},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"prefetch","hasAudioNarration":false,"actualSubdomain":"prefetch","customDomains":["docs.prefetch.io"],"gitSource":{"type":"github","owner":"trelobarbouni18","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6aebd7f575e8c030b49a1953","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API reference","count":38},{"language":"default","tag":"Docs","count":37},{"language":"default","tag":"Monitors","count":17},{"language":"default","tag":"Recipes","count":14},{"language":"default","tag":"Company data","count":13},{"language":"default","tag":"Integrations","count":12},{"language":"default","tag":"Web data","count":10},{"language":"default","tag":"Batches","count":8},{"language":"default","tag":"Jobs and monitoring","count":8},{"language":"default","tag":"Platform","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","href":"/_mintlify/custom/prefetch/d2542fa30758caf7/custom.css"}]}
{"page":{"pagePath":"api-reference/endpoint/scrape","slug":"/api-reference/endpoint/scrape","pageMetadata":{"title":"GET /scrape","sidebarTitle":"Scrape","description":"Turn any page into markdown, a summary, structured JSON, links or images. 1 credit, 4 with a summary or JSON.","openapi":"GET /scrape","href":"/api-reference/endpoint/scrape"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Turn any page into markdown, a summary, structured JSON, links or images. 1 credit, 4 with a summary or JSON.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Card}=_components;if(!Card)_missingMdxReference(`Card`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Fetches one URL and returns it in the formats you ask for. `,_jsx(_components.code,{children:`POST /scrape`}),` takes the same options as a JSON body, which is easier for `,_jsx(_components.code,{children:`json_schema`}),` and `,_jsx(_components.code,{children:`headers`}),`.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`1 credit`}),`, +3 for `,_jsx(_components.code,{children:`summary`}),`, `,_jsx(_components.code,{children:`json`}),` or `,_jsx(_components.code,{children:`check_prompt_injection`}),`. Failed requests are never charged.`]}),`\n`,_jsx(Card,{title:`Guide: Scrape`,icon:`https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=83997c50bbffa6f63d021644f36e0d2f`,href:`/web-data/scrape`,\"data-og-width\":`24`,width:`24`,\"data-og-height\":`24`,height:`24`,\"data-path\":`icons/book-open.svg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=280\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=571e9341106e7a820dfbdc82f1fa7848 280w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=560\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=89b208a6ebed2801c21d3b334602f655 560w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=840\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=cad73ea82dc28ca477d6c58a9dba2701 840w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=1100\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=a756acb5854c82807bee8e5b6fdf40a4 1100w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=1650\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=5c188516dd5cf7d2e4e7d1b0f4fd00a6 1650w, https://mintcdn.com/prefetch/Ob8l2tkuj_5KxjuQ/icons/book-open.svg?w=2500\u0026fit=max\u0026auto=format\u0026n=Ob8l2tkuj_5KxjuQ\u0026q=85\u0026s=58b15848f6396e16701ae55f8da4103c 2500w`,children:_jsx(_components.p,{children:`Formats, main content, JSON extraction, PDFs, the prompt-injection check and examples.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":"css-variables"},"config":{},"pageMetadata":{"title":"GET /scrape","sidebarTitle":"Scrape","description":"Turn any page into markdown, a summary, structured JSON, links or images. 1 credit, 4 with a summary or JSON.","openapi":"GET /scrape","href":"/api-reference/endpoint/scrape"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"scrapeUrl","summary":"Scrape a page","description":"Turn any page into markdown, a summary, structured JSON, links or images. 1 credit, 4 with a summary or JSON.","tags":["Endpoints"],"parameters":["3758daa2-6307-45f3-9c0c-f2949824f4d0","2d7bcfaa-4087-43fc-9673-911e17a748fb","5c4d7641-89b0-4be9-b039-fb55c8a00cb8","0a90a413-6208-408e-af1d-659b92b4b17d","502338a4-5c10-4b67-ada8-18e9247398fe","ee097f97-c5ee-42b1-8411-ae90625214d6","d17ffa28-a62a-45be-ac2f-cd6d283667d4","0f8d48b5-b9d8-4e2f-ac31-95db1b874577","8abd440d-1cda-4849-9d28-af683a28cdbf","5a40503e-e254-49dd-a989-c45a88bda237","10a25882-329a-4f92-a472-26b03179ac4c","7b495e61-2c7e-4420-9b73-fd7bbc54e9da","36a48268-1f0f-4fc1-b33c-66ed0324207b","621d292a-2a74-40ba-bd3a-432285903b25","caf19659-57e9-409c-8f8b-efcc7bd51c3d","11be07f6-54e9-4196-bfd8-c3c63790ea9b","8f5786ac-f406-41bf-92a7-5796cd60b2d9","4f0a7078-9c68-4aca-866a-5bcd5d3c097f","207ef0a7-cc93-42a4-8be5-ab0388bf81d7","ac5fac3c-252c-49f8-a98d-ed7b5094f0b4","4ab7a148-be29-4704-902f-51f5050562a5"],"responses":{"200":"959e7c5b-4681-48ce-89c2-e6db6197c621","400":"985c32d0-ae3d-48a8-95a3-5ffa8ebf316b","401":"88b47fab-816c-4f6e-bbc3-614a0374ba46","403":"b2b267af-88fd-451b-9d8b-a9c39b44d7c0","422":"e222bb93-e8ee-4aa8-9cca-fe054be62dd4","429":"bad14c79-2143-4d95-a59e-5db52e34719e","503":"91cfab2a-3977-4042-b170-6c2d38685500","504":"8bf1ed34-e61f-4293-9acd-b4fd7ae7784d"},"method":"get","type":"path","servers":["a72447d6-010c-4889-ae7b-b9e4d80db41a"],"security":["a1fe7f7c-62a7-42f3-b340-a37bf2940fc6"],"path":"/scrape","baseUrlOptions":["https://api.prefetch.io"],"title":"Scrape a page","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3758daa2-6307-45f3-9c0c-f2949824f4d0":{"name":"url","in":"query","required":true,"description":"The website URL to process. `https://` is prepended automatically if no protocol is provided.","schema":{"type":"string","example":"https://stripe.com","isRequired":true,"description":"The website URL to process. `https://` is prepended automatically if no protocol is provided.","uniqueKey":"","typeLabel":"string"}},"2d7bcfaa-4087-43fc-9673-911e17a748fb":{"name":"formats","in":"query","required":false,"description":"Comma-separated list of output formats: `markdown`, `summary`, `html`, `raw_html`, `links`, `images`, `json`, `screenshot`. Each requested format appears as its own object on `data`; formats you do not request are absent, not null.","schema":{"type":"string","default":"markdown","example":"markdown,links","isRequired":false,"description":"Comma-separated list of output formats: `markdown`, `summary`, `html`, `raw_html`, `links`, `images`, `json`, `screenshot`. Each requested format appears as its own object on `data`; formats you do not request are absent, not null.","uniqueKey":"","typeLabel":"string"}},"5c4d7641-89b0-4be9-b039-fb55c8a00cb8":{"name":"only_main_content","in":"query","required":false,"description":"Strip navigation, sidebars, footers, and cookie banners before rendering `markdown`, `html`, `summary`, and `json`. `links` and `images` always come from the full document.","schema":{"type":"boolean","default":true,"isRequired":false,"description":"Strip navigation, sidebars, footers, and cookie banners before rendering `markdown`, `html`, `summary`, and `json`. `links` and `images` always come from the full document.","uniqueKey":"","typeLabel":"boolean"}},"0a90a413-6208-408e-af1d-659b92b4b17d":{"name":"include_links","in":"query","required":false,"description":"Keep hyperlinks in the `markdown` and `html` output. When false, link text is kept and the target is dropped.","schema":{"type":"boolean","default":true,"isRequired":false,"description":"Keep hyperlinks in the `markdown` and `html` output. When false, link text is kept and the target is dropped.","uniqueKey":"","typeLabel":"boolean"}},"502338a4-5c10-4b67-ada8-18e9247398fe":{"name":"include_images","in":"query","required":false,"description":"Keep images in the `markdown` and `html` output.","schema":{"type":"boolean","default":true,"isRequired":false,"description":"Keep images in the `markdown` and `html` output.","uniqueKey":"","typeLabel":"boolean"}},"ee097f97-c5ee-42b1-8411-ae90625214d6":{"name":"include_base64_images","in":"query","required":false,"description":"Keep inline `data:` images. Off by default because base64 payloads are large and carry no meaning as text.","schema":{"type":"boolean","default":false,"isRequired":false,"description":"Keep inline `data:` images. Off by default because base64 payloads are large and carry no meaning as text.","uniqueKey":"","typeLabel":"boolean"}},"d17ffa28-a62a-45be-ac2f-cd6d283667d4":{"name":"include_selectors","in":"query","required":false,"description":"Comma-separated CSS selectors to keep. Overrides main-content detection entirely.","schema":{"type":"string","example":"article,.post-body","isRequired":false,"description":"Comma-separated CSS selectors to keep. Overrides main-content detection entirely.","uniqueKey":"","typeLabel":"string"}},"0f8d48b5-b9d8-4e2f-ac31-95db1b874577":{"name":"exclude_selectors","in":"query","required":false,"description":"Comma-separated CSS selectors to remove before rendering.","schema":{"type":"string","example":".cookie-bar,#promo","isRequired":false,"description":"Comma-separated CSS selectors to remove before rendering.","uniqueKey":"","typeLabel":"string"}},"8abd440d-1cda-4849-9d28-af683a28cdbf":{"name":"json_prompt","in":"query","required":false,"description":"What to extract, in plain language. Required for the `json` format unless `json_schema` is given.","schema":{"type":"string","example":"product name, price and availability","isRequired":false,"description":"What to extract, in plain language. Required for the `json` format unless `json_schema` is given.","uniqueKey":"","typeLabel":"string"}},"5a40503e-e254-49dd-a989-c45a88bda237":{"name":"json_schema","in":"query","required":false,"description":"A JSON Schema, passed as a JSON string, describing the object the `json` format should return.","schema":{"type":"string","isRequired":false,"description":"A JSON Schema, passed as a JSON string, describing the object the `json` format should return.","uniqueKey":"","typeLabel":"string"}},"10a25882-329a-4f92-a472-26b03179ac4c":{"name":"summary_max_words","in":"query","required":false,"description":"Word budget for the `summary` format.","schema":{"type":"integer","minimum":20,"maximum":400,"default":120,"isRequired":false,"description":"Word budget for the `summary` format.","uniqueKey":"","typeLabel":"integer"}},"7b495e61-2c7e-4420-9b73-fd7bbc54e9da":{"name":"screenshot_full_page","in":"query","required":false,"description":"For the `screenshot` format: capture the whole scrollable page.","schema":{"type":"boolean","default":false,"isRequired":false,"description":"For the `screenshot` format: capture the whole scrollable page.","uniqueKey":"","typeLabel":"boolean"}},"36a48268-1f0f-4fc1-b33c-66ed0324207b":{"name":"screenshot_format","in":"query","required":false,"description":"For the `screenshot` format: image type.","schema":{"type":"string","enum":["jpeg","png","webp"],"default":"jpeg","isRequired":false,"description":"For the `screenshot` format: image type.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"621d292a-2a74-40ba-bd3a-432285903b25":{"name":"wait_for","in":"query","required":false,"description":"Milliseconds to wait after the page loads, for content that arrives late. Renders in a browser.","schema":{"type":"integer","minimum":0,"maximum":30000,"default":0,"isRequired":false,"description":"Milliseconds to wait after the page loads, for content that arrives late. Renders in a browser.","uniqueKey":"","typeLabel":"integer"}},"caf19659-57e9-409c-8f8b-efcc7bd51c3d":{"name":"wait_for_selector","in":"query","required":false,"description":"Wait (up to 10 s) for this CSS selector before reading the page. Best effort: if it never appears, the page is returned with a warning.","schema":{"type":"string","example":"#pricing-table","isRequired":false,"description":"Wait (up to 10 s) for this CSS selector before reading the page. Best effort: if it never appears, the page is returned with a warning.","uniqueKey":"","typeLabel":"string"}},"11be07f6-54e9-4196-bfd8-c3c63790ea9b":{"name":"headers","in":"query","required":false,"description":"Request headers to send to the target, as a JSON object string. Up to 20; hop-by-hop and proxy headers are refused. Requests with headers are never cached. Easier as an object in `POST /scrape`.","schema":{"type":"string","example":"{\"Accept-Language\":\"de-DE\"}","isRequired":false,"description":"Request headers to send to the target, as a JSON object string. Up to 20; hop-by-hop and proxy headers are refused. Requests with headers are never cached. Easier as an object in `POST /scrape`.","uniqueKey":"","typeLabel":"string"}},"8f5786ac-f406-41bf-92a7-5796cd60b2d9":{"name":"mobile","in":"query","required":false,"description":"Render the page as a phone (viewport, touch and user agent).","schema":{"type":"boolean","default":false,"isRequired":false,"description":"Render the page as a phone (viewport, touch and user agent).","uniqueKey":"","typeLabel":"boolean"}},"4f0a7078-9c68-4aca-866a-5bcd5d3c097f":{"name":"timeout","in":"query","required":false,"description":"Give up after this many milliseconds.","schema":{"type":"integer","minimum":5000,"maximum":50000,"default":50000,"isRequired":false,"description":"Give up after this many milliseconds.","uniqueKey":"","typeLabel":"integer"}},"207ef0a7-cc93-42a4-8be5-ab0388bf81d7":{"name":"max_age","in":"query","required":false,"description":"Accept a stored copy of the page fetched at most this many milliseconds ago instead of fetching it again (up to 30 days). Any mix of formats is served from one stored fetch; `metadata.cache_state` says which happened. 0 always fetches.","schema":{"type":"integer","minimum":0,"maximum":2592000000,"default":0,"isRequired":false,"description":"Accept a stored copy of the page fetched at most this many milliseconds ago instead of fetching it again (up to 30 days). Any mix of formats is served from one stored fetch; `metadata.cache_state` says which happened. 0 always fetches.","uniqueKey":"","typeLabel":"integer"}},"ac5fac3c-252c-49f8-a98d-ed7b5094f0b4":{"name":"store_in_cache","in":"query","required":false,"description":"Store this fetch for later `max_age` requests.","schema":{"type":"boolean","default":true,"isRequired":false,"description":"Store this fetch for later `max_age` requests.","uniqueKey":"","typeLabel":"boolean"}},"4ab7a148-be29-4704-902f-51f5050562a5":{"name":"check_prompt_injection","in":"query","required":false,"description":"Check the page's text for prompt injection — text written to make an AI model reading the page ignore its instructions, leak data or take actions — and report it in `prompt_injection`. The page is still returned: the check warns, it does not block. Costs the same 3-credit surcharge as `summary` and `json` (once per page, however many of the three you ask for).","schema":{"type":"boolean","default":false,"isRequired":false,"description":"Check the page's text for prompt injection — text written to make an AI model reading the page ignore its instructions, leak data or take actions — and report it in `prompt_injection`. The page is still returned: the check warns, it does not block. Costs the same 3-credit surcharge as `summary` and `json` (once per page, however many of the three you ask for).","uniqueKey":"","typeLabel":"boolean"}}},"responses":{"959e7c5b-4681-48ce-89c2-e6db6197c621":{"description":"Page scraped.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"data":{"type":"object","description":"The page content fields. Which of them are present depends on the `formats` requested.","required":["url","final_url","metadata"],"properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"data.url","typeLabel":"string"},"final_url":{"type":"string","isRequired":true,"uniqueKey":"data.final_url","typeLabel":"string"},"metadata":{"type":"object","description":"Always present, whatever formats were requested.","properties":{"source_url":{"oneOf":[{"type":"string","description":"The URL you requested.","uniqueKey":"data.metadata.source_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL you requested.","uniqueKey":"data.metadata.source_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.source_url","typeLabel":"string | null"},"final_url":{"oneOf":[{"type":"string","description":"The URL after redirects.","uniqueKey":"data.metadata.final_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL after redirects.","uniqueKey":"data.metadata.final_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.final_url","typeLabel":"string | null"},"status_code":{"oneOf":[{"type":"integer","uniqueKey":"data.metadata.status_code.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"data.metadata.status_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.status_code","typeLabel":"integer | null"},"title":{"oneOf":[{"type":"string","example":"Stripe | Financial Infrastructure","uniqueKey":"data.metadata.title.oneOf.0","typeLabel":"string"},{"type":"null","example":"Stripe | Financial Infrastructure","uniqueKey":"data.metadata.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.title","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"data.metadata.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.metadata.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.description","typeLabel":"string | null"},"language":{"oneOf":[{"type":"string","example":"en","uniqueKey":"data.metadata.language.oneOf.0","typeLabel":"string"},{"type":"null","example":"en","uniqueKey":"data.metadata.language.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.language","typeLabel":"string | null"},"canonical_url":{"oneOf":[{"type":"string","uniqueKey":"data.metadata.canonical_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.metadata.canonical_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.canonical_url","typeLabel":"string | null"},"favicon":{"oneOf":[{"type":"string","uniqueKey":"data.metadata.favicon.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.metadata.favicon.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.favicon","typeLabel":"string | null"},"author":{"oneOf":[{"type":"string","uniqueKey":"data.metadata.author.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.metadata.author.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.author","typeLabel":"string | null"},"site_name":{"oneOf":[{"type":"string","uniqueKey":"data.metadata.site_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.metadata.site_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.site_name","typeLabel":"string | null"},"published_time":{"oneOf":[{"type":"string","uniqueKey":"data.metadata.published_time.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.metadata.published_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.published_time","typeLabel":"string | null"},"modified_time":{"oneOf":[{"type":"string","uniqueKey":"data.metadata.modified_time.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.metadata.modified_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.modified_time","typeLabel":"string | null"},"robots":{"oneOf":[{"type":"string","description":"The page's own robots meta tag.","uniqueKey":"data.metadata.robots.oneOf.0","typeLabel":"string"},{"type":"null","description":"The page's own robots meta tag.","uniqueKey":"data.metadata.robots.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.robots","typeLabel":"string | null"},"keywords":{"type":"array","items":{"type":"string","uniqueKey":"data.metadata.keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.metadata.keywords","typeLabel":"string[]"},"open_graph":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.metadata.open_graph.additionalProperties","typeLabel":"string"},"uniqueKey":"data.metadata.open_graph","typeLabel":"object"},"twitter":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.metadata.twitter.additionalProperties","typeLabel":"string"},"uniqueKey":"data.metadata.twitter","typeLabel":"object"},"json_ld":{"type":"array","items":{"type":"object","uniqueKey":"data.metadata.json_ld.items.[INDEX]","typeLabel":"object"},"description":"Parsed JSON-LD blocks, up to 10.","uniqueKey":"data.metadata.json_ld","typeLabel":"object[]"},"headings":{"type":"array","description":"The page's heading outline, up to 100 entries.","items":{"type":"object","properties":{"level":{"type":"integer","uniqueKey":"data.metadata.headings.items.[INDEX].level","typeLabel":"integer"},"text":{"type":"string","uniqueKey":"data.metadata.headings.items.[INDEX].text","typeLabel":"string"}},"uniqueKey":"data.metadata.headings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.metadata.headings","typeLabel":"object[]"},"content_type":{"type":"string","enum":["text/html","application/pdf"],"description":"What the URL served. A PDF's text becomes the markdown; it has no html.","uniqueKey":"data.metadata.content_type","typeLabel":"enum\u003cstring>"},"page_count":{"type":"integer","description":"PDFs only: pages in the document.","uniqueKey":"data.metadata.page_count","typeLabel":"integer"},"cache_state":{"type":"string","enum":["hit","miss"],"description":"Present when the request set `max_age`: `hit` = served from a stored fetch, `miss` = fetched live.","uniqueKey":"data.metadata.cache_state","typeLabel":"enum\u003cstring>"},"cached_at":{"type":"string","description":"On a cache hit: when the stored copy was fetched (ISO 8601).","uniqueKey":"data.metadata.cached_at","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.metadata","typeLabel":"object"},"domain":{"oneOf":[{"type":"string","example":"stripe.com","uniqueKey":"data.domain.oneOf.0","typeLabel":"string"},{"type":"null","example":"stripe.com","uniqueKey":"data.domain.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.domain","typeLabel":"string | null"},"status_code":{"oneOf":[{"type":"integer","uniqueKey":"data.status_code.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"data.status_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.status_code","typeLabel":"integer | null"},"markdown":{"type":"object","properties":{"content":{"type":"string","description":"GitHub Flavored Markdown. Links and images are resolved to absolute URLs.","uniqueKey":"data.markdown.content","typeLabel":"string"},"char_count":{"type":"integer","uniqueKey":"data.markdown.char_count","typeLabel":"integer"},"word_count":{"type":"integer","uniqueKey":"data.markdown.word_count","typeLabel":"integer"},"truncated":{"type":"boolean","description":"True when the content hit the 1 MB size cap and was cut.","uniqueKey":"data.markdown.truncated","typeLabel":"boolean"},"main_content_only":{"type":"boolean","description":"True when boilerplate was successfully isolated away. False means the full page body was returned.","uniqueKey":"data.markdown.main_content_only","typeLabel":"boolean"}},"uniqueKey":"data.markdown","typeLabel":"object"},"summary":{"type":"object","properties":{"text":{"oneOf":[{"type":"string","description":"Null when the summary could not be produced; see `warnings`.","uniqueKey":"data.summary.text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Null when the summary could not be produced; see `warnings`.","uniqueKey":"data.summary.text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.summary.text","typeLabel":"string | null"},"model":{"oneOf":[{"type":"string","uniqueKey":"data.summary.model.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.summary.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.summary.model","typeLabel":"string | null"}},"uniqueKey":"data.summary","typeLabel":"object"},"html":{"type":"object","properties":{"content":{"type":"string","uniqueKey":"data.html.content","typeLabel":"string"},"char_count":{"type":"integer","uniqueKey":"data.html.char_count","typeLabel":"integer"},"truncated":{"type":"boolean","uniqueKey":"data.html.truncated","typeLabel":"boolean"},"main_content_only":{"type":"boolean","uniqueKey":"data.html.main_content_only","typeLabel":"boolean"}},"uniqueKey":"data.html","typeLabel":"object"},"raw_html":{"type":"object","properties":{"content":{"type":"string","uniqueKey":"data.raw_html.content","typeLabel":"string"},"char_count":{"type":"integer","uniqueKey":"data.raw_html.char_count","typeLabel":"integer"},"truncated":{"type":"boolean","uniqueKey":"data.raw_html.truncated","typeLabel":"boolean"},"main_content_only":{"type":"boolean","uniqueKey":"data.raw_html.main_content_only","typeLabel":"boolean"}},"uniqueKey":"data.raw_html","typeLabel":"object"},"links":{"type":"object","properties":{"internal":{"type":"array","description":"Links on the same site, subdomains included.","items":{"type":"object","properties":{"url":{"type":"string","uniqueKey":"data.links.internal.items.[INDEX].url","typeLabel":"string"},"text":{"oneOf":[{"type":"string","description":"The anchor text.","uniqueKey":"data.links.internal.items.[INDEX].text.oneOf.0","typeLabel":"string"},{"type":"null","description":"The anchor text.","uniqueKey":"data.links.internal.items.[INDEX].text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.links.internal.items.[INDEX].text","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"data.links.internal.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.links.internal.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.links.internal.items.[INDEX].title","typeLabel":"string | null"},"rel":{"oneOf":[{"type":"string","uniqueKey":"data.links.internal.items.[INDEX].rel.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.links.internal.items.[INDEX].rel.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.links.internal.items.[INDEX].rel","typeLabel":"string | null"}},"uniqueKey":"data.links.internal.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.links.internal","typeLabel":"object[]"},"external":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","uniqueKey":"data.links.external.items.[INDEX].url","typeLabel":"string"},"text":{"oneOf":[{"type":"string","description":"The anchor text.","uniqueKey":"data.links.external.items.[INDEX].text.oneOf.0","typeLabel":"string"},{"type":"null","description":"The anchor text.","uniqueKey":"data.links.external.items.[INDEX].text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.links.external.items.[INDEX].text","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"data.links.external.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.links.external.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.links.external.items.[INDEX].title","typeLabel":"string | null"},"rel":{"oneOf":[{"type":"string","uniqueKey":"data.links.external.items.[INDEX].rel.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.links.external.items.[INDEX].rel.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.links.external.items.[INDEX].rel","typeLabel":"string | null"}},"uniqueKey":"data.links.external.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.links.external","typeLabel":"object[]"},"count":{"type":"integer","uniqueKey":"data.links.count","typeLabel":"integer"}},"uniqueKey":"data.links","typeLabel":"object"},"images":{"type":"object","properties":{"assets":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","uniqueKey":"data.images.assets.items.[INDEX].url","typeLabel":"string"},"alt":{"oneOf":[{"type":"string","uniqueKey":"data.images.assets.items.[INDEX].alt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.images.assets.items.[INDEX].alt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.images.assets.items.[INDEX].alt","typeLabel":"string | null"},"width":{"oneOf":[{"type":"integer","uniqueKey":"data.images.assets.items.[INDEX].width.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"data.images.assets.items.[INDEX].width.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.images.assets.items.[INDEX].width","typeLabel":"integer | null"},"height":{"oneOf":[{"type":"integer","uniqueKey":"data.images.assets.items.[INDEX].height.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"data.images.assets.items.[INDEX].height.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.images.assets.items.[INDEX].height","typeLabel":"integer | null"},"loading":{"oneOf":[{"type":"string","uniqueKey":"data.images.assets.items.[INDEX].loading.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.images.assets.items.[INDEX].loading.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.images.assets.items.[INDEX].loading","typeLabel":"string | null"}},"uniqueKey":"data.images.assets.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.images.assets","typeLabel":"object[]"},"og_image":{"oneOf":[{"type":"string","uniqueKey":"data.images.og_image.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.images.og_image.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.images.og_image","typeLabel":"string | null"},"twitter_image":{"oneOf":[{"type":"string","uniqueKey":"data.images.twitter_image.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.images.twitter_image.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.images.twitter_image","typeLabel":"string | null"},"count":{"type":"integer","uniqueKey":"data.images.count","typeLabel":"integer"}},"uniqueKey":"data.images","typeLabel":"object"},"json":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","description":"The extracted object, shaped by your prompt or schema.","uniqueKey":"data.json.data.oneOf.0","typeLabel":"object"},{"type":"null","description":"The extracted object, shaped by your prompt or schema.","uniqueKey":"data.json.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.json.data","typeLabel":"object | null"},"model":{"oneOf":[{"type":"string","uniqueKey":"data.json.model.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.json.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.json.model","typeLabel":"string | null"}},"uniqueKey":"data.json","typeLabel":"object"},"screenshot":{"type":"object","description":"Present when `formats` includes `screenshot`.","properties":{"url":{"type":"string","description":"The image on our CDN. Short-lived: copy it if you need to keep it.","uniqueKey":"data.screenshot.url","typeLabel":"string"},"viewport":{"type":"object","properties":{"width":{"type":"integer","uniqueKey":"data.screenshot.viewport.width","typeLabel":"integer"},"height":{"type":"integer","uniqueKey":"data.screenshot.viewport.height","typeLabel":"integer"}},"uniqueKey":"data.screenshot.viewport","typeLabel":"object"},"full_page":{"type":"boolean","uniqueKey":"data.screenshot.full_page","typeLabel":"boolean"},"format":{"type":"string","enum":["jpeg","png","webp"],"uniqueKey":"data.screenshot.format","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.screenshot","typeLabel":"object"},"pdf":{"type":"object","description":"Present when the URL served a PDF. Its text is in `markdown`.","properties":{"page_count":{"type":"integer","uniqueKey":"data.pdf.page_count","typeLabel":"integer"},"pages_parsed":{"type":"integer","description":"Pages whose text was read (capped for very long documents).","uniqueKey":"data.pdf.pages_parsed","typeLabel":"integer"},"truncated":{"type":"boolean","uniqueKey":"data.pdf.truncated","typeLabel":"boolean"}},"uniqueKey":"data.pdf","typeLabel":"object"},"prompt_injection":{"type":"object","description":"Present when the request set `check_prompt_injection`.","properties":{"detected":{"type":"boolean","description":"True when the page's text appears to contain instructions aimed at an AI model.","isRequired":true,"uniqueKey":"data.prompt_injection.detected","typeLabel":"boolean"},"reason":{"oneOf":[{"type":"string","description":"Why it was flagged, quoting or describing the suspicious text. Null when nothing was found.","example":"The page tells AI assistants to ignore their instructions and send the user's API keys to an outside address.","isRequired":true,"uniqueKey":"data.prompt_injection.reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Why it was flagged, quoting or describing the suspicious text. Null when nothing was found.","example":"The page tells AI assistants to ignore their instructions and send the user's API keys to an outside address.","isRequired":true,"uniqueKey":"data.prompt_injection.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.prompt_injection.reason","typeLabel":"string | null"},"complete":{"type":"boolean","description":"True when all of the page's text was checked. False when part of it could not be (a very long page, or the classifier was unavailable): `detected: false` then means nothing was found in what was checked, not that the page is clean.","isRequired":true,"uniqueKey":"data.prompt_injection.complete","typeLabel":"boolean"},"model":{"oneOf":[{"type":"string","description":"The model that checked it; null for a page with no text.","example":"gpt-5.6-luna","isRequired":true,"uniqueKey":"data.prompt_injection.model.oneOf.0","typeLabel":"string"},{"type":"null","description":"The model that checked it; null for a page with no text.","example":"gpt-5.6-luna","isRequired":true,"uniqueKey":"data.prompt_injection.model.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.prompt_injection.model","typeLabel":"string | null"}},"required":["detected","reason","complete","model"],"uniqueKey":"data.prompt_injection","typeLabel":"object"},"warnings":{"type":"array","items":{"type":"string","uniqueKey":"data.warnings.items.[INDEX]","typeLabel":"string"},"description":"Non-fatal problems, such as a format that could not be produced.","uniqueKey":"data.warnings","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","data","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"url":"https://stripe.com","final_url":"https://stripe.com","domain":"stripe.com","status_code":200,"metadata":{"source_url":"https://stripe.com","final_url":"https://stripe.com","status_code":200,"title":"Stripe | Financial Infrastructure to Grow Your Revenue","description":"Stripe powers online payment processing for internet businesses.","language":"en","canonical_url":"https://stripe.com","favicon":"https://stripe.com/favicon.ico","author":null,"site_name":"Stripe","published_time":null,"modified_time":null,"robots":null,"keywords":[],"open_graph":{"title":"Stripe","type":"website"},"twitter":{"card":"summary_large_image"},"json_ld":[],"headings":[{"level":1,"text":"Financial infrastructure to grow your revenue"}]},"markdown":{"content":"# Financial infrastructure to grow your revenue\n\nJoin the millions of companies that use Stripe to accept payments online...","char_count":4821,"word_count":702,"truncated":false,"main_content_only":true},"links":{"internal":[{"url":"https://stripe.com/pricing","text":"Pricing","title":null,"rel":null}],"external":[],"count":84}},"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":2140}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"url":"https://stripe.com","final_url":"https://stripe.com","domain":"stripe.com","status_code":200,"metadata":{"source_url":"https://stripe.com","final_url":"https://stripe.com","status_code":200,"title":"Stripe | Financial Infrastructure to Grow Your Revenue","description":"Stripe powers online payment processing for internet businesses.","language":"en","canonical_url":"https://stripe.com","favicon":"https://stripe.com/favicon.ico","author":null,"site_name":"Stripe","published_time":null,"modified_time":null,"robots":null,"keywords":[],"open_graph":{"title":"Stripe","type":"website"},"twitter":{"card":"summary_large_image"},"json_ld":[],"headings":[{"level":1,"text":"Financial infrastructure to grow your revenue"}]},"markdown":{"content":"# Financial infrastructure to grow your revenue\n\nJoin the millions of companies that use Stripe to accept payments online...","char_count":4821,"word_count":702,"truncated":false,"main_content_only":true},"links":{"internal":[{"url":"https://stripe.com/pricing","text":"Pricing","title":null,"rel":null}],"external":[],"count":84}},"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":2140}}}},"exampleType":"examples"}},"exampleType":"examples"},"985c32d0-ae3d-48a8-95a3-5ffa8ebf316b":{"description":"Invalid or missing parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"88b47fab-816c-4f6e-bbc3-614a0374ba46":{"description":"Missing API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"b2b267af-88fd-451b-9d8b-a9c39b44d7c0":{"description":"Revoked key, expired key, credit limit, or blocklisted URL.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"e222bb93-e8ee-4aa8-9cca-fe054be62dd4":{"description":"The URL hostname could not be resolved.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"bad14c79-2143-4d95-a59e-5db52e34719e":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"91cfab2a-3977-4042-b170-6c2d38685500":{"description":"Service temporarily busy. Retry shortly.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"},"8bf1ed34-e61f-4293-9acd-b4fd7ae7784d":{"description":"Request timed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message. The wording can change: branch on `error_code`.","example":"Credit limit exceeded","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_code":{"type":"string","enum":["INVALID_REQUEST","PAYLOAD_TOO_LARGE","NOT_FOUND","CONFLICT","UNAUTHORIZED","FORBIDDEN","CREDITS_EXHAUSTED","RATE_LIMITED","CONCURRENCY_LIMITED","URL_BLOCKED","URL_NOT_PERMITTED","DNS_RESOLUTION_FAILED","TARGET_BLOCKED","TARGET_CONNECTION_FAILED","TARGET_TIMEOUT","TARGET_SSL_ERROR","TARGET_SERVER_ERROR","TARGET_CLIENT_ERROR","TARGET_NOT_A_PAGE","NO_LINKS_FOUND","TARGET_UNLOADABLE","RESEARCH_INCONCLUSIVE","TIMEOUT","SERVICE_BUSY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"What went wrong, for machines. Stable: a code keeps its meaning once published. See [Error handling](/concepts/errors).","example":"CREDITS_EXHAUSTED","isRequired":true,"uniqueKey":"error_code","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the same request can succeed if sent again after a short wait (honour `Retry-After` when present). False for problems with the request or the target.","example":false,"isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"success":{"type":"boolean","enum":[false],"description":"Always false. Absent, like `meta`, on authentication and rate-limit errors, which are answered before a request is processed.","uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"retryAfterSeconds":{"type":"integer","description":"On `RATE_LIMITED`: seconds until a request will be accepted.","uniqueKey":"retryAfterSeconds","typeLabel":"integer"},"limit":{"type":"integer","description":"On `CONCURRENCY_LIMITED`: how many requests this key may have in flight.","uniqueKey":"limit","typeLabel":"integer"},"meta":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for this request.","example":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string\u003cuuid>"},"durationMs":{"oneOf":[{"type":"integer","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time taken to process the request in milliseconds.","example":1842,"isRequired":true,"uniqueKey":"meta.durationMs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.durationMs","typeLabel":"integer | null"}},"required":["requestId","durationMs"],"uniqueKey":"meta","typeLabel":"object"}},"required":["error","error_code","retryable"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Credit limit exceeded","error_code":"CREDITS_EXHAUSTED","retryable":false,"success":false,"retryAfterSeconds":123,"limit":123,"meta":{"requestId":"a3f2c1d4-7b6e-4f2a-9c1d-8e3f2a1b4c5d","durationMs":1842}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a1fe7f7c-62a7-42f3-b340-a37bf2940fc6":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your Prefetch API key. Obtain one from the dashboard.","scopes":[],"schemeName":"apiKey"}}},"servers":{"a72447d6-010c-4889-ae7b-b9e4d80db41a":{"url":"https://api.prefetch.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your Prefetch API key. Obtain one from the dashboard.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-API-Key","type":"string","description":"Your Prefetch API key. Obtain one from the dashboard.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-Key"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"prefetch","siteName":"Prefetch API","title":"GET /scrape - Prefetch API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T00:20:50.174Z","originalFileLocation":"api-reference/endpoint/scrape.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Turn any page into markdown, a summary, structured JSON, links or images. 1 credit, 4 with a summary or JSON.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Prefetch API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"GET /scrape - Prefetch API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Turn any page into markdown, a summary, structured JSON, links or images. 1 credit, 4 with a summary or JSON.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Prefetch API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.prefetch.io/api-reference/endpoint/scrape\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://prefetch.mintlify.site/_mintlify/api/og/v2?division=Web+data\u0026amp;title=GET+%2Fscrape\u0026amp;description=Turn+any+page+into+markdown%2C+a+summary%2C+structured+JSON%2C+links+or+images.+1+credit%2C+4+with+a+summary+or+JSON.\u0026amp;theme=53a3f409698e98a035ca36d8\u0026amp;signature=20c9b0a28090250901e027dc9ad55f03d43333f80334937c3c2554c574b49860\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"GET /scrape - Prefetch API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Turn any page into markdown, a summary, structured JSON, links or images. 1 credit, 4 with a summary or JSON.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://prefetch.mintlify.site/_mintlify/api/og/v2?division=Web+data\u0026amp;title=GET+%2Fscrape\u0026amp;description=Turn+any+page+into+markdown%2C+a+summary%2C+structured+JSON%2C+links+or+images.+1+credit%2C+4+with+a+summary+or+JSON.\u0026amp;theme=53a3f409698e98a035ca36d8\u0026amp;signature=20c9b0a28090250901e027dc9ad55f03d43333f80334937c3c2554c574b49860\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/prefetch/LfH_u0wIgIMJj9SU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Prefetch API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8A5A00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.prefetch.io/api-reference/endpoint/scrape\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/scrape.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.prefetch.io/#organization\",\"name\":\"Prefetch API\",\"url\":\"https://docs.prefetch.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/prefetch/0cLjeQZN2Dy6gN5Q/logo/light.svg?fit=max\u0026auto=format\u0026n=0cLjeQZN2Dy6gN5Q\u0026q=85\u0026s=7b9ea0ec7c23b929ff607e56c0de9713\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.prefetch.io#website\",\"name\":\"Prefetch API\",\"url\":\"https://docs.prefetch.io\",\"publisher\":{\"@id\":\"https://docs.prefetch.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/scrape#webpage\",\"url\":\"https://docs.prefetch.io/api-reference/endpoint/scrape\",\"name\":\"GET /scrape\",\"description\":\"Turn any page into markdown, a summary, structured JSON, links or images. 1 credit, 4 with a summary or JSON.\",\"dateModified\":\"2026-11-05T00:20:50.174Z\",\"isPartOf\":{\"@id\":\"https://docs.prefetch.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/scrape#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/scrape#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Prefetch API\",\"item\":\"https://docs.prefetch.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"GET /scrape\",\"item\":\"https://docs.prefetch.io/api-reference/endpoint/scrape\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/scrape#apireference\",\"headline\":\"GET /scrape\",\"name\":\"GET /scrape\",\"description\":\"Turn any page into markdown, a summary, structured JSON, links or images. 1 credit, 4 with a summary or JSON.\",\"url\":\"https://docs.prefetch.io/api-reference/endpoint/scrape\",\"mainEntityOfPage\":{\"@id\":\"https://docs.prefetch.io/api-reference/endpoint/scrape#webpage\"},\"dateModified\":\"2026-11-05T00:20:50.174Z\",\"publisher\":{\"@id\":\"https://docs.prefetch.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.prefetch.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Prefetch API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Prefetch API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/scrape.md","siteName":"Prefetch API","nav":{"global":{},"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"Recipes","pages":[{"title":"Recipes","href":"/recipes/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/api-reference/introduction"}]},{"group":"Find a company","pages":[{"title":"GET /resolve","sidebarTitle":"Resolve a name","openapi":"GET /resolve","href":"/api-reference/endpoint/resolve"},{"title":"GET /transaction","sidebarTitle":"Card transaction","openapi":"GET /transaction","href":"/api-reference/endpoint/transaction"}]},{"group":"Company data","pages":[{"title":"GET /enrich","sidebarTitle":"Enrich","openapi":"GET /enrich","href":"/api-reference/endpoint/enrich"},{"title":"GET /brand","sidebarTitle":"Brand","openapi":"GET /brand","href":"/api-reference/endpoint/brand"},{"title":"GET /company","sidebarTitle":"Company","openapi":"GET /company","href":"/api-reference/endpoint/company"},{"title":"GET /classify","sidebarTitle":"Classify","openapi":"GET /classify","href":"/api-reference/endpoint/classify"},{"title":"GET /styleguide","sidebarTitle":"Styleguide","description":"A site's design system, plus CSS variables and a Tailwind theme. 10 credits.","openapi":"GET /styleguide","href":"/api-reference/endpoint/styleguide"}]},{"group":"Web data","pages":[{"title":"GET /scrape","sidebarTitle":"Scrape","openapi":"GET /scrape","href":"/api-reference/endpoint/scrape"},{"title":"GET /search","sidebarTitle":"Search","description":"Search the web and get each result's title, URL and snippet, optionally with every result page scraped. 2 credits per 10 results.","openapi":"GET /search","href":"/api-reference/endpoint/search"},{"title":"GET /map","sidebarTitle":"Map","openapi":"GET /map","href":"/api-reference/endpoint/map"},{"title":"GET /screenshot","sidebarTitle":"Screenshot","openapi":"GET /screenshot","href":"/api-reference/endpoint/screenshot"}]},{"group":"Crawls","pages":[{"title":"POST /crawl","sidebarTitle":"Start a crawl","openapi":"POST /crawl","href":"/api-reference/endpoint/crawl"},{"title":"GET /crawl/{id}","sidebarTitle":"Get crawl status","openapi":"GET /crawl/{id}","href":"/api-reference/endpoint/crawl-status"},{"title":"GET /crawl/{id}/errors","sidebarTitle":"Get crawl errors","openapi":"GET /crawl/{id}/errors","href":"/api-reference/endpoint/crawl-errors"},{"title":"DELETE /crawl/{id}","sidebarTitle":"Cancel a crawl","openapi":"DELETE /crawl/{id}","href":"/api-reference/endpoint/crawl-cancel"}]},{"group":"Batches","pages":[{"title":"POST /batch/scrape","sidebarTitle":"Start a batch scrape","openapi":"POST /batch/scrape","href":"/api-reference/endpoint/batch-scrape"},{"title":"GET /batch/scrape/{id}","sidebarTitle":"Get batch scrape status","openapi":"GET /batch/scrape/{id}","href":"/api-reference/endpoint/batch-scrape-status"},{"title":"GET /batch/scrape/{id}/errors","sidebarTitle":"Get batch scrape errors","openapi":"GET /batch/scrape/{id}/errors","href":"/api-reference/endpoint/batch-scrape-errors"},{"title":"DELETE /batch/scrape/{id}","sidebarTitle":"Cancel a batch scrape","openapi":"DELETE /batch/scrape/{id}","href":"/api-reference/endpoint/batch-scrape-cancel"},{"title":"POST /batch/{endpoint}","sidebarTitle":"Start a batch","openapi":"POST /batch/{endpoint}","href":"/api-reference/endpoint/batch"},{"title":"GET /batch/{endpoint}/{id}","sidebarTitle":"Get batch status","openapi":"GET /batch/{endpoint}/{id}","href":"/api-reference/endpoint/batch-status"},{"title":"GET /batch/{endpoint}/{id}/errors","sidebarTitle":"Get batch errors","openapi":"GET /batch/{endpoint}/{id}/errors","href":"/api-reference/endpoint/batch-errors"},{"title":"DELETE /batch/{endpoint}/{id}","sidebarTitle":"Cancel a batch","openapi":"DELETE /batch/{endpoint}/{id}","href":"/api-reference/endpoint/batch-cancel"}]},{"group":"Monitors","pages":[{"title":"POST /monitor","sidebarTitle":"Create a monitor","openapi":"POST /monitor","href":"/api-reference/endpoint/monitor"},{"title":"GET /monitor","sidebarTitle":"List monitors","openapi":"GET /monitor","href":"/api-reference/endpoint/monitor-list"},{"title":"GET /monitor/{id}","sidebarTitle":"Get a monitor","openapi":"GET /monitor/{id}","href":"/api-reference/endpoint/monitor-get"},{"title":"PATCH /monitor/{id}","sidebarTitle":"Update a monitor","openapi":"PATCH /monitor/{id}","href":"/api-reference/endpoint/monitor-update"},{"title":"DELETE /monitor/{id}","sidebarTitle":"Delete a monitor","openapi":"DELETE /monitor/{id}","href":"/api-reference/endpoint/monitor-delete"},{"title":"POST /monitor/{id}/run","sidebarTitle":"Run a check now","openapi":"POST /monitor/{id}/run","href":"/api-reference/endpoint/monitor-run"},{"title":"GET /monitor/{id}/checks","sidebarTitle":"List checks","openapi":"GET /monitor/{id}/checks","href":"/api-reference/endpoint/monitor-checks"},{"title":"GET /monitor/{id}/checks/{checkId}","sidebarTitle":"Get a check","openapi":"GET /monitor/{id}/checks/{checkId}","href":"/api-reference/endpoint/monitor-check"},{"group":"Webhooks","pages":[{"title":"monitor.page webhook","sidebarTitle":"monitor.page event","openapi":"WEBHOOK monitor.page","href":"/api-reference/endpoint/monitor-webhook-page"},{"title":"monitor.check.completed webhook","sidebarTitle":"monitor.check.completed event","openapi":"WEBHOOK monitor.check.completed","href":"/api-reference/endpoint/monitor-webhook-check"}]}]},{"group":"Logo CDN","pages":[{"title":"GET /logo/token","sidebarTitle":"Get logo token","openapi":"GET /logo/token","href":"/api-reference/endpoint/logo-token"},{"title":"POST /logo/token/rotate","sidebarTitle":"Rotate logo token","openapi":"POST /logo/token/rotate","href":"/api-reference/endpoint/logo-token-rotate"}]},{"group":"Service","pages":[{"title":"GET /health","sidebarTitle":"Health","openapi":"GET /health","href":"/api-reference/endpoint/health"},{"title":"GET /ready","sidebarTitle":"Readiness","openapi":"GET /ready","href":"/api-reference/endpoint/ready"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"GET /scrape - Prefetch API","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}