{
"success": false,
"error": {
"code": "WORKSPACE_BANNED",
"message": "This workspace has been suspended and cannot make API requests."
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}
{
"success": false,
"error": {
"code": "UPSTREAM_UNREACHABLE",
"message": "The origin did not respond to any attempt we made."
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}
{
"success": false,
"error": {
"code": "TOO_MANY_REQUESTS",
"message": "Rate limit exceeded for this workspace and plan."
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}
{
"success": false,
"error": {
"code": "WORKSPACE_BANNED",
"message": "This workspace has been suspended and cannot make API requests."
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}
{
"success": false,
"error": {
"code": "UPSTREAM_UNREACHABLE",
"message": "The origin did not respond to any attempt we made."
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}
{
"success": false,
"error": {
"code": "TOO_MANY_REQUESTS",
"message": "Rate limit exceeded for this workspace and plan."
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}
Reuse a stored screenshot if it is younger than this many milliseconds. Defaults to 7 days, so a repeated request returns the stored PNG with cached: true without re-rendering — which also means it returns immediately and does not apply waitFor. Pass 0 to force a fresh capture.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Hydrafetch","description":"Turn any URL into clean Markdown and structured data your model can use. Scrape, crawl, search and extract with one API, one credit a page.","colors":{"primary":"#0E7490","light":"#22D3EE","dark":"#0E7490"},"logo":{"light":"https://mintcdn.com/hydrafetch/koPVMLXM3S4OTC3p/logo/lockup-light.svg?fit=max\u0026auto=format\u0026n=koPVMLXM3S4OTC3p\u0026q=85\u0026s=581b06c8816bc26dd6badf943c86aa6a","dark":"https://mintcdn.com/hydrafetch/koPVMLXM3S4OTC3p/logo/lockup-dark.svg?fit=max\u0026auto=format\u0026n=koPVMLXM3S4OTC3p\u0026q=85\u0026s=8794eacf6c26789ce40273c8d0c6f75c"},"favicon":"https://mintcdn.com/hydrafetch/koPVMLXM3S4OTC3p/favicon.svg?fit=max\u0026auto=format\u0026n=koPVMLXM3S4OTC3p\u0026q=85\u0026s=a73416b63f89cddc2832b7d92c18f775","appearance":{"default":"system"},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Start for free","href":"https://app.hydrafetch.com"}},"footer":{"socials":{"github":"https://github.com/hydrafetch","x":"https://x.com/hydrafetch"},"links":[{"header":"Product","items":[{"label":"Dashboard","href":"https://app.hydrafetch.com"},{"label":"Quickstart","href":"https://docs.hydrafetch.com/quickstart"},{"label":"API reference","href":"https://docs.hydrafetch.com/api-reference"}]},{"header":"Resources","items":[{"label":"Changelog","href":"https://docs.hydrafetch.com/changelog"},{"label":"Status","href":"https://api.hydrafetch.com/health"},{"label":"Support","href":"mailto:[email protected]"}]}]},"seo":{"metatags":{"og:type":"website","og:site_name":"Hydrafetch Docs","twitter:card":"summary_large_image","og:description":"Turn any URL into clean Markdown and structured data your model can use. Scrape, crawl, search and extract with one API, one credit a page."},"indexing":"all"},"fonts":{"heading":{"family":"Chivo","weight":600,"source":"fonts/Chivo[wght].woff2","format":"woff2"},"body":{"family":"Chivo","weight":400,"source":"fonts/Chivo[wght].woff2","format":"woff2"}},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","cursor","mcp"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hydrafetch","hasAudioNarration":false,"actualSubdomain":"hydrafetch","customDomains":["docs.hydrafetch.com"],"gitSource":{"type":"github","owner":"hydrafetch","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af5e7e5c7a2465f288727ed","clientVersion":"0.0.4124","searchFilterCounts":[{"language":"default","tag":"API Reference","count":29},{"language":"default","tag":"Documentation","count":23},{"language":"default","tag":"Blueprints","count":11},{"language":"default","tag":"Core concepts","count":9},{"language":"default","tag":"Web Scraping","count":8},{"language":"default","tag":"Crawl \u0026 batch","count":7},{"language":"default","tag":"Scrape","count":7},{"language":"default","tag":"Help Center","count":6},{"language":"default","tag":"Brand","count":5},{"language":"default","tag":"Get started","count":4}]},"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--hf-ink: #0b1b26;--hf-text-2: #47606c;--hf-text-3: #74909c;--hf-line: #d3e0e6;--hf-well: #edf4f7;--hf-accent: #0e7490;--hf-accent-hover: #107ea0;--hf-ok-soft: #e6f4ea;--hf-ok-line: #cfe8d6;--hf-warn-soft: #fbf1e1;--hf-warn-line: #f1dfbf;--hf-danger-soft: #fbe7e7;--hf-danger-line: #f2c9c9;--hf-brand-soft: #e0f4f9;--hf-info-line: #bfe6f0;--hf-brand-deep: #0b5c73;--hf-paper: #fafcfd;--hf-panel: #ffffff;--hf-tint: #f4f9fb;--hf-line-strong: #b6cbd4;--hf-on-accent: #ffffff;--hf-key-edge-soft: color-mix(in oklab, #0e7490 42%, #ffffff);--hf-r-control: 2px;--hf-r-intent: 4px;--hf-r-panel: 8px}.dark{--hf-ink: #e6eef2;--hf-text-2: #a7b9c3;--hf-text-3: #748a97;--hf-line: #1f2c36;--hf-well: #151e26;--hf-accent: #22d3ee;--hf-accent-hover: #3ddcf3;--hf-brand-deep: #0e9fb5;--hf-paper: #0a0f14;--hf-panel: #0f161c;--hf-tint: #0a0f14;--hf-line-strong: #2e3f4b;--hf-on-accent: #062028;--hf-key-edge-soft: color-mix(in oklab, #22d3ee 42%, #0f161c)}@font-face{font-family:'Chivo Mono';src:url('/fonts/ChivoMono[wght].woff2') format('woff2-variations');font-weight:100 900;font-style:normal;font-display:swap}code,pre,kbd,samp{font-family:'Chivo Mono', ui-monospace, SFMono-Regular, Menlo, monospace}html{-webkit-font-smoothing:antialiased;text-rendering:optimizeLegibility}.tryit-button,#topbar-cta-button>a,.navbar-link>a,#page-context-menu>button{position:relative!important;overflow:hidden!important;border-radius:var(--hf-r-control)!important;font-weight:500}.tryit-button::after,#topbar-cta-button>a::after,.navbar-link>a::after,#page-context-menu-button::after{content:'';position:absolute;inset-block:0;right:0;width:8px;pointer-events:none;background:repeating-conic-gradient(var(--hf-key-edge) 0 25%, transparent 0 50%) 0 0 / 4px 4px}.tryit-button,#topbar-cta-button>a{--hf-key-edge: var(--hf-paper);padding-right:22px!important}.tryit-button,#topbar-cta-button>a>span.absolute{background:var(--hf-accent)!important;border:1px solid var(--hf-brand-deep);border-radius:var(--hf-r-control)!important;box-shadow:inset 0 1px 0 rgb(255 255 255 / 18%),\n 0 1px 0 var(--hf-brand-deep);opacity:1!important}.tryit-button,.tryit-button *,#topbar-cta-button>a span,#topbar-cta-button>a svg{color:var(--hf-on-accent)!important}.tryit-button:hover,#topbar-cta-button>a:hover>span.absolute{background:var(--hf-accent-hover)!important}.navbar-link>a,#page-context-menu>button{--hf-key-edge: var(--hf-key-edge-soft);border:1px solid var(--hf-line-strong)!important;background:var(--hf-panel)!important;color:var(--hf-ink)!important;box-shadow:inset 0 1px 0 var(--hf-panel),\n 0 1px 0 var(--hf-line)}.navbar-link>a{padding-right:22px!important}#page-context-menu-button{padding-right:18px!important}#page-context-menu>button+button{border-left:0!important}.navbar-link>a:hover,#page-context-menu>button:hover{border-color:var(--hf-text-3)!important;background:var(--hf-tint)!important}.tryit-button:active,#topbar-cta-button>a:active,.navbar-link>a:active,#page-context-menu>button:active{transform:translateY(1px)}.tryit-button:focus-visible,#topbar-cta-button>a:focus-visible,.navbar-link>a:focus-visible,#page-context-menu>button:focus-visible{outline:none;box-shadow:0 0 0 2px var(--hf-paper),\n 0 0 0 4px #0891b2}button,input,select,textarea,.tryit-button,[role=\"button\"]{border-radius:var(--hf-r-control)}.card{border-radius:var(--hf-r-panel);border:1px solid var(--hf-line);box-shadow:none;transition:border-color 120ms cubic-bezier(0.2, 0.7, 0.2, 1)}.card:hover{border-color:var(--hf-accent);box-shadow:none}.callout,[class*=\"callout\"]{border-radius:var(--hf-r-intent);box-shadow:none}.code-block{border-radius:var(--hf-r-panel);border:1px solid var(--hf-line)}#content-area hr{height:48px;border:0;border-top:1px solid var(--hf-line);border-bottom:1px solid var(--hf-line);background:repeating-conic-gradient(var(--hf-line) 0 25%, transparent 0 50%) 0 0 / 4px 4px;mask-image:linear-gradient(to bottom, transparent, #000 50%, transparent)}code,pre,kbd{font-feature-settings:'tnum' 1,\n 'zero' 1}"}],"page":{"pagePath":"api-reference/media/screenshot-a-page","slug":"/api-reference/media/screenshot-a-page","pageMetadata":{"title":"Screenshot a page","description":"Capture a full-page PNG screenshot of a rendered page.","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/screenshot","href":"/api-reference/media/screenshot-a-page","autogeneratedByOpenApi":true},"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: \"Capture a full-page PNG screenshot of a rendered page.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Screenshot a page","description":"Capture a full-page PNG screenshot of a rendered page.","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/screenshot","href":"/api-reference/media/screenshot-a-page","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Capture a full-page PNG screenshot of a rendered page.","operationId":"mediaScreenshot","parameters":[],"requestBody":"8ec790d6-f610-4257-9c64-a43d0c90ba0f","responses":{"200":"abb285ff-e22b-4e39-b24e-130687c0c493","202":"7c20679e-8bbf-470a-a250-bb1e43e0a500","400":"7bce5940-cb08-45b9-b0a0-7d9c85fd516e","401":"f9d2f297-dbcc-497a-b56c-a4243c50791a","402":"1a58ad01-7c79-453a-96c1-0b1881cc76e2","403":"1f5fc8fa-96ca-439b-a5fe-a530f74f9cc1","404":"7472f577-e238-4035-9963-5d633a0dbafe","422":"eab251f7-b96d-4fb3-842b-853e515fafeb","429":"47456930-01f1-4e58-8f89-b99cae3022ef","500":"0d025e58-2aaf-498e-9fad-1b2fcf0e38cf","503":"4f6db24d-8eef-4f44-88a0-8248cbfad851"},"summary":"Screenshot a page","tags":["Media"],"method":"post","type":"path","servers":["edec2f24-d4c7-4826-9946-c685b33e71b3"],"security":["cbb9fef5-bd71-4a14-aa34-b981cfcaf711"],"path":"/v1/web/screenshot","baseUrlOptions":["https://api.hydrafetch.com"],"title":"Screenshot a page","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","example":"https://example.com","description":"The URL to screenshot. Must be http(s).","isRequired":true,"uniqueKey":"url","typeLabel":"string"},"fullPage":{"type":"boolean","example":true,"description":"Capture the entire scrollable page instead of just the viewport. Default off.","uniqueKey":"fullPage","typeLabel":"boolean"},"waitFor":{"type":"integer","minimum":0,"maximum":30000,"description":"Extra milliseconds to let the page settle before capture.","uniqueKey":"waitFor","typeLabel":"integer"},"timeout":{"type":"integer","minimum":1000,"maximum":100000,"description":"Overall time budget for the request, in milliseconds.","uniqueKey":"timeout","typeLabel":"integer"},"maxAge":{"type":"integer","minimum":0,"description":"Reuse a stored screenshot if it is younger than this many milliseconds. Defaults to 7 days, so a repeated request returns the stored PNG with `cached: true` without re-rendering — which also means it returns immediately and does not apply `waitFor`. Pass 0 to force a fresh capture.","uniqueKey":"maxAge","typeLabel":"integer"},"viewport":{"type":"string","enum":["desktop","laptop","tablet","mobile"],"example":"desktop","description":"Screen size to render at. Defaults to desktop (1920x1080). Ignored when width/height are given explicitly.","uniqueKey":"viewport","typeLabel":"enum\u003cstring>"},"viewportWidth":{"type":"integer","minimum":320,"maximum":3840,"description":"Exact viewport width in pixels. Overrides `viewport`.","uniqueKey":"viewportWidth","typeLabel":"integer"},"viewportHeight":{"type":"integer","minimum":240,"maximum":2160,"description":"Exact viewport height in pixels. Overrides `viewport`. With fullPage the capture still extends to the full page height.","uniqueKey":"viewportHeight","typeLabel":"integer"},"dismissCookies":{"type":"boolean","description":"Accept cookie and consent banners before the capture. Default true. Set false to capture them.","uniqueKey":"dismissCookies","typeLabel":"boolean"},"dismissPopups":{"type":"boolean","description":"Clear popups and overlays covering the page before the capture. Default true. Set false to capture them.","uniqueKey":"dismissPopups","typeLabel":"boolean"}},"required":["url"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"url":"https://example.com","fullPage":true,"waitFor":15000,"timeout":50500,"maxAge":1,"viewport":"desktop","viewportWidth":2080,"viewportHeight":1200,"dismissCookies":true,"dismissPopups":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"abb285ff-e22b-4e39-b24e-130687c0c493":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"url":{"type":"string","example":"https://example.com","description":"The URL you requested.","isRequired":true,"uniqueKey":"data.url","typeLabel":"string"},"finalUrl":{"type":"string","example":"https://example.com/","description":"The final URL after any redirects.","isRequired":true,"uniqueKey":"data.finalUrl","typeLabel":"string"},"status":{"type":"integer","example":200,"description":"HTTP status of the captured page.","isRequired":true,"uniqueKey":"data.status","typeLabel":"integer"},"screenshot":{"type":"string","example":"https://media.hydrafetch.com/screenshots/a1/a1b2c3.png","description":"Public URL of the captured PNG. Stable for the same URL and options.","isRequired":true,"uniqueKey":"data.screenshot","typeLabel":"string"},"screenshotType":{"type":"string","enum":["fullPage","viewport"],"example":"viewport","description":"Whether the capture covers the whole scrollable page or just the viewport.","isRequired":true,"uniqueKey":"data.screenshotType","typeLabel":"enum\u003cstring>"},"width":{"type":"integer","example":1920,"description":"Image width in pixels.","isRequired":true,"uniqueKey":"data.width","typeLabel":"integer"},"height":{"type":"integer","example":1080,"description":"Image height in pixels.","isRequired":true,"uniqueKey":"data.height","typeLabel":"integer"},"cached":{"type":"boolean","example":false,"description":"True when a stored screenshot was reused instead of capturing a new one.","isRequired":true,"uniqueKey":"data.cached","typeLabel":"boolean"}},"required":["url","finalUrl","status","screenshot","screenshotType","width","height","cached"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"url":"https://example.com","finalUrl":"https://example.com/","status":200,"screenshot":"https://media.hydrafetch.com/screenshots/a1/a1b2c3.png","screenshotType":"viewport","width":1920,"height":1080,"cached":false}}}},"exampleType":"generated"}},"exampleType":"generated"},"7c20679e-8bbf-470a-a250-bb1e43e0a500":{"description":"Still running; poll /v1/web/jobs/{id}.","content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","example":"019f3c09-6fae-740f-9257-10c2b6af7f43","isRequired":true,"uniqueKey":"jobId","typeLabel":"string"},"status":{"type":"string","enum":["running"],"example":"running","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"poll":{"type":"string","example":"/v1/web/jobs/019f3c09-6fae-740f-9257-10c2b6af7f43","description":"Poll this path until the status is completed or failed.","isRequired":true,"uniqueKey":"poll","typeLabel":"string"}},"required":["jobId","status","poll"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"jobId":"019f3c09-6fae-740f-9257-10c2b6af7f43","status":"running","poll":"/v1/web/jobs/019f3c09-6fae-740f-9257-10c2b6af7f43"}}},"exampleType":"generated"}},"exampleType":"generated"},"7bce5940-cb08-45b9-b0a0-7d9c85fd516e":{"description":"The request body or query failed validation.","content":{"application/json":{"schema":{"type":"object","required":["success","error","meta"],"description":"Every failure on this API returns this shape, whatever the status. Successful responses never carry it.","properties":{"success":{"type":"boolean","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","INVALID_INPUT","UNAUTHORIZED","INSUFFICIENT_CREDITS","FORBIDDEN","WORKSPACE_BANNED","NOT_FOUND","TOO_MANY_REQUESTS","UPSTREAM_UNREACHABLE","SERVICE_UNAVAILABLE","INTERNAL_SERVER_ERROR"],"description":"Stable, machine-readable reason. Branch on this rather than on the message, which may be reworded.","example":"INSUFFICIENT_CREDITS","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Safe to show a user, not to parse.","example":"Insufficient credits","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional machine-readable context, present on validation failures.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","description":"Quote this when contacting support about a specific failure.","example":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c","uniqueKey":"meta.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"url must be a valid URL"},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"url must be a valid URL"},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}}}},"exampleType":"examples"}},"exampleType":"examples"},"f9d2f297-dbcc-497a-b56c-a4243c50791a":{"description":"The X-API-Key header is missing, malformed, or names a key that no longer exists.","content":{"application/json":{"schema":{"type":"object","required":["success","error","meta"],"description":"Every failure on this API returns this shape, whatever the status. Successful responses never carry it.","properties":{"success":{"type":"boolean","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","INVALID_INPUT","UNAUTHORIZED","INSUFFICIENT_CREDITS","FORBIDDEN","WORKSPACE_BANNED","NOT_FOUND","TOO_MANY_REQUESTS","UPSTREAM_UNREACHABLE","SERVICE_UNAVAILABLE","INTERNAL_SERVER_ERROR"],"description":"Stable, machine-readable reason. Branch on this rather than on the message, which may be reworded.","example":"INSUFFICIENT_CREDITS","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Safe to show a user, not to parse.","example":"Insufficient credits","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional machine-readable context, present on validation failures.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","description":"Quote this when contacting support about a specific failure.","example":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c","uniqueKey":"meta.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"UNAUTHORIZED","message":"Missing X-API-Key header. Agents: https://hydrafetch.com/auth.md"},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"UNAUTHORIZED","message":"Missing X-API-Key header. Agents: https://hydrafetch.com/auth.md"},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}}}},"exampleType":"examples"}},"exampleType":"examples"},"1a58ad01-7c79-453a-96c1-0b1881cc76e2":{"description":"The workspace has no credits left for this request. Nothing was charged and nothing was fetched.","content":{"application/json":{"schema":{"type":"object","required":["success","error","meta"],"description":"Every failure on this API returns this shape, whatever the status. Successful responses never carry it.","properties":{"success":{"type":"boolean","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","INVALID_INPUT","UNAUTHORIZED","INSUFFICIENT_CREDITS","FORBIDDEN","WORKSPACE_BANNED","NOT_FOUND","TOO_MANY_REQUESTS","UPSTREAM_UNREACHABLE","SERVICE_UNAVAILABLE","INTERNAL_SERVER_ERROR"],"description":"Stable, machine-readable reason. Branch on this rather than on the message, which may be reworded.","example":"INSUFFICIENT_CREDITS","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Safe to show a user, not to parse.","example":"Insufficient credits","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional machine-readable context, present on validation failures.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","description":"Quote this when contacting support about a specific failure.","example":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c","uniqueKey":"meta.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"INSUFFICIENT_CREDITS","message":"Insufficient credits"},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"INSUFFICIENT_CREDITS","message":"Insufficient credits"},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}}}},"exampleType":"examples"}},"exampleType":"examples"},"1f5fc8fa-96ca-439b-a5fe-a530f74f9cc1":{"description":"The key is valid but the workspace may not make this request.","content":{"application/json":{"schema":{"type":"object","required":["success","error","meta"],"description":"Every failure on this API returns this shape, whatever the status. Successful responses never carry it.","properties":{"success":{"type":"boolean","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","INVALID_INPUT","UNAUTHORIZED","INSUFFICIENT_CREDITS","FORBIDDEN","WORKSPACE_BANNED","NOT_FOUND","TOO_MANY_REQUESTS","UPSTREAM_UNREACHABLE","SERVICE_UNAVAILABLE","INTERNAL_SERVER_ERROR"],"description":"Stable, machine-readable reason. Branch on this rather than on the message, which may be reworded.","example":"INSUFFICIENT_CREDITS","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Safe to show a user, not to parse.","example":"Insufficient credits","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional machine-readable context, present on validation failures.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","description":"Quote this when contacting support about a specific failure.","example":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c","uniqueKey":"meta.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"WORKSPACE_BANNED","message":"This workspace has been suspended and cannot make API requests."},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"WORKSPACE_BANNED","message":"This workspace has been suspended and cannot make API requests."},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}}}},"exampleType":"examples"}},"exampleType":"examples"},"7472f577-e238-4035-9963-5d633a0dbafe":{"description":"No such job, or the id belongs to another workspace.","content":{"application/json":{"schema":{"type":"object","required":["success","error","meta"],"description":"Every failure on this API returns this shape, whatever the status. Successful responses never carry it.","properties":{"success":{"type":"boolean","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","INVALID_INPUT","UNAUTHORIZED","INSUFFICIENT_CREDITS","FORBIDDEN","WORKSPACE_BANNED","NOT_FOUND","TOO_MANY_REQUESTS","UPSTREAM_UNREACHABLE","SERVICE_UNAVAILABLE","INTERNAL_SERVER_ERROR"],"description":"Stable, machine-readable reason. Branch on this rather than on the message, which may be reworded.","example":"INSUFFICIENT_CREDITS","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Safe to show a user, not to parse.","example":"Insufficient credits","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional machine-readable context, present on validation failures.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","description":"Quote this when contacting support about a specific failure.","example":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c","uniqueKey":"meta.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"NOT_FOUND","message":"Job not found"},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"NOT_FOUND","message":"Job not found"},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}}}},"exampleType":"examples"}},"exampleType":"examples"},"eab251f7-b96d-4fb3-842b-853e515fafeb":{"description":"The target site did not respond, or we could not read that page. This is a fact about that URL rather than a fault on our side, and retrying it will not change the answer. When details.retryAfterSeconds is present, asking again before then returns this same answer. Nothing was charged.","content":{"application/json":{"schema":{"type":"object","required":["success","error","meta"],"description":"Every failure on this API returns this shape, whatever the status. Successful responses never carry it.","properties":{"success":{"type":"boolean","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","INVALID_INPUT","UNAUTHORIZED","INSUFFICIENT_CREDITS","FORBIDDEN","WORKSPACE_BANNED","NOT_FOUND","TOO_MANY_REQUESTS","UPSTREAM_UNREACHABLE","SERVICE_UNAVAILABLE","INTERNAL_SERVER_ERROR"],"description":"Stable, machine-readable reason. Branch on this rather than on the message, which may be reworded.","example":"INSUFFICIENT_CREDITS","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Safe to show a user, not to parse.","example":"Insufficient credits","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional machine-readable context, present on validation failures.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","description":"Quote this when contacting support about a specific failure.","example":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c","uniqueKey":"meta.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"UPSTREAM_UNREACHABLE","message":"The origin did not respond to any attempt we made."},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"UPSTREAM_UNREACHABLE","message":"The origin did not respond to any attempt we made."},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}}}},"exampleType":"examples"}},"exampleType":"examples"},"47456930-01f1-4e58-8f89-b99cae3022ef":{"description":"The workspace exceeded its per-minute request limit. Read the RateLimit headers, or Retry-After on this response, and retry after the window resets.","headers":{"Retry-After":{"description":"Seconds to wait before retrying. Prefer this over a fixed backoff.","schema":{"type":"integer","example":17}},"RateLimit":{"description":"Requests remaining (r) and seconds until the window resets (t).","schema":{"type":"string","example":"\"workspace\";r=0;t=17"}},"RateLimit-Policy":{"description":"The quota (q) for your plan and the window it applies over (w), in seconds.","schema":{"type":"string","example":"\"workspace\";q=600;w=60"}}},"content":{"application/json":{"schema":{"type":"object","required":["success","error","meta"],"description":"Every failure on this API returns this shape, whatever the status. Successful responses never carry it.","properties":{"success":{"type":"boolean","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","INVALID_INPUT","UNAUTHORIZED","INSUFFICIENT_CREDITS","FORBIDDEN","WORKSPACE_BANNED","NOT_FOUND","TOO_MANY_REQUESTS","UPSTREAM_UNREACHABLE","SERVICE_UNAVAILABLE","INTERNAL_SERVER_ERROR"],"description":"Stable, machine-readable reason. Branch on this rather than on the message, which may be reworded.","example":"INSUFFICIENT_CREDITS","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Safe to show a user, not to parse.","example":"Insufficient credits","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional machine-readable context, present on validation failures.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","description":"Quote this when contacting support about a specific failure.","example":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c","uniqueKey":"meta.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"TOO_MANY_REQUESTS","message":"Rate limit exceeded for this workspace and plan."},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"TOO_MANY_REQUESTS","message":"Rate limit exceeded for this workspace and plan."},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}}}},"exampleType":"examples"}},"exampleType":"examples"},"0d025e58-2aaf-498e-9fad-1b2fcf0e38cf":{"description":"Unexpected server error. Nothing was charged.","content":{"application/json":{"schema":{"type":"object","required":["success","error","meta"],"description":"Every failure on this API returns this shape, whatever the status. Successful responses never carry it.","properties":{"success":{"type":"boolean","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","INVALID_INPUT","UNAUTHORIZED","INSUFFICIENT_CREDITS","FORBIDDEN","WORKSPACE_BANNED","NOT_FOUND","TOO_MANY_REQUESTS","UPSTREAM_UNREACHABLE","SERVICE_UNAVAILABLE","INTERNAL_SERVER_ERROR"],"description":"Stable, machine-readable reason. Branch on this rather than on the message, which may be reworded.","example":"INSUFFICIENT_CREDITS","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Safe to show a user, not to parse.","example":"Insufficient credits","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional machine-readable context, present on validation failures.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","description":"Quote this when contacting support about a specific failure.","example":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c","uniqueKey":"meta.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","message":"Internal server error"},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","message":"Internal server error"},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}}}},"exampleType":"examples"}},"exampleType":"examples"},"4f6db24d-8eef-4f44-88a0-8248cbfad851":{"description":"A dependency needed for the requested formats is unavailable. Safe to retry.","content":{"application/json":{"schema":{"type":"object","required":["success","error","meta"],"description":"Every failure on this API returns this shape, whatever the status. Successful responses never carry it.","properties":{"success":{"type":"boolean","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","INVALID_INPUT","UNAUTHORIZED","INSUFFICIENT_CREDITS","FORBIDDEN","WORKSPACE_BANNED","NOT_FOUND","TOO_MANY_REQUESTS","UPSTREAM_UNREACHABLE","SERVICE_UNAVAILABLE","INTERNAL_SERVER_ERROR"],"description":"Stable, machine-readable reason. Branch on this rather than on the message, which may be reworded.","example":"INSUFFICIENT_CREDITS","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Safe to show a user, not to parse.","example":"Insufficient credits","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Optional machine-readable context, present on validation failures.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"requestId":{"type":"string","description":"Quote this when contacting support about a specific failure.","example":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c","uniqueKey":"meta.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"SERVICE_UNAVAILABLE","message":"The summary and json formats are not available."},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"SERVICE_UNAVAILABLE","message":"The summary and json formats are not available."},"meta":{"requestId":"019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"cbb9fef5-bd71-4a14-aa34-b981cfcaf711":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"apiKey"}}},"servers":{"edec2f24-d4c7-4826-9946-c685b33e71b3":{"url":"https://api.hydrafetch.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-Key"}],"title":"apiKey"}]},"originalFileLocation":"https://api.hydrafetch.com/openapi.json"},"subdomain":"hydrafetch","siteName":"Hydrafetch","title":"Screenshot a page - Hydrafetch","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T16:23:05.977Z","originalFileLocation":"api-reference/media/screenshot-a-page.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=\"system\"}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=\"Capture a full-page PNG screenshot of a rendered page.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hydrafetch\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hydrafetch/NoqeqB75AwFil_Bs/_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/hydrafetch/NoqeqB75AwFil_Bs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hydrafetch/NoqeqB75AwFil_Bs/_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/hydrafetch/NoqeqB75AwFil_Bs/_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/hydrafetch/NoqeqB75AwFil_Bs/_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/hydrafetch/NoqeqB75AwFil_Bs/_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/hydrafetch/NoqeqB75AwFil_Bs/_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/hydrafetch/NoqeqB75AwFil_Bs/_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/hydrafetch/NoqeqB75AwFil_Bs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Screenshot a page - Hydrafetch\">\u003cmeta data-mint-head property=\"og:description\" content=\"Turn any URL into clean Markdown and structured data your model can use. Scrape, crawl, search and extract with one API, one credit a page.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hydrafetch Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hydrafetch.com/api-reference/media/screenshot-a-page\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hydrafetch.mintlify.site/_mintlify/api/og/v2?division=Media\u0026amp;title=Screenshot+a+page\u0026amp;description=Capture+a+full-page+PNG+screenshot+of+a+rendered+page.\u0026amp;theme=b060ea6dae0bddd44da99abe\u0026amp;signature=fe738e18efc54840f883fb04b125ca7201090c2964456c648430a6275e4e4622\">\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=\"Screenshot a page - Hydrafetch\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Turn any URL into clean Markdown and structured data your model can use. Scrape, crawl, search and extract with one API, one credit a page.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hydrafetch.mintlify.site/_mintlify/api/og/v2?division=Media\u0026amp;title=Screenshot+a+page\u0026amp;description=Capture+a+full-page+PNG+screenshot+of+a+rendered+page.\u0026amp;theme=b060ea6dae0bddd44da99abe\u0026amp;signature=fe738e18efc54840f883fb04b125ca7201090c2964456c648430a6275e4e4622\">\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/hydrafetch/NoqeqB75AwFil_Bs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hydrafetch\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0E7490\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hydrafetch.com/api-reference/media/screenshot-a-page\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/media/screenshot-a-page.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hydrafetch.com/#organization\",\"name\":\"Hydrafetch\",\"url\":\"https://docs.hydrafetch.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hydrafetch/koPVMLXM3S4OTC3p/logo/lockup-light.svg?fit=max\u0026auto=format\u0026n=koPVMLXM3S4OTC3p\u0026q=85\u0026s=581b06c8816bc26dd6badf943c86aa6a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hydrafetch.com#website\",\"name\":\"Hydrafetch\",\"url\":\"https://docs.hydrafetch.com\",\"publisher\":{\"@id\":\"https://docs.hydrafetch.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hydrafetch.com/api-reference/media/screenshot-a-page#webpage\",\"url\":\"https://docs.hydrafetch.com/api-reference/media/screenshot-a-page\",\"name\":\"Screenshot a page\",\"description\":\"Capture a full-page PNG screenshot of a rendered page.\",\"dateModified\":\"2026-11-12T16:23:05.977Z\",\"isPartOf\":{\"@id\":\"https://docs.hydrafetch.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hydrafetch.com/api-reference/media/screenshot-a-page#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hydrafetch.com/api-reference/media/screenshot-a-page#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Media\",\"item\":\"https://docs.hydrafetch.com/api-reference/media/harvest-a-pages-images\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Screenshot a page\",\"item\":\"https://docs.hydrafetch.com/api-reference/media/screenshot-a-page\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hydrafetch.com/api-reference/media/screenshot-a-page#apireference\",\"headline\":\"Screenshot a page\",\"name\":\"Screenshot a page\",\"description\":\"Capture a full-page PNG screenshot of a rendered page.\",\"url\":\"https://docs.hydrafetch.com/api-reference/media/screenshot-a-page\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hydrafetch.com/api-reference/media/screenshot-a-page#webpage\"},\"dateModified\":\"2026-11-12T16:23:05.977Z\",\"publisher\":{\"@id\":\"https://docs.hydrafetch.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hydrafetch.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hydrafetch\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hydrafetch\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/media/screenshot-a-page.md","siteName":"Hydrafetch","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Blueprints","pages":[{"title":"Blueprints","href":"/blueprints/overview"}]},{"tab":"Help Center","pages":[{"title":"Help Center","href":"/help/account"}]},{"tab":"API Reference","groups":[{"group":"Jobs","pages":[{"title":"Get a job","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json get /v1/web/jobs/{id}","href":"/api-reference/jobs/get-a-job"}]},{"group":"Brand","pages":[{"title":"Resolve a brand","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json get /v1/web/brand","href":"/api-reference/brand/resolve-a-brand"},{"title":"Resolve many brands","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/brand","href":"/api-reference/brand/resolve-many-brands"},{"title":"Get a company logo","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json get /v1/web/brand/logo","href":"/api-reference/brand/get-a-company-logo"},{"title":"Search brands","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json get /v1/web/brand/search","href":"/api-reference/brand/search-brands"},{"title":"Read a company's design system","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json get /v1/web/styleguide","href":"/api-reference/brand/read-a-companys-design-system"}]},{"group":"Scrape","pages":[{"title":"Scrape a URL","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/scrape","href":"/api-reference/scrape/scrape-a-url"},{"title":"Scrape to Markdown","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/markdown","href":"/api-reference/scrape/scrape-to-markdown"},{"title":"Scrape to HTML","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/html","href":"/api-reference/scrape/scrape-to-html"},{"title":"Scrape raw HTML","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/raw-html","href":"/api-reference/scrape/scrape-raw-html"},{"title":"Get a page's links","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/links","href":"/api-reference/scrape/get-a-pages-links"},{"title":"Get structured data","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/structured","href":"/api-reference/scrape/get-structured-data"},{"title":"Get scrape job status","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json get /v1/web/scrape/{id}","href":"/api-reference/scrape/get-scrape-job-status"}]},{"group":"Media","pages":[{"title":"Harvest a page's images","description":"Harvest all images from a page with their metadata.","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/images","href":"/api-reference/media/harvest-a-pages-images"},{"title":"Screenshot a page","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/screenshot","href":"/api-reference/media/screenshot-a-page"}]},{"group":"Logo","pages":[{"title":"Serve a company logo","description":"The image bytes for a domain, ready to drop into an `\u003cimg>` tag. Authenticated with a publishable key in the `token` parameter, so it is safe to put in a browser. A domain we have not seen yet answers with a monogram immediately and the real logo on the next request.","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json get /v1/web/logo/{domain}","href":"/api-reference/logo/serve-a-company-logo"}]},{"group":"Crawl \u0026 batch","pages":[{"title":"Map a site","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/map","href":"/api-reference/crawl-\u0026-batch/map-a-site"},{"title":"Start a crawl","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/crawl","href":"/api-reference/crawl-\u0026-batch/start-a-crawl"},{"title":"Start a batch","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/batch","href":"/api-reference/crawl-\u0026-batch/start-a-batch"},{"title":"Get crawl status","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json get /v1/web/crawl/{id}","href":"/api-reference/crawl-\u0026-batch/get-crawl-status"},{"title":"Get batch status","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json get /v1/web/batch/{id}","href":"/api-reference/crawl-\u0026-batch/get-batch-status"},{"title":"List webhook deliveries for a crawl","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json get /v1/web/crawl/{id}/deliveries","href":"/api-reference/crawl-\u0026-batch/list-webhook-deliveries-for-a-crawl"},{"title":"List webhook deliveries for a batch","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json get /v1/web/batch/{id}/deliveries","href":"/api-reference/crawl-\u0026-batch/list-webhook-deliveries-for-a-batch"}]},{"group":"Search","pages":[{"title":"Search the web","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/search","href":"/api-reference/search/search-the-web"}]},{"group":"Indexes","pages":[{"title":"Search open jobs across company career sites","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/index/jobs/search","href":"/api-reference/indexes/search-open-jobs-across-company-career-sites"},{"title":"What changed in a company's hiring","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/index/jobs/changes","href":"/api-reference/indexes/what-changed-in-a-companys-hiring"}]},{"group":"News","pages":[{"title":"Search the news","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/news","href":"/api-reference/news/search-the-news"}]},{"group":"Extract","pages":[{"title":"Extract structured data from URLs","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/extract","href":"/api-reference/extract/extract-structured-data-from-urls"}]},{"group":"Feedback","pages":[{"title":"Rate a result","deprecated":null,"version":null,"openapi":"https://api.hydrafetch.com/openapi.json post /v1/web/feedback","href":"/api-reference/feedback/rate-a-result"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Screenshot a page - Hydrafetch","buildId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","deploymentId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CDiBsYGW.js","utils-KF9rPlmF.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C26urKTX.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BdjmJAC1.js","snippetPresets-3IpDBjt3.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-D4x_2vvo.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BIWdc5Pa.js","shallow-LQqfiMNd.js","getApiPlaygroundDisplay-DryzlOZG.js","CodeSnippet-tcJujU4r.js","CodeSnippets-BHp0nVLL.js","Page-1CZdsdAn.js","getPastedJson-DU-1ayUv.js","icon-CZK2hPr4.js","MethodPill-DOaqmTFC.js","DuplicateIcon-B5-nUxxl.js","createIcon-CDP_U77G.js","DynamicMarkdown-GHvayGOn.js","SectionHeading-BYvpkmUD.js","axios-vUo_bRtp.js","Markdown-uxhlayGT.js","clsx-B35qUV0p.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BvrGG8gU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CAf0yVYe.js"]}