{
"error": "Payment required to access this resource."
}
{
"error": "Request rate limit exceeded. Please wait and try again later."
}
{
"success": false,
"code": "UNKNOWN_ERROR",
"error": "An unexpected error occurred on the server."
}
Upload a local or non-public document and convert it into clean, LLM-ready context. /parse accepts file bytes via multipart/form-data and returns Markdown, JSON, HTML, links, images, or a summary — with reading order and tables preserved.
Turn PDF, Word, Excel, PowerPoint, OpenDocument, EPUB, CSV, HTML, and more into Markdown or structured JSON
Use /parse when the source document is a local file or not publicly accessible by URL. If you have a public URL that points to a document, prefer /scrape — it auto-detects the file type from the extension or content type and parses it the same way.
Source
Endpoint
Public URL to a document (e.g. https://example.com/report.pdf)
Local file or non-public bytes (PDF, DOCX, XLSX, HTML, …)
POST /parse (this endpoint)
Using Firecrawl through MCP? Use firecrawl_parse for local files. Local MCP can read the file directly when configured with FIRECRAWL_API_URL. Remote hosted MCP returns a short-lived upload command first, then parses the returned uploadRef. Public document URLs should still use /scrape.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Firecrawl Docs","colors":{"primary":"#000","light":"#fff","dark":"#000"},"logo":{"light":"https://mintcdn.com/firecrawl/iilnMwCX-8eR1yOO/logo/logo.png?fit=max\u0026auto=format\u0026n=iilnMwCX-8eR1yOO\u0026q=85\u0026s=c45b3c967c19a39190e76fe8e9c2ed5a","dark":"https://mintcdn.com/firecrawl/iilnMwCX-8eR1yOO/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=iilnMwCX-8eR1yOO\u0026q=85\u0026s=3fee4abe033bd3c26e8ad92043a91c17","href":"https://firecrawl.dev"},"favicon":"https://mintcdn.com/firecrawl/vlKm1oZYK3oSRVTM/favicon.ico?fit=max\u0026auto=format\u0026n=vlKm1oZYK3oSRVTM\u0026q=85\u0026s=cd95e713995e71b79a2e393957f6f661","navbar":{"links":[{"href":"https://firecrawl.betteruptime.com","label":"Status"},{"href":"mailto:help@firecrawl.com","label":"Support"},{"href":"https://www.firecrawl.dev/signin?utm_source=firecrawl_docs\u0026utm_medium=nav_bar\u0026utm_content=sign_up","label":"Sign Up"}],"primary":{"type":"github","href":"https://github.com/firecrawl/firecrawl"}},"footer":{"socials":{"github":"https://github.com/firecrawl/firecrawl","linkedin":"https://www.linkedin.com/company/firecrawl","website":"https://community.firecrawl.dev/","x":"https://x.com/firecrawl"},"links":[{"header":"For AI agents","items":[{"label":"Get credentials","href":"https://docs.firecrawl.dev/ai-onboarding"},{"label":"Agent onboarding (SKILL.md)","href":"https://www.firecrawl.dev/agent-onboarding/SKILL.md"},{"label":"Agent auth (auth.md)","href":"https://www.firecrawl.dev/auth.md"},{"label":"Agent docs (llms.txt)","href":"https://docs.firecrawl.dev/llms.txt"},{"label":"Full docs (llms-full.txt)","href":"https://docs.firecrawl.dev/llms-full.txt"},{"label":"MCP server","href":"https://docs.firecrawl.dev/mcp-server"}]}]},"seo":{"metatags":{"google-site-verification":"Y83UZz1dXMKuT59lnLY_7umo6LJorqIwuP_2rFX6_eE"}},"integrations":{"ga4":{"measurementId":"G-JZJ1L5MYR1"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":"introduction"},{"language":"es","href":"es/introduction"},{"language":"fr","href":"fr/introduction"},{"language":"ja","href":"ja/introduction"},{"language":"pt-BR","href":"pt-BR/introduction"},{"language":"zh","href":"zh/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"firecrawl","hasAudioNarration":false,"actualSubdomain":"firecrawl","customDomains":["docs.firecrawl.dev"],"gitSource":{"type":"github","owner":"firecrawl","repo":"firecrawl-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adc2b2c2c494436a81b039b","collectionId":"2379205d-8e94-482f-9f14-6ad50a1f689d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adc2b2c2c494436a81b039b"},"feedback":{"thumbs":false,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adc2b2c2c494436a81b039b","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"en","tag":"Documentation","count":115},{"language":"es","tag":"Documentación","count":115},{"language":"fr","tag":"Documentation","count":115},{"language":"ja","tag":"ドキュメント","count":115},{"language":"pt-BR","tag":"Documentação","count":115},{"language":"zh","tag":"文档","count":115},{"language":"en","tag":"API Reference","count":66},{"language":"es","tag":"Referencia de la API","count":66},{"language":"fr","tag":"Référence de l’API","count":66},{"language":"ja","tag":"APIリファレンス","count":66},{"language":"pt-BR","tag":"Referência da API","count":66},{"language":"zh","tag":"API 参考","count":66},{"language":"en","tag":"Build with AI","count":58},{"language":"es","tag":"Crear con IA","count":58},{"language":"fr","tag":"Créer avec l’IA","count":58},{"language":"pt-BR","tag":"Desenvolva com IA","count":58},{"language":"zh","tag":"使用 AI 构建","count":58},{"language":"ja","tag":"AIで構築","count":56},{"language":"en","tag":"Quickstarts","count":33},{"language":"es","tag":"Inicios rápidos","count":33},{"language":"fr","tag":"Démarrages rapides","count":33},{"language":"ja","tag":"クイックスタート","count":33},{"language":"pt-BR","tag":"Guias de início rápido","count":33},{"language":"zh","tag":"快速入门","count":33},{"language":"en","tag":"Agent Harnesses","count":32},{"language":"es","tag":"Entornos de agentes","count":32},{"language":"fr","tag":"Intégrations pour agent","count":32},{"language":"ja","tag":"エージェントハーネス","count":32},{"language":"pt-BR","tag":"Integrações com agentes","count":32},{"language":"zh","tag":"代理工具","count":32},{"language":"en","tag":"Developer Guides","count":22},{"language":"es","tag":"Guías para desarrolladores","count":22},{"language":"fr","tag":"Guides développeur","count":22},{"language":"ja","tag":"開発者ガイド","count":22},{"language":"pt-BR","tag":"Guias para desenvolvedores","count":22},{"language":"zh","tag":"开发者指南","count":22},{"language":"en","tag":"Platforms and frameworks","count":19},{"language":"es","tag":"Plataformas y frameworks","count":19},{"language":"fr","tag":"Plateformes et frameworks","count":19},{"language":"ja","tag":"プラットフォームとフレームワーク","count":19},{"language":"pt-BR","tag":"Plataformas e frameworks","count":19},{"language":"zh","tag":"平台与框架","count":19},{"language":"es","tag":"Primeros pasos","count":16},{"language":"ja","tag":"はじめに","count":16},{"language":"pt-BR","tag":"Primeiros passos","count":16},{"language":"en","tag":"Get Started","count":14},{"language":"en","tag":"Webhook Payloads","count":13},{"language":"en","tag":"Core Endpoints","count":13},{"language":"es","tag":"Cargas útiles de webhook","count":13},{"language":"es","tag":"Endpoints principales","count":13},{"language":"fr","tag":"Démarrage rapide","count":13},{"language":"fr","tag":"Charges utiles de webhook","count":13},{"language":"fr","tag":"Points de terminaison de base","count":13},{"language":"ja","tag":"webhook ペイロード","count":13},{"language":"ja","tag":"主要エンドポイント","count":13},{"language":"pt-BR","tag":"Payloads de webhook","count":13},{"language":"pt-BR","tag":"Endpoints principais","count":13},{"language":"zh","tag":"快速开始","count":13},{"language":"zh","tag":"Webhook 负载","count":13},{"language":"zh","tag":"核心端点","count":13}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"instinct-self-updating-docs","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".dark .firecrawl-cta-btn-primary:hover,.dark li.navbar-link a[href*=\"firecrawl.dev/signin\"]:hover,li.navbar-link a[href*=\"firecrawl.dev/signin\"]:hover{background-color:#e64500}.dark li.navbar-link a[href*=\"firecrawl.dev/signin\"],li.navbar-link a[href*=\"firecrawl.dev/signin\"]{background-color:#ff4d00;color:#fff}li.navbar-link:has(a[href*=\"firecrawl.dev/signin\"]){order:99}nav ul li:has(a[href=\"https://github.com/firecrawl/firecrawl\"]){order:-1}#firecrawl-cta-widget{margin-top:24px}.firecrawl-cta-box{background:linear-gradient(180deg,rgba(255,77,0,.04) 0,rgba(255,77,0,.02) 100%);border:1px solid rgba(255,77,0,.15);border-radius:12px;padding:20px}.firecrawl-cta-logo{height:20px;width:auto;object-fit:contain;margin-bottom:12px}.dark .firecrawl-cta-logo-light,.firecrawl-cta-logo-dark{display:none}.dark .firecrawl-cta-logo-dark{display:block}.firecrawl-cta-title{font-size:18px;font-weight:600;color:#111;margin:0 0 8px;line-height:1.3}.firecrawl-cta-description{font-size:13px;line-height:1.5;color:#666;margin:0 0 16px}.firecrawl-cta-description strong{color:#333}.firecrawl-cta-buttons{display:flex;flex-direction:column;gap:8px}.firecrawl-cta-btn-primary{display:block;text-align:center;background-color:#ff4d00;color:#fff!important;font-size:14px;font-weight:500;line-height:1.5;padding:10px 16px;border-radius:16px;border:0!important;box-shadow:none!important;text-decoration:none!important;transition:background-color .2s ease}.firecrawl-cta-btn-primary:hover{background-color:#e64500;text-decoration:none!important}.firecrawl-cta-btn-inline{display:inline-block}.firecrawl-cta-btn-secondary{display:block;text-align:center;background-color:#fff;color:#333!important;font-size:14px;font-weight:500;padding:10px 16px;border-radius:16px;border:1px solid #e5e7eb;text-decoration:none!important;transition:border-color .2s ease,background-color .2s ease}.firecrawl-cta-btn-secondary:hover{background-color:#f9fafb;border-color:#d1d5db;text-decoration:none!important}.dark .firecrawl-cta-box{background:linear-gradient(180deg,rgba(255,77,0,.08) 0,rgba(255,77,0,.04) 100%);border-color:rgba(255,77,0,.2)}.dark .firecrawl-cta-title{color:#fff}.dark .firecrawl-cta-description{color:#aaa}.dark .firecrawl-cta-description strong{color:#ddd}.dark .firecrawl-cta-btn-primary{background-color:#ff4d00;color:#fff!important}.dark .firecrawl-cta-btn-secondary{background-color:rgba(255,255,255,.05);border-color:rgba(255,255,255,.1);color:#ddd!important}.dark .firecrawl-cta-btn-secondary:hover{background-color:rgba(255,255,255,.1);border-color:rgba(255,255,255,.2)}@media (max-width:1024px){#firecrawl-cta-widget{display:none}}#footer a.max-w-36{max-width:none;overflow:visible;text-overflow:clip;white-space:nowrap}#footer div:has(>a.max-w-36){flex-wrap:wrap}#footer a[href*=\"community.firecrawl.dev\"]>svg{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/solid/comment-dots.svg)!important;mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/solid/comment-dots.svg)!important}.fc-agent-first,.fc-agent-prompt{--fc-heat:#fa5d19;--fc-heat-soft:rgba(250, 93, 25, 0.04);--fc-text:#262626;--fc-text-muted:rgba(38, 38, 38, 0.56);--fc-surface:#fff;--fc-subtle:rgba(0, 0, 0, 0.02);--fc-subtle-hover:rgba(0, 0, 0, 0.06);--fc-border:#ededed;color:var(--fc-text);font-family:inherit}.dark .fc-agent-first,.dark .fc-agent-prompt{--fc-heat-soft:rgba(250, 93, 25, 0.08);--fc-text:#f5f5f5;--fc-text-muted:rgba(255, 255, 255, 0.56);--fc-surface:#171717;--fc-subtle:rgba(255, 255, 255, 0.02);--fc-subtle-hover:rgba(255, 255, 255, 0.08);--fc-border:#2a2a2a}.fc-agent-first{position:relative;margin:20px 0 32px;border:1px solid var(--fc-border);background:var(--fc-surface)}.fc-agent-first-header{display:flex;align-items:flex-start;justify-content:space-between;gap:24px;padding:24px}.fc-agent-first-header h3,.fc-client-panel h4{margin:0;color:var(--fc-text);font-weight:600}.fc-agent-first-header h3{font-size:20px;line-height:28px}.fc-agent-first-header [data-as=p],.fc-agent-first-header p{display:block;max-width:600px;margin:6px 0 0;color:var(--fc-text-muted);font-size:14px;line-height:20px}.fc-all-options-link{display:inline-flex;flex:none;align-items:center;gap:6px;margin-top:3px;color:var(--fc-text-muted)!important;font-size:13px;font-weight:500;text-decoration:none!important;transition:color 160ms ease}.fc-all-options-link:hover{color:var(--fc-heat)!important}.fc-client-tabs{display:grid;grid-auto-flow:column;grid-auto-columns:minmax(0,1fr);overflow-x:auto;border-top:1px solid var(--fc-border);border-bottom:1px solid var(--fc-border);scrollbar-width:thin}.fc-client-tab{position:relative;display:flex;min-width:0;overflow:hidden;flex-direction:column;align-items:center;gap:8px;padding:14px 10px;border:0;border-right:1px solid var(--fc-border);background:0 0;color:var(--fc-text);cursor:pointer;text-align:center;transition:background-color 160ms ease}.fc-client-tab:last-child{border-right:0}.fc-client-tab:hover{background:var(--fc-subtle)}.fc-client-tab.is-active{background:var(--fc-heat-soft);box-shadow:inset 0 2px 0 var(--fc-heat)}.fc-agent-prompt-button:focus-visible,.fc-all-options-link:focus-visible,.fc-client-tab:focus-visible,.fc-copy-button:focus-visible,.fc-install-button:focus-visible{outline:2px solid var(--fc-heat);outline-offset:-2px}.fc-client-icon{display:block;width:26px;height:26px;flex:none;object-fit:contain}.dark .fc-client-icon-mono,.dark img[src*=\"agent-clients/chatgpt.svg\"],.dark img[src*=\"agent-clients/cursor.svg\"]{filter:invert(1) brightness(1.6)}.fc-client-tab-copy{display:flex;min-width:0;max-width:100%;flex-direction:column;gap:2px}.fc-client-tab-copy strong,.fc-client-tab-copy>span{overflow:hidden;color:var(--fc-text);font-size:14px;line-height:20px;text-overflow:ellipsis;white-space:nowrap}.fc-client-tab-copy>span{color:var(--fc-text-muted);font-size:13px;line-height:18px}.fc-client-panel{display:flex;flex-direction:column;gap:14px;padding:20px 24px 24px}.fc-client-panel[hidden]{display:none}.fc-client-description,.fc-client-description[data-as=p],.fc-client-hint,.fc-client-hint[data-as=p]{display:block;margin:0;color:var(--fc-text-muted);font-size:14px;line-height:21px}.fc-client-hint,.fc-client-hint[data-as=p]{font-size:13px;line-height:20px}.fc-client-description code,.fc-client-description[data-as=p] code,.fc-client-hint code,.fc-client-hint[data-as=p] code{border-radius:4px;background:var(--fc-subtle-hover);padding:2px 5px;color:var(--fc-text);font-size:.92em}.fc-code-block{overflow:hidden;border:1px solid var(--fc-border);border-radius:6px;background:var(--fc-subtle)}.fc-code-header{display:flex;min-height:38px;align-items:center;justify-content:space-between;gap:12px;padding:5px 8px 5px 14px;border-bottom:1px solid var(--fc-border);color:var(--fc-text-muted);font-size:12px;font-weight:500}.fc-code-block pre{margin:0;padding:14px 16px;overflow-x:auto;background:0 0;color:var(--fc-text);font-family:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;font-size:12.5px;line-height:20px;white-space:pre-wrap;overflow-wrap:anywhere;word-break:break-word}.fc-code-block pre code{display:block;white-space:inherit;overflow-wrap:inherit;word-break:inherit}.fc-command-row{display:flex;align-items:center;gap:4px;padding:4px;border:1px solid var(--fc-border);border-radius:8px;background:var(--fc-subtle)}.fc-command-scroll{display:flex;min-width:0;flex:1;align-items:center;gap:10px;padding:7px 6px 7px 12px;overflow-x:auto;scrollbar-width:none;-webkit-mask-image:linear-gradient(90deg,#000 calc(100% - 24px),transparent);mask-image:linear-gradient(90deg,#000 calc(100% - 24px),transparent)}.fc-command-scroll::-webkit-scrollbar{display:none}.fc-command-prompt,.fc-command-scroll code{font-family:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace;font-size:13px;line-height:20px}.fc-command-prompt{flex:none;color:var(--fc-text-muted);user-select:none}.fc-command-scroll code{padding:0 20px 0 0;border:0;border-radius:0;background:0 0;color:var(--fc-text);white-space:nowrap}.fc-copy-button{display:inline-flex;min-width:78px;height:28px;align-items:center;justify-content:center;gap:6px;padding:0 9px;border:0;border-radius:6px;background:0 0;color:var(--fc-text-muted);cursor:pointer;font-size:12px;font-weight:500;transition:background-color 160ms ease,color 160ms ease}.fc-copy-button:hover,.fc-install-button{background:var(--fc-subtle-hover);color:var(--fc-text)}.fc-copy-button.is-copied{color:var(--fc-heat)}.fc-install-button{display:inline-flex;width:fit-content;min-height:34px;align-items:center;justify-content:center;gap:7px;padding:0 12px;border-radius:6px;color:var(--fc-text)!important;font-size:13px;font-weight:600;text-decoration:none!important;transition:background-color 160ms ease,transform 160ms ease}.fc-copy-button.is-copied,.fc-install-button:hover{background:var(--fc-heat-soft)}.fc-agent-prompt-button:active,.fc-install-button:active{transform:scale(.98)}.fc-agent-prompt{margin:14px 0 28px}.fc-openai-install-actions{display:flex;flex-wrap:wrap;gap:12px}.fc-openai-install-actions a{text-decoration:none!important;color:var(--fc-text)!important}.fc-openai-install-actions img{flex:none;object-fit:contain}.fc-openai-install-hint{margin:12px 0 0;color:var(--fc-text-muted);font-size:13px;line-height:1.6}.fc-agent-prompt-button{display:inline-flex;min-height:44px;align-items:center;justify-content:center;gap:8px;padding:0 18px;border:0;border-radius:10px;background:var(--fc-subtle-hover);color:var(--fc-text);cursor:pointer;font-size:14px;font-weight:600;box-shadow:inset 0 .75px .75px 0 rgba(0,0,0,.02),inset 0 .25px .25px 0 rgba(0,0,0,.04);transition:background-color 160ms ease,color 160ms ease,transform 160ms ease}.fc-agent-prompt-button:hover{background:rgba(0,0,0,.08)}.dark .fc-agent-prompt-button:hover{background:rgba(255,255,255,.1)}.fc-agent-prompt-button.is-copied{background:var(--fc-heat-soft);color:var(--fc-heat);box-shadow:none}.fc-agent-first-footer{display:flex;flex-direction:column;gap:10px;padding:16px 24px 20px;border-top:1px solid var(--fc-border);background:var(--fc-subtle)}.card [data-component-part=card-icon] img{margin:0}div:has(>a>div.w-full>div.mt-8){height:100%;padding-bottom:60px}a>div.w-full>div.mt-8{position:absolute;right:24px;bottom:20px;left:24px;margin-top:0}.fc-footer-lead,.fc-footer-lead[data-as=p]{display:block;margin:0;color:var(--fc-text);font-size:13px;font-weight:500;line-height:20px}.fc-curve,.fc-curvy-corners{pointer-events:none}.fc-curve{position:absolute;z-index:3;width:11px;height:11px;fill:var(--fc-border)}.fc-curve-tl{top:0;left:0;transform:rotate(-90deg)}.fc-curve-tr{top:0;right:0}.fc-curve-bl{bottom:0;left:0;transform:rotate(180deg)}.fc-curve-br{right:0;bottom:0;transform:rotate(90deg)}.fc-sr-only{position:absolute;width:1px;height:1px;overflow:hidden;margin:-1px;padding:0;border:0;clip:rect(0,0,0,0);white-space:nowrap}@media (max-width:700px){.fc-agent-first-header{flex-direction:column;gap:12px;padding:20px}.fc-client-tabs{grid-auto-flow:row;grid-template-columns:repeat(2,minmax(0,1fr))}.fc-client-tab:nth-child(2n){border-right:0}.fc-client-tab{border-bottom:1px solid var(--fc-border)}.fc-client-tab:last-child,.fc-client-tab:nth-last-child(-n+2):nth-child(odd){border-bottom:0}.fc-client-panel{padding:16px 20px 20px}.fc-command-prompt,.fc-command-scroll code{font-size:12px}.fc-agent-first-footer{padding:14px 20px 18px}.fc-agent-prompt-button,.fc-install-button{width:100%}}@media (prefers-reduced-motion:reduce){.fc-agent-first *,.fc-agent-prompt *{scroll-behavior:auto!important;transition-duration:.01ms!important}}"}],"page":{"pagePath":"api-reference/endpoint/parse","slug":"/api-reference/endpoint/parse","pageMetadata":{"title":"Parse","openapi":"api-reference/v2-openapi.json POST /parse","description":null,"href":"/api-reference/endpoint/parse"},"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={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Table,Tip}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Upload a local or non-public document and convert it into clean, LLM-ready context. `,_jsx(_components.code,{children:`/parse`}),` accepts file bytes via `,_jsx(_components.code,{children:`multipart/form-data`}),` and returns Markdown, JSON, HTML, links, images, or a summary — with reading order and tables preserved.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Turn PDF, Word, Excel, PowerPoint, OpenDocument, EPUB, CSV, HTML, and more into Markdown or structured JSON`}),`\n`,_jsxs(_components.li,{children:[`Up to `,_jsx(_components.strong,{children:`5x faster`}),` parsing via a Rust-based engine`]}),`\n`,_jsxs(_components.li,{children:[`Files up to `,_jsx(_components.strong,{children:`50 MB`}),` per request`]}),`\n`,_jsx(_components.li,{children:`Zero Data Retention support`}),`\n`]}),`\n`,_jsxs(Heading,{level:`2`,id:`when-to-use-/parse`,children:[`When to use `,_jsx(_components.code,{children:`/parse`})]}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`/parse`}),` when the source document is `,_jsx(_components.strong,{children:`a local file`}),` or `,_jsx(_components.strong,{children:`not publicly accessible by URL`}),`. If you have a public URL that points to a document, prefer `,_jsx(_components.a,{href:`/api-reference/endpoint/scrape`,children:_jsx(_components.code,{children:`/scrape`})}),` — it auto-detects the file type from the extension or content type and parses it the same way.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Source`}),_jsx(_components.th,{children:`Endpoint`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Public URL to a document (e.g. `,_jsx(_components.code,{children:`https://example.com/report.pdf`}),`)`]}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api-reference/endpoint/scrape`,children:_jsx(_components.code,{children:`POST /scrape`})})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Local file or non-public bytes (PDF, DOCX, XLSX, HTML, …)`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`POST /parse`}),` (this endpoint)`]})]})]})]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Using Firecrawl through MCP?`}),` Use `,_jsx(_components.code,{children:`firecrawl_parse`}),` for local files. Local MCP can read the file directly when configured with `,_jsx(_components.code,{children:`FIRECRAWL_API_URL`}),`. Remote hosted MCP returns a short-lived upload command first, then parses the returned `,_jsx(_components.code,{children:`uploadRef`}),`. Public document URLs should still use `,_jsx(_components.code,{children:`/scrape`}),`.`]})})]})}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":{"config":{},"pageMetadata":{"title":"Parse","openapi":"api-reference/v2-openapi.json POST /parse","description":null,"href":"/api-reference/endpoint/parse"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"When to use /parse","slug":"when-to-use-/parse","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/firecrawl/0081870911af9531/ready-to-build-cta.js","/_mintlify/custom/firecrawl/8c36557b13c6e455/chatbase-widget.js"],"openApiReferenceData":{"operation":{"summary":"Upload and parse a file","operationId":"parseFile","tags":["Scraping"],"security":["8cdc10f8-2f84-4a0f-a814-feb948c113f4"],"requestBody":"f1a6ee87-0ef8-49ce-acee-a6f464e8c315","responses":{"200":"efc949e2-459c-4d72-a4d2-171a76b30abe","400":"dc354ec6-c845-409c-9d32-729028abe1df","402":"225e7e32-a332-468b-9d07-f83ebcca1556","429":"75d5bd75-365e-455b-898d-85ac2ac028b0","500":"22070355-bc04-4d1a-8924-50d35e1357ab"},"method":"post","type":"path","servers":["7d6b709a-8947-4a54-9707-5b3ba8a3f3cc"],"path":"/parse","baseUrlOptions":["https://api.firecrawl.dev/v2"],"title":"Upload and parse a file","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The file bytes to parse. Supported extensions: .html, .htm, .xhtml, .pdf, .docx, .doc, .docm, .odt, .ods, .odp, .rtf, .xlsx, .xls, .xlsm, .xlsb, .pptx, .ppt, .pptm, .epub, .csv.","isRequired":true,"uniqueKey":"file","typeLabel":"file"},"options":{"type":"object","description":"Optional parse options sent as JSON in the multipart `options` field.","properties":{"formats":{"type":"array","items":{"oneOf":[{"type":"object","title":"Markdown","required":["type"],"properties":{"type":{"type":"string","enum":["markdown"],"isRequired":true,"uniqueKey":"options.formats.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"options.formats.items.[INDEX].oneOf.0","typeLabel":"Markdown · object"},{"type":"object","title":"Summary","required":["type"],"properties":{"type":{"type":"string","enum":["summary"],"isRequired":true,"uniqueKey":"options.formats.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"options.formats.items.[INDEX].oneOf.1","typeLabel":"Summary · object"},{"type":"object","title":"HTML","required":["type"],"properties":{"type":{"type":"string","enum":["html"],"isRequired":true,"uniqueKey":"options.formats.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"options.formats.items.[INDEX].oneOf.2","typeLabel":"HTML · object"},{"type":"object","title":"Raw HTML","required":["type"],"properties":{"type":{"type":"string","enum":["rawHtml"],"isRequired":true,"uniqueKey":"options.formats.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"options.formats.items.[INDEX].oneOf.3","typeLabel":"Raw HTML · object"},{"type":"object","title":"Links","required":["type"],"properties":{"type":{"type":"string","enum":["links"],"isRequired":true,"uniqueKey":"options.formats.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"options.formats.items.[INDEX].oneOf.4","typeLabel":"Links · object"},{"type":"object","title":"Images","required":["type"],"properties":{"type":{"type":"string","enum":["images"],"isRequired":true,"uniqueKey":"options.formats.items.[INDEX].oneOf.5.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"options.formats.items.[INDEX].oneOf.5","typeLabel":"Images · object"},{"type":"object","title":"JSON","required":["type"],"properties":{"type":{"type":"string","enum":["json"],"isRequired":true,"uniqueKey":"options.formats.items.[INDEX].oneOf.6.type","typeLabel":"enum\u003cstring>"},"schema":{"type":"object","description":"The schema to use for the JSON output. Must conform to [JSON Schema](https://json-schema.org/).","uniqueKey":"options.formats.items.[INDEX].oneOf.6.schema","typeLabel":"object"},"prompt":{"type":"string","description":"The prompt to use for the JSON output","uniqueKey":"options.formats.items.[INDEX].oneOf.6.prompt","typeLabel":"string"}},"uniqueKey":"options.formats.items.[INDEX].oneOf.6","typeLabel":"JSON · object"}],"uniqueKey":"options.formats.items.[INDEX]","typeLabel":"Markdown · object | Summary · object | HTML · object | Raw HTML · object | Links · object | Images · object | JSON · object"},"description":"Output formats supported for `/parse` uploads. Browser-rendering formats and change tracking are not supported.","default":[{"type":"markdown"}],"uniqueKey":"options.formats","typeLabel":"(Markdown · object | Summary · object | HTML · object | Raw HTML · object | Links · object | Images · object | JSON · object)[]"},"onlyMainContent":{"type":"boolean","description":"Only return the main content of the page excluding headers, navs, footers, etc.","default":true,"uniqueKey":"options.onlyMainContent","typeLabel":"boolean"},"includeTags":{"type":"array","items":{"type":"string","uniqueKey":"options.includeTags.items.[INDEX]","typeLabel":"string"},"description":"Tags to include in the output.","uniqueKey":"options.includeTags","typeLabel":"string[]"},"excludeTags":{"type":"array","items":{"type":"string","uniqueKey":"options.excludeTags.items.[INDEX]","typeLabel":"string"},"description":"Tags to exclude from the output.","uniqueKey":"options.excludeTags","typeLabel":"string[]"},"headers":{"type":"object","description":"Headers to send when additional network requests are required.","uniqueKey":"options.headers","typeLabel":"object"},"timeout":{"type":"integer","description":"Timeout in milliseconds for the request. Default is 30000 (30 seconds). Maximum is 300000 (300 seconds).","default":30000,"maximum":300000,"uniqueKey":"options.timeout","typeLabel":"integer"},"parsers":{"type":"array","description":"Controls file parser behavior when relevant (for example PDF parser mode).","items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["pdf"],"isRequired":true,"uniqueKey":"options.parsers.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"mode":{"type":"string","enum":["fast","auto","ocr"],"default":"auto","description":"PDF parsing mode. \"fast\": text-only extraction. \"auto\": text-first with OCR fallback. \"ocr\": OCR on every page.","uniqueKey":"options.parsers.items.[INDEX].mode","typeLabel":"enum\u003cstring>"},"maxPages":{"type":"integer","minimum":1,"maximum":10000,"description":"Maximum number of pages to parse from the PDF.","uniqueKey":"options.parsers.items.[INDEX].maxPages","typeLabel":"integer"},"pages":{"type":"boolean","default":false,"description":"Include physical per-page markdown alongside the document markdown. Populates the `pages` field on the document as an array of { pageNumber, markdown }. No additional cost.","uniqueKey":"options.parsers.items.[INDEX].pages","typeLabel":"boolean"},"blocks":{"type":"boolean","default":false,"description":"Include per-page typed layout blocks alongside the document markdown. Populates the `blocks` field on the document: typed blocks (title, section_header, text, table, formula, figure, caption, ...) with normalized bounding boxes, reading order, character-span links into the markdown, and per-block confidence. No additional cost.","uniqueKey":"options.parsers.items.[INDEX].blocks","typeLabel":"boolean"},"pageMarkers":{"type":"boolean","default":false,"description":"Annotate page breaks in the document markdown: pages are joined with `\\n\\n---\\n\\n\u003c!-- page N -->\\n\\n`, where N is the 1-based physical page of the content that follows. Markers appear between pages only (no leading marker for page 1), and numbering may skip pages merged across a page break — use `pages: true` when every physical page is needed. No new response field; no additional cost.","uniqueKey":"options.parsers.items.[INDEX].pageMarkers","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"options.parsers.items.[INDEX]","typeLabel":"object"},"default":[{"type":"pdf"}],"uniqueKey":"options.parsers","typeLabel":"object[]"},"skipTlsVerification":{"type":"boolean","description":"Skip TLS certificate verification when making requests.","default":true,"uniqueKey":"options.skipTlsVerification","typeLabel":"boolean"},"removeBase64Images":{"type":"boolean","description":"Remove base64-encoded images from output and keep alt text placeholders.","default":true,"uniqueKey":"options.removeBase64Images","typeLabel":"boolean"},"blockAds":{"type":"boolean","description":"Enable ad and cookie popup blocking.","default":true,"uniqueKey":"options.blockAds","typeLabel":"boolean"},"checkPromptInjection":{"type":"boolean","description":"When enabled, scans the parsed content for prompt injection attempts before any LLM-backed format (such as json, summary or question) runs. If an injection is detected, the request fails with a 403 and error code SCRAPE_PROMPT_INJECTION_DETECTED. Adds 4 credits when the check runs. If the check cannot scan all of the content, the parse continues with a warning and the check is not billed.","default":false,"uniqueKey":"options.checkPromptInjection","typeLabel":"boolean"},"redactPII":{"oneOf":[{"type":"boolean","description":"Redact personally identifiable information from returned markdown. Pass `true` to use defaults, or an object to tune mode, entities, and replacement style.","default":false,"uniqueKey":"options.redactPII.oneOf.0","typeLabel":"boolean"},{"type":"object","description":"Redact personally identifiable information from returned markdown. Pass `true` to use defaults, or an object to tune mode, entities, and replacement style.","default":false,"properties":{"mode":{"type":"string","enum":["accurate","aggressive","fast"],"default":"accurate","description":"Redaction strategy. `accurate` is model-only and optimized for precision, `aggressive` increases recall with additional heuristics, and `fast` uses heuristics without the model call.","uniqueKey":"options.redactPII.oneOf.1.mode","typeLabel":"enum\u003cstring>"},"entities":{"type":"array","description":"Restrict redaction to these entity buckets. If omitted, all supported entities are redacted.","items":{"type":"string","enum":["PERSON","EMAIL","PHONE","LOCATION","FINANCIAL","SECRET"],"description":"Public PII entity buckets supported by Firecrawl redaction.","uniqueKey":"options.redactPII.oneOf.1.entities.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"options.redactPII.oneOf.1.entities","typeLabel":"enum\u003cstring>[]"},"replaceStyle":{"type":"string","enum":["tag","mask","remove"],"default":"tag","description":"`tag` replaces spans with placeholders like `\u003cEMAIL>`, `mask` replaces characters with `*`, and `remove` deletes the span text.","uniqueKey":"options.redactPII.oneOf.1.replaceStyle","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"options.redactPII.oneOf.1","typeLabel":"object"}],"uniqueKey":"options.redactPII","typeLabel":"boolean | object"},"proxy":{"type":"string","enum":["basic","auto"],"description":"Proxy mode for parse uploads. `/parse` supports only `basic` and `auto`.","uniqueKey":"options.proxy","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","description":"Origin identifier for analytics and logging.","default":"api","uniqueKey":"options.origin","typeLabel":"string"},"integration":{"oneOf":[{"type":"string","description":"Optional integration identifier. When omitted, a valid `X-Integration` request header is used instead; the body value takes precedence.","uniqueKey":"options.integration.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional integration identifier. When omitted, a valid `X-Integration` request header is used instead; the body value takes precedence.","uniqueKey":"options.integration.oneOf.1","typeLabel":"null"}],"uniqueKey":"options.integration","typeLabel":"string | null"},"auditMetadata":{"type":"object","description":"User attribution included with SIEM logging events when SIEM Logging is enabled for the organization.","additionalProperties":false,"required":["username"],"properties":{"username":{"type":"string","maxLength":1024,"description":"The username associated with the request.","isRequired":true,"uniqueKey":"options.auditMetadata.username","typeLabel":"string"}},"uniqueKey":"options.auditMetadata","typeLabel":"object"},"zeroDataRetention":{"type":"boolean","default":false,"description":"If true, this will enable zero data retention for this parse. To enable this feature, please contact help@firecrawl.dev","uniqueKey":"options.zeroDataRetention","typeLabel":"boolean"}},"uniqueKey":"options","typeLabel":"object"}},"required":["file"],"uniqueKey":"","typeLabel":"object"},"encoding":{"options":{"contentType":"application/json"}},"examples":{"Example":{"title":"Example","value":{"file":"\u003cstring>","options":{"formats":[{"type":"markdown"}],"onlyMainContent":true,"includeTags":["\u003cstring>"],"excludeTags":["\u003cstring>"],"headers":{},"timeout":30000,"parsers":[{"type":"pdf"}],"skipTlsVerification":true,"removeBase64Images":true,"blockAds":true,"checkPromptInjection":false,"redactPII":false,"origin":"api","integration":"\u003cstring>","zeroDataRetention":false}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"efc949e2-459c-4d72-a4d2-171a76b30abe":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","properties":{"markdown":{"type":"string","uniqueKey":"data.markdown","typeLabel":"string"},"pages":{"oneOf":[{"type":"array","description":"Physical per-page markdown for PDFs. Present only when the request set the `pages` PDF parser option.","items":{"type":"object","properties":{"pageNumber":{"type":"integer","description":"1-based physical PDF page number.","uniqueKey":"data.pages.oneOf.0.items.[INDEX].pageNumber","typeLabel":"integer"},"markdown":{"type":"string","uniqueKey":"data.pages.oneOf.0.items.[INDEX].markdown","typeLabel":"string"}},"uniqueKey":"data.pages.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.pages.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Physical per-page markdown for PDFs. Present only when the request set the `pages` PDF parser option.","items":{"type":"object","properties":{"pageNumber":{"type":"integer","description":"1-based physical PDF page number."},"markdown":{"type":"string"}}},"uniqueKey":"data.pages.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.pages","typeLabel":"object[] | null"},"blocks":{"oneOf":[{"type":"array","description":"Per-page typed layout blocks for PDFs. Present only when the request set the `blocks` PDF parser option.","items":{"type":"object","properties":{"pageNumber":{"type":"integer","description":"1-based physical PDF page number.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].pageNumber","typeLabel":"integer"},"width":{"oneOf":[{"type":"number","description":"Page render width in px — the anchor for denormalizing bbox coordinates. Null for pages that never rendered.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].width.oneOf.0","typeLabel":"number"},{"type":"null","description":"Page render width in px — the anchor for denormalizing bbox coordinates. Null for pages that never rendered.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].width.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.blocks.oneOf.0.items.[INDEX].width","typeLabel":"number | null"},"height":{"oneOf":[{"type":"number","description":"Page render height in px. Null for pages that never rendered.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].height.oneOf.0","typeLabel":"number"},{"type":"null","description":"Page render height in px. Null for pages that never rendered.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].height.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.blocks.oneOf.0.items.[INDEX].height","typeLabel":"number | null"},"status":{"type":"string","description":"Page-level rollup: ok | partial | failed.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].status","typeLabel":"string"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable within a response: p\u003cpage>.b\u003cindex in reading order>.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"Block type: title, section_header, text, table, formula, figure, caption, page_number, page_header, page_footer. New types may appear over time.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].type","typeLabel":"string"},"label":{"oneOf":[{"type":"string","description":"Raw layout-model label, passthrough for forward compatibility.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].label.oneOf.0","typeLabel":"string"},{"type":"null","description":"Raw layout-model label, passthrough for forward compatibility.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].label.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].label","typeLabel":"string | null"},"bbox":{"oneOf":[{"type":"array","minItems":4,"maxItems":4,"items":{"type":"number","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].bbox.oneOf.0.items.[INDEX]","typeLabel":"number"},"description":"[x0, y0, x1, y1] normalized 0-1 relative to the page width/height. Multiply by the page width/height to get pixel coordinates. Null when the page has no known dimensions.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].bbox.oneOf.0","typeLabel":"number[]"},{"type":"null","minItems":4,"maxItems":4,"items":{"type":"number"},"description":"[x0, y0, x1, y1] normalized 0-1 relative to the page width/height. Multiply by the page width/height to get pixel coordinates. Null when the page has no known dimensions.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].bbox.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].bbox","typeLabel":"number[] | null"},"content":{"type":"string","description":"Markdown fragment this block contributed to the document markdown.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].content","typeLabel":"string"},"markdownSpan":{"oneOf":[{"type":"array","minItems":2,"maxItems":2,"items":{"type":"integer","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].markdownSpan.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"[start, end) character offsets into the document markdown covering this block's fragment. Null when a post-processing transform rewrote the fragment.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].markdownSpan.oneOf.0","typeLabel":"integer[]"},{"type":"null","minItems":2,"maxItems":2,"items":{"type":"integer"},"description":"[start, end) character offsets into the document markdown covering this block's fragment. Null when a post-processing transform rewrote the fragment.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].markdownSpan.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].markdownSpan","typeLabel":"integer[] | null"},"readingOrder":{"type":"integer","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].readingOrder","typeLabel":"integer"},"source":{"oneOf":[{"type":"string","description":"Pipeline path that produced the block (for example native_text, layout_ocr, tsr, formula_model, full_page).","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].source.oneOf.0","typeLabel":"string"},{"type":"null","description":"Pipeline path that produced the block (for example native_text, layout_ocr, tsr, formula_model, full_page).","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].source","typeLabel":"string | null"},"confidence":{"type":"object","properties":{"layout":{"oneOf":[{"type":"number","description":"Layout-model detection score (0-1). Null when the page bypassed layout analysis.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].confidence.layout.oneOf.0","typeLabel":"number"},{"type":"null","description":"Layout-model detection score (0-1). Null when the page bypassed layout analysis.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].confidence.layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].confidence.layout","typeLabel":"number | null"},"ocr":{"oneOf":[{"type":"number","description":"Text confidence when the source path provides one; null otherwise.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].confidence.ocr.oneOf.0","typeLabel":"number"},{"type":"null","description":"Text confidence when the source path provides one; null otherwise.","uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].confidence.ocr.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].confidence.ocr","typeLabel":"number | null"}},"uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX].confidence","typeLabel":"object"}},"uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.blocks.oneOf.0.items.[INDEX].\\items","typeLabel":"object[]"}},"uniqueKey":"data.blocks.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.blocks.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Per-page typed layout blocks for PDFs. Present only when the request set the `blocks` PDF parser option.","items":{"type":"object","properties":{"pageNumber":{"type":"integer","description":"1-based physical PDF page number."},"width":{"oneOf":[{"type":"number","description":"Page render width in px — the anchor for denormalizing bbox coordinates. Null for pages that never rendered."},{"type":"null","description":"Page render width in px — the anchor for denormalizing bbox coordinates. Null for pages that never rendered."}]},"height":{"oneOf":[{"type":"number","description":"Page render height in px. Null for pages that never rendered."},{"type":"null","description":"Page render height in px. Null for pages that never rendered."}]},"status":{"type":"string","description":"Page-level rollup: ok | partial | failed."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable within a response: p\u003cpage>.b\u003cindex in reading order>."},"type":{"type":"string","description":"Block type: title, section_header, text, table, formula, figure, caption, page_number, page_header, page_footer. New types may appear over time."},"label":{"oneOf":[{"type":"string","description":"Raw layout-model label, passthrough for forward compatibility."},{"type":"null","description":"Raw layout-model label, passthrough for forward compatibility."}]},"bbox":{"oneOf":[{"type":"array","minItems":4,"maxItems":4,"items":{"type":"number"},"description":"[x0, y0, x1, y1] normalized 0-1 relative to the page width/height. Multiply by the page width/height to get pixel coordinates. Null when the page has no known dimensions."},{"type":"null","minItems":4,"maxItems":4,"items":{"type":"number"},"description":"[x0, y0, x1, y1] normalized 0-1 relative to the page width/height. Multiply by the page width/height to get pixel coordinates. Null when the page has no known dimensions."}]},"content":{"type":"string","description":"Markdown fragment this block contributed to the document markdown."},"markdownSpan":{"oneOf":[{"type":"array","minItems":2,"maxItems":2,"items":{"type":"integer"},"description":"[start, end) character offsets into the document markdown covering this block's fragment. Null when a post-processing transform rewrote the fragment."},{"type":"null","minItems":2,"maxItems":2,"items":{"type":"integer"},"description":"[start, end) character offsets into the document markdown covering this block's fragment. Null when a post-processing transform rewrote the fragment."}]},"readingOrder":{"type":"integer"},"source":{"oneOf":[{"type":"string","description":"Pipeline path that produced the block (for example native_text, layout_ocr, tsr, formula_model, full_page)."},{"type":"null","description":"Pipeline path that produced the block (for example native_text, layout_ocr, tsr, formula_model, full_page)."}]},"confidence":{"type":"object","properties":{"layout":{"oneOf":[{"type":"number","description":"Layout-model detection score (0-1). Null when the page bypassed layout analysis."},{"type":"null","description":"Layout-model detection score (0-1). Null when the page bypassed layout analysis."}]},"ocr":{"oneOf":[{"type":"number","description":"Text confidence when the source path provides one; null otherwise."},{"type":"null","description":"Text confidence when the source path provides one; null otherwise."}]}}}}}}}},"uniqueKey":"data.blocks.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.blocks","typeLabel":"object[] | null"},"summary":{"oneOf":[{"type":"string","description":"Summary of the page if `summary` is in `formats`","uniqueKey":"data.summary.oneOf.0","typeLabel":"string"},{"type":"null","description":"Summary of the page if `summary` is in `formats`","uniqueKey":"data.summary.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.summary","typeLabel":"string | null"},"html":{"oneOf":[{"type":"string","description":"Cleaned HTML of the page if `html` is in `formats`. Removes `\u003cscript>`, `\u003cstyle>`, `\u003cnoscript>`, `\u003cmeta>`, and `\u003chead>` tags; converts relative URLs to absolute; resolves responsive image `srcset` to the largest version. Respects `onlyMainContent`, `includeTags`, and `excludeTags` filters.","uniqueKey":"data.html.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cleaned HTML of the page if `html` is in `formats`. Removes `\u003cscript>`, `\u003cstyle>`, `\u003cnoscript>`, `\u003cmeta>`, and `\u003chead>` tags; converts relative URLs to absolute; resolves responsive image `srcset` to the largest version. Respects `onlyMainContent`, `includeTags`, and `excludeTags` filters.","uniqueKey":"data.html.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.html","typeLabel":"string | null"},"rawHtml":{"oneOf":[{"type":"string","description":"The exact, unmodified HTML as received from the page if `rawHtml` is in `formats`. No cleaning or filtering is applied.","uniqueKey":"data.rawHtml.oneOf.0","typeLabel":"string"},{"type":"null","description":"The exact, unmodified HTML as received from the page if `rawHtml` is in `formats`. No cleaning or filtering is applied.","uniqueKey":"data.rawHtml.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.rawHtml","typeLabel":"string | null"},"rawBase64":{"oneOf":[{"type":"string","description":"The Base64-encoded original HTTP response body if `rawBase64` is in `formats`. A bare Base64 string, not a data URI. The MIME type is in `metadata.contentType`.","uniqueKey":"data.rawBase64.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Base64-encoded original HTTP response body if `rawBase64` is in `formats`. A bare Base64 string, not a data URI. The MIME type is in `metadata.contentType`.","uniqueKey":"data.rawBase64.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.rawBase64","typeLabel":"string | null"},"screenshot":{"oneOf":[{"type":"string","description":"Screenshot of the page if `screenshot` is in `formats`. Screenshots expire after 24 hours and can no longer be downloaded.","uniqueKey":"data.screenshot.oneOf.0","typeLabel":"string"},{"type":"null","description":"Screenshot of the page if `screenshot` is in `formats`. Screenshots expire after 24 hours and can no longer be downloaded.","uniqueKey":"data.screenshot.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.screenshot","typeLabel":"string | null"},"audio":{"oneOf":[{"type":"string","description":"Signed URL to the extracted MP3 audio file if `audio` is in `formats`. The signed URL expires after 1 hour.","uniqueKey":"data.audio.oneOf.0","typeLabel":"string"},{"type":"null","description":"Signed URL to the extracted MP3 audio file if `audio` is in `formats`. The signed URL expires after 1 hour.","uniqueKey":"data.audio.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.audio","typeLabel":"string | null"},"video":{"oneOf":[{"type":"string","description":"Signed URL to the extracted video file if `video` is in `formats`. The signed URL expires after 1 hour.","uniqueKey":"data.video.oneOf.0","typeLabel":"string"},{"type":"null","description":"Signed URL to the extracted video file if `video` is in `formats`. The signed URL expires after 1 hour.","uniqueKey":"data.video.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.video","typeLabel":"string | null"},"answer":{"oneOf":[{"type":"string","description":"Natural-language answer to the question supplied via the `question` format. Only present if a `question` format object was included in `formats`.","uniqueKey":"data.answer.oneOf.0","typeLabel":"string"},{"type":"null","description":"Natural-language answer to the question supplied via the `question` format. Only present if a `question` format object was included in `formats`.","uniqueKey":"data.answer.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.answer","typeLabel":"string | null"},"highlights":{"oneOf":[{"type":"string","description":"Relevant source text selected by the `highlights` format. Only present if a `highlights` format object was included in `formats`.","uniqueKey":"data.highlights.oneOf.0","typeLabel":"string"},{"type":"null","description":"Relevant source text selected by the `highlights` format. Only present if a `highlights` format object was included in `formats`.","uniqueKey":"data.highlights.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.highlights","typeLabel":"string | null"},"links":{"type":"array","items":{"type":"string","uniqueKey":"data.links.items.[INDEX]","typeLabel":"string"},"description":"List of links on the page if `links` is in `formats`","uniqueKey":"data.links","typeLabel":"string[]"},"attributes":{"type":"array","description":"Attribute values extracted by the `attributes` format. Only present if an `attributes` format object was included in `formats`.","items":{"type":"object","properties":{"selector":{"type":"string","uniqueKey":"data.attributes.items.[INDEX].selector","typeLabel":"string"},"attribute":{"type":"string","uniqueKey":"data.attributes.items.[INDEX].attribute","typeLabel":"string"},"values":{"type":"array","items":{"type":"string","uniqueKey":"data.attributes.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.attributes.items.[INDEX].values","typeLabel":"string[]"}},"uniqueKey":"data.attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.attributes","typeLabel":"object[]"},"actions":{"oneOf":[{"type":"object","description":"Results of the actions specified in the `actions` parameter. Only present if the `actions` parameter was provided in the request","properties":{"screenshots":{"type":"array","description":"Screenshot URLs, in the same order as the screenshot actions provided.","items":{"type":"string","format":"url","uniqueKey":"data.actions.oneOf.0.screenshots.items.[INDEX]","typeLabel":"string\u003curl>"},"uniqueKey":"data.actions.oneOf.0.screenshots","typeLabel":"string\u003curl>[]"},"scrapes":{"type":"array","description":"Scrape contents, in the same order as the scrape actions provided.","items":{"type":"object","properties":{"url":{"type":"string","uniqueKey":"data.actions.oneOf.0.scrapes.items.[INDEX].url","typeLabel":"string"},"html":{"type":"string","uniqueKey":"data.actions.oneOf.0.scrapes.items.[INDEX].html","typeLabel":"string"}},"uniqueKey":"data.actions.oneOf.0.scrapes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.actions.oneOf.0.scrapes","typeLabel":"object[]"},"javascriptReturns":{"type":"array","description":"JavaScript return values, in the same order as the executeJavascript actions provided.","items":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"data.actions.oneOf.0.javascriptReturns.items.[INDEX].type","typeLabel":"string"},"value":{"oneOf":[{}],"uniqueKey":"data.actions.oneOf.0.javascriptReturns.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"data.actions.oneOf.0.javascriptReturns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.actions.oneOf.0.javascriptReturns","typeLabel":"object[]"},"pdfs":{"type":"array","description":"PDFs generated, in the same order as the pdf actions provided.","items":{"type":"string","uniqueKey":"data.actions.oneOf.0.pdfs.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.actions.oneOf.0.pdfs","typeLabel":"string[]"}},"uniqueKey":"data.actions.oneOf.0","typeLabel":"object"},{"type":"null","description":"Results of the actions specified in the `actions` parameter. Only present if the `actions` parameter was provided in the request","properties":{"screenshots":{"type":"array","description":"Screenshot URLs, in the same order as the screenshot actions provided.","items":{"type":"string","format":"url"}},"scrapes":{"type":"array","description":"Scrape contents, in the same order as the scrape actions provided.","items":{"type":"object","properties":{"url":{"type":"string"},"html":{"type":"string"}}}},"javascriptReturns":{"type":"array","description":"JavaScript return values, in the same order as the executeJavascript actions provided.","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"oneOf":[{}]}}}},"pdfs":{"type":"array","description":"PDFs generated, in the same order as the pdf actions provided.","items":{"type":"string"}}},"uniqueKey":"data.actions.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.actions","typeLabel":"object | null"},"metadata":{"type":"object","properties":{"title":{"oneOf":[{"type":"string","description":"Title extracted from the page, can be a string or array of strings","uniqueKey":"data.metadata.title.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"data.metadata.title.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Title extracted from the page, can be a string or array of strings","uniqueKey":"data.metadata.title.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"data.metadata.title","typeLabel":"string | string[]"},"description":{"oneOf":[{"type":"string","description":"Description extracted from the page, can be a string or array of strings","uniqueKey":"data.metadata.description.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"data.metadata.description.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Description extracted from the page, can be a string or array of strings","uniqueKey":"data.metadata.description.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"data.metadata.description","typeLabel":"string | string[]"},"language":{"oneOf":[{"type":"string","description":"Language extracted from the page, can be a string or array of strings","uniqueKey":"data.metadata.language.oneOf.0","typeLabel":"string"},{"type":"null","description":"Language extracted from the page, can be a string or array of strings","uniqueKey":"data.metadata.language.oneOf.1","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"data.metadata.language.oneOf.2.items.[INDEX]","typeLabel":"string"},"description":"Language extracted from the page, can be a string or array of strings","uniqueKey":"data.metadata.language.oneOf.2","typeLabel":"string[]"},{"type":"null","description":"Language extracted from the page, can be a string or array of strings","uniqueKey":"data.metadata.language.oneOf.3","typeLabel":"null"}],"uniqueKey":"data.metadata.language","typeLabel":"string · null · string[] · null"},"sourceURL":{"type":"string","format":"uri","description":"The original URL that was requested. May differ from the page's final URL if redirects occurred.","uniqueKey":"data.metadata.sourceURL","typeLabel":"string\u003curi>"},"url":{"type":"string","format":"uri","description":"The final URL of the page after all redirects have been followed.","uniqueKey":"data.metadata.url","typeLabel":"string\u003curi>"},"keywords":{"oneOf":[{"type":"string","description":"Keywords extracted from the page, can be a string or array of strings","uniqueKey":"data.metadata.keywords.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"data.metadata.keywords.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Keywords extracted from the page, can be a string or array of strings","uniqueKey":"data.metadata.keywords.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"data.metadata.keywords","typeLabel":"string | string[]"},"ogLocaleAlternate":{"type":"array","items":{"type":"string","uniqueKey":"data.metadata.ogLocaleAlternate.items.[INDEX]","typeLabel":"string"},"description":"Alternative locales for the page","uniqueKey":"data.metadata.ogLocaleAlternate","typeLabel":"string[]"},"\u003cany other metadata> ":{"oneOf":[{"type":"string","description":"Other metadata extracted from HTML, can be a string or array of strings","uniqueKey":"data.metadata.\u003cany other metadata> .oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"data.metadata.\u003cany other metadata> .oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Other metadata extracted from HTML, can be a string or array of strings","uniqueKey":"data.metadata.\u003cany other metadata> .oneOf.1","typeLabel":"string[]"}],"uniqueKey":"data.metadata.\u003cany other metadata> ","typeLabel":"string | string[]"},"statusCode":{"type":"integer","description":"The status code of the page","uniqueKey":"data.metadata.statusCode","typeLabel":"integer"},"numPages":{"type":"integer","description":"For PDF inputs, the number of pages parsed (capped by the parsers maxPages option).","uniqueKey":"data.metadata.numPages","typeLabel":"integer"},"totalPages":{"type":"integer","description":"For PDF inputs, the document's true page count before any maxPages capping. Omitted when it cannot be determined; a totalPages greater than numPages indicates the result was truncated.","uniqueKey":"data.metadata.totalPages","typeLabel":"integer"},"contentType":{"type":"string","description":"The content type (MIME type) of the page, e.g. text/html, application/pdf","uniqueKey":"data.metadata.contentType","typeLabel":"string"},"error":{"oneOf":[{"type":"string","description":"The error message of the page","uniqueKey":"data.metadata.error.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error message of the page","uniqueKey":"data.metadata.error.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.metadata.error","typeLabel":"string | null"},"concurrencyLimited":{"type":"boolean","description":"Whether this scrape was throttled due to team concurrency limits","uniqueKey":"data.metadata.concurrencyLimited","typeLabel":"boolean"},"concurrencyQueueDurationMs":{"type":"number","description":"Time in milliseconds the request waited in the concurrency queue. Only present when concurrencyLimited is true.","uniqueKey":"data.metadata.concurrencyQueueDurationMs","typeLabel":"number"},"provider":{"type":"object","description":"Set when a third-party data provider served the URL.","properties":{"id":{"type":"string","description":"The provider that returned the data.","uniqueKey":"data.metadata.provider.id","typeLabel":"string"},"creditsCost":{"type":"integer","description":"What that access cost, in credits.","uniqueKey":"data.metadata.provider.creditsCost","typeLabel":"integer"},"steps":{"type":"array","description":"Each provider tried, in order.","items":{"type":"object","properties":{"provider":{"type":"string","uniqueKey":"data.metadata.provider.steps.items.[INDEX].provider","typeLabel":"string"},"status":{"type":"string","enum":["matched","not_found","error"],"uniqueKey":"data.metadata.provider.steps.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"creditsCost":{"type":"integer","uniqueKey":"data.metadata.provider.steps.items.[INDEX].creditsCost","typeLabel":"integer"}},"uniqueKey":"data.metadata.provider.steps.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.metadata.provider.steps","typeLabel":"object[]"}},"uniqueKey":"data.metadata.provider","typeLabel":"object"}},"uniqueKey":"data.metadata","typeLabel":"object"},"warning":{"oneOf":[{"type":"string","description":"Can be displayed when using LLM Extraction. Warning message will let you know any issues with the extraction.","uniqueKey":"data.warning.oneOf.0","typeLabel":"string"},{"type":"null","description":"Can be displayed when using LLM Extraction. Warning message will let you know any issues with the extraction.","uniqueKey":"data.warning.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.warning","typeLabel":"string | null"},"changeTracking":{"oneOf":[{"type":"object","description":"Change tracking information if `changeTracking` is in `formats`. Only present when the `changeTracking` format is requested.","properties":{"previousScrapeAt":{"oneOf":[{"type":"string","format":"date-time","description":"The timestamp of the previous scrape that the current page is being compared against. Null if no previous scrape exists.","uniqueKey":"data.changeTracking.oneOf.0.previousScrapeAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The timestamp of the previous scrape that the current page is being compared against. Null if no previous scrape exists.","uniqueKey":"data.changeTracking.oneOf.0.previousScrapeAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.changeTracking.oneOf.0.previousScrapeAt","typeLabel":"string\u003cdate-time> | null"},"changeStatus":{"type":"string","enum":["new","same","changed","removed"],"description":"The result of the comparison between the two page versions. 'new' means this page did not exist before, 'same' means content has not changed, 'changed' means content has changed, 'removed' means the page was removed.","uniqueKey":"data.changeTracking.oneOf.0.changeStatus","typeLabel":"enum\u003cstring>"},"visibility":{"type":"string","enum":["visible","hidden"],"description":"The visibility of the current page/URL. 'visible' means the URL was discovered through an organic route (links or sitemap), 'hidden' means the URL was discovered through memory from previous crawls.","uniqueKey":"data.changeTracking.oneOf.0.visibility","typeLabel":"enum\u003cstring>"},"diff":{"oneOf":[{"type":"string","description":"Git-style diff of changes when using 'git-diff' mode. Only present when the mode is set to 'git-diff'.","uniqueKey":"data.changeTracking.oneOf.0.diff.oneOf.0","typeLabel":"string"},{"type":"null","description":"Git-style diff of changes when using 'git-diff' mode. Only present when the mode is set to 'git-diff'.","uniqueKey":"data.changeTracking.oneOf.0.diff.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.changeTracking.oneOf.0.diff","typeLabel":"string | null"},"json":{"oneOf":[{"type":"object","description":"JSON comparison results when using 'json' mode. Only present when the mode is set to 'json'. This will emit a list of all the keys and their values from the `previous` and `current` scrapes based on the type defined in the `schema`. Example [here](/features/change-tracking)","uniqueKey":"data.changeTracking.oneOf.0.json.oneOf.0","typeLabel":"object"},{"type":"null","description":"JSON comparison results when using 'json' mode. Only present when the mode is set to 'json'. This will emit a list of all the keys and their values from the `previous` and `current` scrapes based on the type defined in the `schema`. Example [here](/features/change-tracking)","uniqueKey":"data.changeTracking.oneOf.0.json.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.changeTracking.oneOf.0.json","typeLabel":"object | null"}},"uniqueKey":"data.changeTracking.oneOf.0","typeLabel":"object"},{"type":"null","description":"Change tracking information if `changeTracking` is in `formats`. Only present when the `changeTracking` format is requested.","properties":{"previousScrapeAt":{"oneOf":[{"type":"string","format":"date-time","description":"The timestamp of the previous scrape that the current page is being compared against. Null if no previous scrape exists."},{"type":"null","format":"date-time","description":"The timestamp of the previous scrape that the current page is being compared against. Null if no previous scrape exists."}]},"changeStatus":{"type":"string","enum":["new","same","changed","removed"],"description":"The result of the comparison between the two page versions. 'new' means this page did not exist before, 'same' means content has not changed, 'changed' means content has changed, 'removed' means the page was removed."},"visibility":{"type":"string","enum":["visible","hidden"],"description":"The visibility of the current page/URL. 'visible' means the URL was discovered through an organic route (links or sitemap), 'hidden' means the URL was discovered through memory from previous crawls."},"diff":{"oneOf":[{"type":"string","description":"Git-style diff of changes when using 'git-diff' mode. Only present when the mode is set to 'git-diff'."},{"type":"null","description":"Git-style diff of changes when using 'git-diff' mode. Only present when the mode is set to 'git-diff'."}]},"json":{"oneOf":[{"type":"object","description":"JSON comparison results when using 'json' mode. Only present when the mode is set to 'json'. This will emit a list of all the keys and their values from the `previous` and `current` scrapes based on the type defined in the `schema`. Example [here](/features/change-tracking)"},{"type":"null","description":"JSON comparison results when using 'json' mode. Only present when the mode is set to 'json'. This will emit a list of all the keys and their values from the `previous` and `current` scrapes based on the type defined in the `schema`. Example [here](/features/change-tracking)"}]}},"uniqueKey":"data.changeTracking.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.changeTracking","typeLabel":"object | null"},"branding":{"oneOf":[{"type":"object","description":"Branding information extracted from the page if `branding` is in `formats`. Includes colors, fonts, typography, spacing, components, and more.","properties":{"colorScheme":{"type":"string","enum":["light","dark"],"description":"The detected color scheme of the page.","uniqueKey":"data.branding.oneOf.0.colorScheme","typeLabel":"enum\u003cstring>"},"logo":{"oneOf":[{"type":"string","description":"URL of the primary logo.","uniqueKey":"data.branding.oneOf.0.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the primary logo.","uniqueKey":"data.branding.oneOf.0.logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.branding.oneOf.0.logo","typeLabel":"string | null"},"colors":{"oneOf":[{"type":"object","description":"Brand colors extracted from the page.","properties":{"primary":{"type":"string","description":"Primary brand color (hex).","uniqueKey":"data.branding.oneOf.0.colors.oneOf.0.primary","typeLabel":"string"},"secondary":{"type":"string","description":"Secondary brand color (hex).","uniqueKey":"data.branding.oneOf.0.colors.oneOf.0.secondary","typeLabel":"string"},"accent":{"type":"string","description":"Accent color (hex).","uniqueKey":"data.branding.oneOf.0.colors.oneOf.0.accent","typeLabel":"string"},"background":{"type":"string","description":"Background color (hex).","uniqueKey":"data.branding.oneOf.0.colors.oneOf.0.background","typeLabel":"string"},"textPrimary":{"type":"string","description":"Primary text color (hex).","uniqueKey":"data.branding.oneOf.0.colors.oneOf.0.textPrimary","typeLabel":"string"},"textSecondary":{"type":"string","description":"Secondary text color (hex).","uniqueKey":"data.branding.oneOf.0.colors.oneOf.0.textSecondary","typeLabel":"string"},"link":{"type":"string","description":"Link color (hex).","uniqueKey":"data.branding.oneOf.0.colors.oneOf.0.link","typeLabel":"string"},"success":{"type":"string","description":"Success/positive color (hex).","uniqueKey":"data.branding.oneOf.0.colors.oneOf.0.success","typeLabel":"string"},"warning":{"type":"string","description":"Warning color (hex).","uniqueKey":"data.branding.oneOf.0.colors.oneOf.0.warning","typeLabel":"string"},"error":{"type":"string","description":"Error/danger color (hex).","uniqueKey":"data.branding.oneOf.0.colors.oneOf.0.error","typeLabel":"string"}},"uniqueKey":"data.branding.oneOf.0.colors.oneOf.0","typeLabel":"object"},{"type":"null","description":"Brand colors extracted from the page.","properties":{"primary":{"type":"string","description":"Primary brand color (hex)."},"secondary":{"type":"string","description":"Secondary brand color (hex)."},"accent":{"type":"string","description":"Accent color (hex)."},"background":{"type":"string","description":"Background color (hex)."},"textPrimary":{"type":"string","description":"Primary text color (hex)."},"textSecondary":{"type":"string","description":"Secondary text color (hex)."},"link":{"type":"string","description":"Link color (hex)."},"success":{"type":"string","description":"Success/positive color (hex)."},"warning":{"type":"string","description":"Warning color (hex)."},"error":{"type":"string","description":"Error/danger color (hex)."}},"uniqueKey":"data.branding.oneOf.0.colors.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.branding.oneOf.0.colors","typeLabel":"object | null"},"fonts":{"oneOf":[{"type":"array","description":"Array of font families used on the page.","items":{"type":"object","properties":{"family":{"type":"string","description":"Font family name.","uniqueKey":"data.branding.oneOf.0.fonts.oneOf.0.items.[INDEX].family","typeLabel":"string"}},"uniqueKey":"data.branding.oneOf.0.fonts.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.branding.oneOf.0.fonts.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Array of font families used on the page.","items":{"type":"object","properties":{"family":{"type":"string","description":"Font family name."}}},"uniqueKey":"data.branding.oneOf.0.fonts.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.branding.oneOf.0.fonts","typeLabel":"object[] | null"},"typography":{"oneOf":[{"type":"object","description":"Detailed typography information.","properties":{"fontFamilies":{"type":"object","description":"Font families by role.","properties":{"primary":{"type":"string","description":"Primary font family.","uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.fontFamilies.primary","typeLabel":"string"},"heading":{"type":"string","description":"Heading font family.","uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.fontFamilies.heading","typeLabel":"string"},"code":{"type":"string","description":"Code/monospace font family.","uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.fontFamilies.code","typeLabel":"string"}},"uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.fontFamilies","typeLabel":"object"},"fontSizes":{"type":"object","description":"Font sizes for different text levels.","properties":{"h1":{"type":"string","uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.fontSizes.h1","typeLabel":"string"},"h2":{"type":"string","uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.fontSizes.h2","typeLabel":"string"},"h3":{"type":"string","uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.fontSizes.h3","typeLabel":"string"},"body":{"type":"string","uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.fontSizes.body","typeLabel":"string"}},"uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.fontSizes","typeLabel":"object"},"fontWeights":{"type":"object","description":"Font weight definitions.","properties":{"light":{"type":"integer","uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.fontWeights.light","typeLabel":"integer"},"regular":{"type":"integer","uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.fontWeights.regular","typeLabel":"integer"},"medium":{"type":"integer","uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.fontWeights.medium","typeLabel":"integer"},"bold":{"type":"integer","uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.fontWeights.bold","typeLabel":"integer"}},"uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.fontWeights","typeLabel":"object"},"lineHeights":{"type":"object","description":"Line height values for different text types.","properties":{"heading":{"type":"string","uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.lineHeights.heading","typeLabel":"string"},"body":{"type":"string","uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.lineHeights.body","typeLabel":"string"}},"uniqueKey":"data.branding.oneOf.0.typography.oneOf.0.lineHeights","typeLabel":"object"}},"uniqueKey":"data.branding.oneOf.0.typography.oneOf.0","typeLabel":"object"},{"type":"null","description":"Detailed typography information.","properties":{"fontFamilies":{"type":"object","description":"Font families by role.","properties":{"primary":{"type":"string","description":"Primary font family."},"heading":{"type":"string","description":"Heading font family."},"code":{"type":"string","description":"Code/monospace font family."}}},"fontSizes":{"type":"object","description":"Font sizes for different text levels.","properties":{"h1":{"type":"string"},"h2":{"type":"string"},"h3":{"type":"string"},"body":{"type":"string"}}},"fontWeights":{"type":"object","description":"Font weight definitions.","properties":{"light":{"type":"integer"},"regular":{"type":"integer"},"medium":{"type":"integer"},"bold":{"type":"integer"}}},"lineHeights":{"type":"object","description":"Line height values for different text types.","properties":{"heading":{"type":"string"},"body":{"type":"string"}}}},"uniqueKey":"data.branding.oneOf.0.typography.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.branding.oneOf.0.typography","typeLabel":"object | null"},"spacing":{"oneOf":[{"type":"object","description":"Spacing and layout information.","properties":{"baseUnit":{"type":"integer","description":"Base spacing unit in pixels.","uniqueKey":"data.branding.oneOf.0.spacing.oneOf.0.baseUnit","typeLabel":"integer"},"borderRadius":{"type":"string","description":"Default border radius.","uniqueKey":"data.branding.oneOf.0.spacing.oneOf.0.borderRadius","typeLabel":"string"},"padding":{"type":"object","description":"Padding values.","uniqueKey":"data.branding.oneOf.0.spacing.oneOf.0.padding","typeLabel":"object"},"margins":{"type":"object","description":"Margin values.","uniqueKey":"data.branding.oneOf.0.spacing.oneOf.0.margins","typeLabel":"object"}},"uniqueKey":"data.branding.oneOf.0.spacing.oneOf.0","typeLabel":"object"},{"type":"null","description":"Spacing and layout information.","properties":{"baseUnit":{"type":"integer","description":"Base spacing unit in pixels."},"borderRadius":{"type":"string","description":"Default border radius."},"padding":{"type":"object","description":"Padding values."},"margins":{"type":"object","description":"Margin values."}},"uniqueKey":"data.branding.oneOf.0.spacing.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.branding.oneOf.0.spacing","typeLabel":"object | null"},"components":{"oneOf":[{"type":"object","description":"UI component styles.","properties":{"buttonPrimary":{"type":"object","description":"Primary button styles.","properties":{"background":{"type":"string","uniqueKey":"data.branding.oneOf.0.components.oneOf.0.buttonPrimary.background","typeLabel":"string"},"textColor":{"type":"string","uniqueKey":"data.branding.oneOf.0.components.oneOf.0.buttonPrimary.textColor","typeLabel":"string"},"borderRadius":{"type":"string","uniqueKey":"data.branding.oneOf.0.components.oneOf.0.buttonPrimary.borderRadius","typeLabel":"string"}},"uniqueKey":"data.branding.oneOf.0.components.oneOf.0.buttonPrimary","typeLabel":"object"},"buttonSecondary":{"type":"object","description":"Secondary button styles.","properties":{"background":{"type":"string","uniqueKey":"data.branding.oneOf.0.components.oneOf.0.buttonSecondary.background","typeLabel":"string"},"textColor":{"type":"string","uniqueKey":"data.branding.oneOf.0.components.oneOf.0.buttonSecondary.textColor","typeLabel":"string"},"borderColor":{"type":"string","uniqueKey":"data.branding.oneOf.0.components.oneOf.0.buttonSecondary.borderColor","typeLabel":"string"},"borderRadius":{"type":"string","uniqueKey":"data.branding.oneOf.0.components.oneOf.0.buttonSecondary.borderRadius","typeLabel":"string"}},"uniqueKey":"data.branding.oneOf.0.components.oneOf.0.buttonSecondary","typeLabel":"object"},"input":{"type":"object","description":"Input field styles.","uniqueKey":"data.branding.oneOf.0.components.oneOf.0.input","typeLabel":"object"}},"uniqueKey":"data.branding.oneOf.0.components.oneOf.0","typeLabel":"object"},{"type":"null","description":"UI component styles.","properties":{"buttonPrimary":{"type":"object","description":"Primary button styles.","properties":{"background":{"type":"string"},"textColor":{"type":"string"},"borderRadius":{"type":"string"}}},"buttonSecondary":{"type":"object","description":"Secondary button styles.","properties":{"background":{"type":"string"},"textColor":{"type":"string"},"borderColor":{"type":"string"},"borderRadius":{"type":"string"}}},"input":{"type":"object","description":"Input field styles."}},"uniqueKey":"data.branding.oneOf.0.components.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.branding.oneOf.0.components","typeLabel":"object | null"},"icons":{"oneOf":[{"type":"object","description":"Icon style information.","uniqueKey":"data.branding.oneOf.0.icons.oneOf.0","typeLabel":"object"},{"type":"null","description":"Icon style information.","uniqueKey":"data.branding.oneOf.0.icons.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.branding.oneOf.0.icons","typeLabel":"object | null"},"images":{"oneOf":[{"type":"object","description":"Brand images.","properties":{"logo":{"type":"string","description":"Logo image URL.","uniqueKey":"data.branding.oneOf.0.images.oneOf.0.logo","typeLabel":"string"},"favicon":{"type":"string","description":"Favicon URL.","uniqueKey":"data.branding.oneOf.0.images.oneOf.0.favicon","typeLabel":"string"},"ogImage":{"type":"string","description":"Open Graph image URL.","uniqueKey":"data.branding.oneOf.0.images.oneOf.0.ogImage","typeLabel":"string"}},"uniqueKey":"data.branding.oneOf.0.images.oneOf.0","typeLabel":"object"},{"type":"null","description":"Brand images.","properties":{"logo":{"type":"string","description":"Logo image URL."},"favicon":{"type":"string","description":"Favicon URL."},"ogImage":{"type":"string","description":"Open Graph image URL."}},"uniqueKey":"data.branding.oneOf.0.images.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.branding.oneOf.0.images","typeLabel":"object | null"},"animations":{"oneOf":[{"type":"object","description":"Animation and transition settings.","uniqueKey":"data.branding.oneOf.0.animations.oneOf.0","typeLabel":"object"},{"type":"null","description":"Animation and transition settings.","uniqueKey":"data.branding.oneOf.0.animations.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.branding.oneOf.0.animations","typeLabel":"object | null"},"layout":{"oneOf":[{"type":"object","description":"Layout configuration (grid, header/footer heights).","uniqueKey":"data.branding.oneOf.0.layout.oneOf.0","typeLabel":"object"},{"type":"null","description":"Layout configuration (grid, header/footer heights).","uniqueKey":"data.branding.oneOf.0.layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.branding.oneOf.0.layout","typeLabel":"object | null"},"personality":{"oneOf":[{"type":"object","description":"Brand personality traits (tone, energy, target audience).","uniqueKey":"data.branding.oneOf.0.personality.oneOf.0","typeLabel":"object"},{"type":"null","description":"Brand personality traits (tone, energy, target audience).","uniqueKey":"data.branding.oneOf.0.personality.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.branding.oneOf.0.personality","typeLabel":"object | null"}},"uniqueKey":"data.branding.oneOf.0","typeLabel":"object"},{"type":"null","description":"Branding information extracted from the page if `branding` is in `formats`. Includes colors, fonts, typography, spacing, components, and more.","properties":{"colorScheme":{"type":"string","enum":["light","dark"],"description":"The detected color scheme of the page."},"logo":{"oneOf":[{"type":"string","description":"URL of the primary logo."},{"type":"null","description":"URL of the primary logo."}]},"colors":{"oneOf":[{"type":"object","description":"Brand colors extracted from the page.","properties":{"primary":{"type":"string","description":"Primary brand color (hex)."},"secondary":{"type":"string","description":"Secondary brand color (hex)."},"accent":{"type":"string","description":"Accent color (hex)."},"background":{"type":"string","description":"Background color (hex)."},"textPrimary":{"type":"string","description":"Primary text color (hex)."},"textSecondary":{"type":"string","description":"Secondary text color (hex)."},"link":{"type":"string","description":"Link color (hex)."},"success":{"type":"string","description":"Success/positive color (hex)."},"warning":{"type":"string","description":"Warning color (hex)."},"error":{"type":"string","description":"Error/danger color (hex)."}}},{"type":"null","description":"Brand colors extracted from the page.","properties":{"primary":{"type":"string","description":"Primary brand color (hex)."},"secondary":{"type":"string","description":"Secondary brand color (hex)."},"accent":{"type":"string","description":"Accent color (hex)."},"background":{"type":"string","description":"Background color (hex)."},"textPrimary":{"type":"string","description":"Primary text color (hex)."},"textSecondary":{"type":"string","description":"Secondary text color (hex)."},"link":{"type":"string","description":"Link color (hex)."},"success":{"type":"string","description":"Success/positive color (hex)."},"warning":{"type":"string","description":"Warning color (hex)."},"error":{"type":"string","description":"Error/danger color (hex)."}}}]},"fonts":{"oneOf":[{"type":"array","description":"Array of font families used on the page.","items":{"type":"object","properties":{"family":{"type":"string","description":"Font family name."}}}},{"type":"null","description":"Array of font families used on the page.","items":{"type":"object","properties":{"family":{"type":"string","description":"Font family name."}}}}]},"typography":{"oneOf":[{"type":"object","description":"Detailed typography information.","properties":{"fontFamilies":{"type":"object","description":"Font families by role.","properties":{"primary":{"type":"string","description":"Primary font family."},"heading":{"type":"string","description":"Heading font family."},"code":{"type":"string","description":"Code/monospace font family."}}},"fontSizes":{"type":"object","description":"Font sizes for different text levels.","properties":{"h1":{"type":"string"},"h2":{"type":"string"},"h3":{"type":"string"},"body":{"type":"string"}}},"fontWeights":{"type":"object","description":"Font weight definitions.","properties":{"light":{"type":"integer"},"regular":{"type":"integer"},"medium":{"type":"integer"},"bold":{"type":"integer"}}},"lineHeights":{"type":"object","description":"Line height values for different text types.","properties":{"heading":{"type":"string"},"body":{"type":"string"}}}}},{"type":"null","description":"Detailed typography information.","properties":{"fontFamilies":{"type":"object","description":"Font families by role.","properties":{"primary":{"type":"string","description":"Primary font family."},"heading":{"type":"string","description":"Heading font family."},"code":{"type":"string","description":"Code/monospace font family."}}},"fontSizes":{"type":"object","description":"Font sizes for different text levels.","properties":{"h1":{"type":"string"},"h2":{"type":"string"},"h3":{"type":"string"},"body":{"type":"string"}}},"fontWeights":{"type":"object","description":"Font weight definitions.","properties":{"light":{"type":"integer"},"regular":{"type":"integer"},"medium":{"type":"integer"},"bold":{"type":"integer"}}},"lineHeights":{"type":"object","description":"Line height values for different text types.","properties":{"heading":{"type":"string"},"body":{"type":"string"}}}}}]},"spacing":{"oneOf":[{"type":"object","description":"Spacing and layout information.","properties":{"baseUnit":{"type":"integer","description":"Base spacing unit in pixels."},"borderRadius":{"type":"string","description":"Default border radius."},"padding":{"type":"object","description":"Padding values."},"margins":{"type":"object","description":"Margin values."}}},{"type":"null","description":"Spacing and layout information.","properties":{"baseUnit":{"type":"integer","description":"Base spacing unit in pixels."},"borderRadius":{"type":"string","description":"Default border radius."},"padding":{"type":"object","description":"Padding values."},"margins":{"type":"object","description":"Margin values."}}}]},"components":{"oneOf":[{"type":"object","description":"UI component styles.","properties":{"buttonPrimary":{"type":"object","description":"Primary button styles.","properties":{"background":{"type":"string"},"textColor":{"type":"string"},"borderRadius":{"type":"string"}}},"buttonSecondary":{"type":"object","description":"Secondary button styles.","properties":{"background":{"type":"string"},"textColor":{"type":"string"},"borderColor":{"type":"string"},"borderRadius":{"type":"string"}}},"input":{"type":"object","description":"Input field styles."}}},{"type":"null","description":"UI component styles.","properties":{"buttonPrimary":{"type":"object","description":"Primary button styles.","properties":{"background":{"type":"string"},"textColor":{"type":"string"},"borderRadius":{"type":"string"}}},"buttonSecondary":{"type":"object","description":"Secondary button styles.","properties":{"background":{"type":"string"},"textColor":{"type":"string"},"borderColor":{"type":"string"},"borderRadius":{"type":"string"}}},"input":{"type":"object","description":"Input field styles."}}}]},"icons":{"oneOf":[{"type":"object","description":"Icon style information."},{"type":"null","description":"Icon style information."}]},"images":{"oneOf":[{"type":"object","description":"Brand images.","properties":{"logo":{"type":"string","description":"Logo image URL."},"favicon":{"type":"string","description":"Favicon URL."},"ogImage":{"type":"string","description":"Open Graph image URL."}}},{"type":"null","description":"Brand images.","properties":{"logo":{"type":"string","description":"Logo image URL."},"favicon":{"type":"string","description":"Favicon URL."},"ogImage":{"type":"string","description":"Open Graph image URL."}}}]},"animations":{"oneOf":[{"type":"object","description":"Animation and transition settings."},{"type":"null","description":"Animation and transition settings."}]},"layout":{"oneOf":[{"type":"object","description":"Layout configuration (grid, header/footer heights)."},{"type":"null","description":"Layout configuration (grid, header/footer heights)."}]},"personality":{"oneOf":[{"type":"object","description":"Brand personality traits (tone, energy, target audience)."},{"type":"null","description":"Brand personality traits (tone, energy, target audience)."}]}},"uniqueKey":"data.branding.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.branding","typeLabel":"object | null"},"product":{"oneOf":[{"type":"object","description":"Product information extracted from the page if `product` is in `formats`. Includes title, brand, category, description, and variants. Pricing, availability, and images live on each variant.","properties":{"title":{"type":"string","description":"The product title.","isRequired":true,"uniqueKey":"data.product.oneOf.0.title","typeLabel":"string"},"url":{"type":"string","description":"The canonical URL of the product page.","isRequired":true,"uniqueKey":"data.product.oneOf.0.url","typeLabel":"string"},"variants":{"type":"array","description":"Product variants (e.g. different colors or sizes).","items":{"type":"object","properties":{"availability":{"type":"object","description":"The availability of the variant. Always present on a variant.","properties":{"inStock":{"type":"boolean","description":"Whether the variant is in stock.","isRequired":true,"uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].availability.inStock","typeLabel":"boolean"},"text":{"type":"string","description":"Human-readable availability text (e.g. 'In Stock').","uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].availability.text","typeLabel":"string"}},"required":["inStock"],"isRequired":true,"uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].availability","typeLabel":"object"},"id":{"type":"string","description":"The variant identifier.","uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].id","typeLabel":"string"},"sku":{"type":"string","description":"The variant SKU.","uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].sku","typeLabel":"string"},"title":{"type":"string","description":"The variant title.","uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].title","typeLabel":"string"},"values":{"type":"object","description":"The variant option values (e.g. { \"color\": \"Black\" }).","additionalProperties":{"type":"string","uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].values.additionalProperties","typeLabel":"string"},"uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].values","typeLabel":"object"},"price":{"type":"object","description":"The current price of the variant.","properties":{"amount":{"type":"number","description":"The numeric price amount.","isRequired":true,"uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].price.amount","typeLabel":"number"},"currency":{"type":"string","description":"The ISO 4217 currency code (e.g. 'USD').","uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].price.currency","typeLabel":"string"},"formatted":{"type":"string","description":"The price formatted for display (e.g. '$199.99').","uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].price.formatted","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].price","typeLabel":"object"},"sale":{"type":"object","description":"Sale/discount information for the variant, present when the variant is discounted.","properties":{"originalPrice":{"type":"object","description":"The original (pre-discount) price of the variant.","properties":{"amount":{"type":"number","description":"The numeric price amount.","isRequired":true,"uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].sale.originalPrice.amount","typeLabel":"number"},"currency":{"type":"string","description":"The ISO 4217 currency code (e.g. 'USD').","uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].sale.originalPrice.currency","typeLabel":"string"},"formatted":{"type":"string","description":"The price formatted for display (e.g. '$249.99').","uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].sale.originalPrice.formatted","typeLabel":"string"}},"required":["amount"],"isRequired":true,"uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].sale.originalPrice","typeLabel":"object"}},"required":["originalPrice"],"uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].sale","typeLabel":"object"},"images":{"type":"array","description":"Variant images.","items":{"type":"object","properties":{"url":{"type":"string","description":"Image URL.","isRequired":true,"uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].images.items.[INDEX].url","typeLabel":"string"},"alt":{"type":"string","description":"Alternative text for the image.","uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].images.items.[INDEX].alt","typeLabel":"string"}},"required":["url"],"uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].images.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.product.oneOf.0.variants.items.[INDEX].images","typeLabel":"object[]"}},"required":["availability"],"uniqueKey":"data.product.oneOf.0.variants.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.product.oneOf.0.variants","typeLabel":"object[]"},"brand":{"type":"string","description":"The product brand or manufacturer.","uniqueKey":"data.product.oneOf.0.brand","typeLabel":"string"},"category":{"type":"string","description":"The product category, optionally as a breadcrumb path (e.g. 'Electronics > Audio > Headphones').","uniqueKey":"data.product.oneOf.0.category","typeLabel":"string"},"description":{"type":"string","description":"The product description.","uniqueKey":"data.product.oneOf.0.description","typeLabel":"string"}},"required":["title","url","variants"],"uniqueKey":"data.product.oneOf.0","typeLabel":"object"},{"type":"null","description":"Product information extracted from the page if `product` is in `formats`. Includes title, brand, category, description, and variants. Pricing, availability, and images live on each variant.","properties":{"title":{"type":"string","description":"The product title."},"brand":{"type":"string","description":"The product brand or manufacturer."},"category":{"type":"string","description":"The product category, optionally as a breadcrumb path (e.g. 'Electronics > Audio > Headphones')."},"url":{"type":"string","description":"The canonical URL of the product page."},"description":{"type":"string","description":"The product description."},"variants":{"type":"array","description":"Product variants (e.g. different colors or sizes).","items":{"type":"object","properties":{"id":{"type":"string","description":"The variant identifier."},"sku":{"type":"string","description":"The variant SKU."},"title":{"type":"string","description":"The variant title."},"values":{"type":"object","description":"The variant option values (e.g. { \"color\": \"Black\" }).","additionalProperties":{"type":"string"}},"price":{"type":"object","description":"The current price of the variant.","properties":{"amount":{"type":"number","description":"The numeric price amount."},"currency":{"type":"string","description":"The ISO 4217 currency code (e.g. 'USD')."},"formatted":{"type":"string","description":"The price formatted for display (e.g. '$199.99')."}},"required":["amount"]},"sale":{"type":"object","description":"Sale/discount information for the variant, present when the variant is discounted.","properties":{"originalPrice":{"type":"object","description":"The original (pre-discount) price of the variant.","properties":{"amount":{"type":"number","description":"The numeric price amount."},"currency":{"type":"string","description":"The ISO 4217 currency code (e.g. 'USD')."},"formatted":{"type":"string","description":"The price formatted for display (e.g. '$249.99')."}},"required":["amount"]}},"required":["originalPrice"]},"availability":{"type":"object","description":"The availability of the variant. Always present on a variant.","properties":{"inStock":{"type":"boolean","description":"Whether the variant is in stock."},"text":{"type":"string","description":"Human-readable availability text (e.g. 'In Stock')."}},"required":["inStock"]},"images":{"type":"array","description":"Variant images.","items":{"type":"object","properties":{"url":{"type":"string","description":"Image URL."},"alt":{"type":"string","description":"Alternative text for the image."}},"required":["url"]}}},"required":["availability"]}}},"required":["title","url","variants"],"uniqueKey":"data.product.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.product","typeLabel":"object | null"},"menu":{"oneOf":[{"type":"object","description":"Menu information extracted from the page if `menu` is in `formats`. Includes the merchant, currency, and a list of sections, where each section carries items with description, images, price, availability, dietary tags, calories, and option groups.","properties":{"isMenu":{"type":"boolean","description":"Whether the page was identified as a menu.","isRequired":true,"uniqueKey":"data.menu.oneOf.0.isMenu","typeLabel":"boolean"},"sections":{"type":"array","description":"Menu sections (e.g. 'Appetizers', 'Entrees').","items":{"type":"object","properties":{"name":{"type":"string","description":"The section name.","isRequired":true,"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].name","typeLabel":"string"},"items":{"type":"array","description":"The items in the section.","items":{"type":"object","properties":{"name":{"type":"string","description":"The item name.","isRequired":true,"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].name","typeLabel":"string"},"id":{"type":"string","description":"The item identifier.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].id","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"The item description.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The item description.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].description","typeLabel":"string | null"},"images":{"type":"array","description":"Item images.","items":{"type":"object","properties":{"url":{"type":"string","description":"Image URL.","isRequired":true,"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].images.items.[INDEX].url","typeLabel":"string"},"alt":{"oneOf":[{"type":"string","description":"Alternative text for the image.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].images.items.[INDEX].alt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Alternative text for the image.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].images.items.[INDEX].alt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].images.items.[INDEX].alt","typeLabel":"string | null"}},"required":["url"],"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].images.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].images","typeLabel":"object[]"},"price":{"type":"object","description":"The price of the item.","properties":{"amount":{"type":"number","description":"The numeric price amount.","isRequired":true,"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].price.amount","typeLabel":"number"},"currency":{"type":"string","description":"The ISO 4217 currency code (e.g. 'USD').","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].price.currency","typeLabel":"string"},"formatted":{"type":"string","description":"The price formatted for display (e.g. '$7.99').","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].price.formatted","typeLabel":"string"}},"required":["amount"],"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].price","typeLabel":"object"},"availability":{"type":"object","description":"The availability of the item.","properties":{"inStock":{"type":"boolean","description":"Whether the item is available.","isRequired":true,"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].availability.inStock","typeLabel":"boolean"},"text":{"oneOf":[{"type":"string","description":"Human-readable availability text.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].availability.text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable availability text.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].availability.text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].availability.text","typeLabel":"string | null"}},"required":["inStock"],"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].availability","typeLabel":"object"},"dietary":{"type":"array","description":"Dietary tags for the item (e.g. ['vegetarian']).","items":{"type":"string","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].dietary.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].dietary","typeLabel":"string[]"},"calories":{"oneOf":[{"type":"number","description":"The item's calorie count.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].calories.oneOf.0","typeLabel":"number"},{"type":"null","description":"The item's calorie count.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].calories.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].calories","typeLabel":"number | null"},"optionGroups":{"type":"array","description":"Option/modifier groups for the item.","items":{"type":"object","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].optionGroups.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].optionGroups","typeLabel":"object[]"},"identifiers":{"type":"object","description":"Merchant-specific identifiers for the item.","properties":{"merchantItemId":{"type":"string","description":"The merchant's own item ID.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].identifiers.merchantItemId","typeLabel":"string"}},"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].identifiers","typeLabel":"object"},"url":{"oneOf":[{"type":"string","description":"The canonical URL of the item.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The canonical URL of the item.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].url","typeLabel":"string | null"},"sourceUrl":{"oneOf":[{"type":"string","description":"The URL the item was extracted from.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].sourceUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL the item was extracted from.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].sourceUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX].sourceUrl","typeLabel":"string | null"}},"required":["name"],"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].\\items","typeLabel":"object[]"},"id":{"type":"string","description":"The section identifier.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].id","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"The section description.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The section description.","uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX].description","typeLabel":"string | null"}},"required":["name","items"],"uniqueKey":"data.menu.oneOf.0.sections.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.menu.oneOf.0.sections","typeLabel":"object[]"},"confidence":{"type":"number","description":"A confidence score between 0 and 1 for the menu extraction.","uniqueKey":"data.menu.oneOf.0.confidence","typeLabel":"number"},"merchant":{"type":"object","description":"The merchant the menu belongs to.","properties":{"name":{"type":"string","description":"The merchant name.","isRequired":true,"uniqueKey":"data.menu.oneOf.0.merchant.name","typeLabel":"string"},"type":{"type":"string","description":"The merchant type (e.g. 'restaurant').","uniqueKey":"data.menu.oneOf.0.merchant.type","typeLabel":"string"}},"required":["name"],"uniqueKey":"data.menu.oneOf.0.merchant","typeLabel":"object"},"currency":{"type":"string","description":"The ISO 4217 currency code for the menu (e.g. 'USD'), reported only when the page sources it.","uniqueKey":"data.menu.oneOf.0.currency","typeLabel":"string"},"sourceUrl":{"oneOf":[{"type":"string","description":"The URL the menu was extracted from.","uniqueKey":"data.menu.oneOf.0.sourceUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL the menu was extracted from.","uniqueKey":"data.menu.oneOf.0.sourceUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.menu.oneOf.0.sourceUrl","typeLabel":"string | null"}},"required":["isMenu","sections"],"uniqueKey":"data.menu.oneOf.0","typeLabel":"object"},{"type":"null","description":"Menu information extracted from the page if `menu` is in `formats`. Includes the merchant, currency, and a list of sections, where each section carries items with description, images, price, availability, dietary tags, calories, and option groups.","properties":{"isMenu":{"type":"boolean","description":"Whether the page was identified as a menu."},"confidence":{"type":"number","description":"A confidence score between 0 and 1 for the menu extraction."},"merchant":{"type":"object","description":"The merchant the menu belongs to.","properties":{"name":{"type":"string","description":"The merchant name."},"type":{"type":"string","description":"The merchant type (e.g. 'restaurant')."}},"required":["name"]},"currency":{"type":"string","description":"The ISO 4217 currency code for the menu (e.g. 'USD'), reported only when the page sources it."},"sections":{"type":"array","description":"Menu sections (e.g. 'Appetizers', 'Entrees').","items":{"type":"object","properties":{"id":{"type":"string","description":"The section identifier."},"name":{"type":"string","description":"The section name."},"description":{"oneOf":[{"type":"string","description":"The section description."},{"type":"null","description":"The section description."}]},"items":{"type":"array","description":"The items in the section.","items":{"type":"object","properties":{"id":{"type":"string","description":"The item identifier."},"name":{"type":"string","description":"The item name."},"description":{"oneOf":[{"type":"string","description":"The item description."},{"type":"null","description":"The item description."}]},"images":{"type":"array","description":"Item images.","items":{"type":"object","properties":{"url":{"type":"string","description":"Image URL."},"alt":{"oneOf":[{"type":"string","description":"Alternative text for the image."},{"type":"null","description":"Alternative text for the image."}]}},"required":["url"]}},"price":{"type":"object","description":"The price of the item.","properties":{"amount":{"type":"number","description":"The numeric price amount."},"currency":{"type":"string","description":"The ISO 4217 currency code (e.g. 'USD')."},"formatted":{"type":"string","description":"The price formatted for display (e.g. '$7.99')."}},"required":["amount"]},"availability":{"type":"object","description":"The availability of the item.","properties":{"inStock":{"type":"boolean","description":"Whether the item is available."},"text":{"oneOf":[{"type":"string","description":"Human-readable availability text."},{"type":"null","description":"Human-readable availability text."}]}},"required":["inStock"]},"dietary":{"type":"array","description":"Dietary tags for the item (e.g. ['vegetarian']).","items":{"type":"string"}},"calories":{"oneOf":[{"type":"number","description":"The item's calorie count."},{"type":"null","description":"The item's calorie count."}]},"optionGroups":{"type":"array","description":"Option/modifier groups for the item.","items":{"type":"object"}},"identifiers":{"type":"object","description":"Merchant-specific identifiers for the item.","properties":{"merchantItemId":{"type":"string","description":"The merchant's own item ID."}}},"url":{"oneOf":[{"type":"string","description":"The canonical URL of the item."},{"type":"null","description":"The canonical URL of the item."}]},"sourceUrl":{"oneOf":[{"type":"string","description":"The URL the item was extracted from."},{"type":"null","description":"The URL the item was extracted from."}]}},"required":["name"]}}},"required":["name","items"]}},"sourceUrl":{"oneOf":[{"type":"string","description":"The URL the menu was extracted from."},{"type":"null","description":"The URL the menu was extracted from."}]}},"required":["isMenu","sections"],"uniqueKey":"data.menu.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.menu","typeLabel":"object | null"},"tools":{"oneOf":[{"type":"array","description":"Tool contracts matched to the scraped page's domain. Present only when `domainTools` is `true` on the request. Requires Alexandria access and no zero data retention (403 otherwise); free.","items":{"type":"object","description":"A catalogued provider tool discovered via Alexandria, semantic search, or domain matching. The `toolDetail` request parameter sets which fields appear: `compact` returns only `provider`, `capability`, and `description`; `summary` adds the other fields except `options` and `response`; `full` also adds `options`, `response`, and `examples`.","additionalProperties":true,"properties":{"provider":{"type":"string","description":"The catalogued provider.","isRequired":true,"uniqueKey":"data.tools.oneOf.0.items.[INDEX].provider","typeLabel":"string"},"capability":{"type":"string","description":"The provider-relative capability.","isRequired":true,"uniqueKey":"data.tools.oneOf.0.items.[INDEX].capability","typeLabel":"string"},"description":{"type":"string","description":"Human-readable description of what the tool does.","isRequired":true,"uniqueKey":"data.tools.oneOf.0.items.[INDEX].description","typeLabel":"string"},"id":{"type":"string","description":"The tool's identifier, formatted as `provider/capability`. Omitted when `toolDetail` is `compact`.","uniqueKey":"data.tools.oneOf.0.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Human-readable name of the tool. Omitted when `toolDetail` is `compact`.","uniqueKey":"data.tools.oneOf.0.items.[INDEX].name","typeLabel":"string"},"creditsCost":{"type":"integer","minimum":0,"description":"Credits charged per execution of this tool. Omitted when `toolDetail` is `compact`.","uniqueKey":"data.tools.oneOf.0.items.[INDEX].creditsCost","typeLabel":"integer"},"perRecord":{"type":"boolean","description":"Whether `creditsCost` is charged per record returned rather than per call. Omitted when `toolDetail` is `compact`.","uniqueKey":"data.tools.oneOf.0.items.[INDEX].perRecord","typeLabel":"boolean"},"options":{"type":"array","description":"The capability's accepted options. Present only when `toolDetail` is `full`.","items":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"The option name.","uniqueKey":"data.tools.oneOf.0.items.[INDEX].options.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","description":"The option's data type.","uniqueKey":"data.tools.oneOf.0.items.[INDEX].options.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"data.tools.oneOf.0.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.tools.oneOf.0.items.[INDEX].options","typeLabel":"object[]"},"response":{"type":"object","additionalProperties":true,"description":"Description of the shape of a successful response's `data`. Present only when `toolDetail` is `full`.","properties":{"about":{"type":"string","description":"Human-readable description of the response payload.","uniqueKey":"data.tools.oneOf.0.items.[INDEX].response.about","typeLabel":"string"},"key":{"type":"string","description":"The key under which the primary payload is returned, when applicable.","uniqueKey":"data.tools.oneOf.0.items.[INDEX].response.key","typeLabel":"string"},"fields":{"type":"array","description":"The response's documented fields.","items":{"type":"object","additionalProperties":true,"uniqueKey":"data.tools.oneOf.0.items.[INDEX].response.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.tools.oneOf.0.items.[INDEX].response.fields","typeLabel":"object[]"}},"uniqueKey":"data.tools.oneOf.0.items.[INDEX].response","typeLabel":"object"},"matchedBy":{"type":"array","description":"Why this tool was surfaced. Omitted when `toolDetail` is `compact`.","items":{"type":"string","enum":["semantic","domain"],"uniqueKey":"data.tools.oneOf.0.items.[INDEX].matchedBy.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"data.tools.oneOf.0.items.[INDEX].matchedBy","typeLabel":"enum\u003cstring>[]"},"matchedUrls":{"type":"array","description":"URLs whose domain matched this tool, when matched by domain. Omitted when `toolDetail` is `compact`.","items":{"type":"string","uniqueKey":"data.tools.oneOf.0.items.[INDEX].matchedUrls.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.tools.oneOf.0.items.[INDEX].matchedUrls","typeLabel":"string[]"}},"required":["provider","capability","description"],"uniqueKey":"data.tools.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.tools.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Tool contracts matched to the scraped page's domain. Present only when `domainTools` is `true` on the request. Requires Alexandria access and no zero data retention (403 otherwise); free.","items":{"type":"object","description":"A catalogued provider tool discovered via Alexandria, semantic search, or domain matching. The `toolDetail` request parameter sets which fields appear: `compact` returns only `provider`, `capability`, and `description`; `summary` adds the other fields except `options` and `response`; `full` also adds `options`, `response`, and `examples`.","additionalProperties":true,"properties":{"id":{"type":"string","description":"The tool's identifier, formatted as `provider/capability`. Omitted when `toolDetail` is `compact`."},"provider":{"type":"string","description":"The catalogued provider."},"capability":{"type":"string","description":"The provider-relative capability."},"name":{"type":"string","description":"Human-readable name of the tool. Omitted when `toolDetail` is `compact`."},"description":{"type":"string","description":"Human-readable description of what the tool does."},"creditsCost":{"type":"integer","minimum":0,"description":"Credits charged per execution of this tool. Omitted when `toolDetail` is `compact`."},"perRecord":{"type":"boolean","description":"Whether `creditsCost` is charged per record returned rather than per call. Omitted when `toolDetail` is `compact`."},"options":{"type":"array","description":"The capability's accepted options. Present only when `toolDetail` is `full`.","items":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"The option name."},"type":{"type":"string","description":"The option's data type."}}}},"response":{"type":"object","additionalProperties":true,"description":"Description of the shape of a successful response's `data`. Present only when `toolDetail` is `full`.","properties":{"about":{"type":"string","description":"Human-readable description of the response payload."},"key":{"type":"string","description":"The key under which the primary payload is returned, when applicable."},"fields":{"type":"array","description":"The response's documented fields.","items":{"type":"object","additionalProperties":true}}}},"matchedBy":{"type":"array","description":"Why this tool was surfaced. Omitted when `toolDetail` is `compact`.","items":{"type":"string","enum":["semantic","domain"]}},"matchedUrls":{"type":"array","description":"URLs whose domain matched this tool, when matched by domain. Omitted when `toolDetail` is `compact`.","items":{"type":"string"}}},"required":["provider","capability","description"]},"uniqueKey":"data.tools.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.tools","typeLabel":"object[] | null"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"markdown":"\u003cstring>","pages":[{"pageNumber":123,"markdown":"\u003cstring>"}],"blocks":[{"pageNumber":123,"width":123,"height":123,"status":"\u003cstring>","items":[{"id":"\u003cstring>","type":"\u003cstring>","label":"\u003cstring>","bbox":[123],"content":"\u003cstring>","markdownSpan":[123],"readingOrder":123,"source":"\u003cstring>","confidence":{"layout":123,"ocr":123}}]}],"summary":"\u003cstring>","html":"\u003cstring>","rawHtml":"\u003cstring>","rawBase64":"\u003cstring>","screenshot":"\u003cstring>","audio":"\u003cstring>","video":"\u003cstring>","answer":"\u003cstring>","highlights":"\u003cstring>","links":["\u003cstring>"],"attributes":[{"selector":"\u003cstring>","attribute":"\u003cstring>","values":["\u003cstring>"]}],"actions":{"screenshots":["\u003cstring>"],"scrapes":[{"url":"\u003cstring>","html":"\u003cstring>"}],"javascriptReturns":[{"type":"\u003cstring>","value":"\u003cunknown>"}],"pdfs":["\u003cstring>"]},"metadata":{"title":"\u003cstring>","description":"\u003cstring>","language":"\u003cstring>","sourceURL":"\u003cstring>","url":"\u003cstring>","keywords":"\u003cstring>","ogLocaleAlternate":["\u003cstring>"],"\u003cany other metadata> ":"\u003cstring>","statusCode":123,"numPages":123,"totalPages":123,"contentType":"\u003cstring>","error":"\u003cstring>","concurrencyLimited":true,"concurrencyQueueDurationMs":123,"provider":{"id":"\u003cstring>","creditsCost":123,"steps":[{"provider":"\u003cstring>","status":"matched","creditsCost":123}]}},"warning":"\u003cstring>","changeTracking":{"previousScrapeAt":"2023-11-07T05:31:56Z","changeStatus":"new","visibility":"visible","diff":"\u003cstring>","json":{}},"branding":{"colorScheme":"light","logo":"\u003cstring>","colors":{"primary":"\u003cstring>","secondary":"\u003cstring>","accent":"\u003cstring>","background":"\u003cstring>","textPrimary":"\u003cstring>","textSecondary":"\u003cstring>","link":"\u003cstring>","success":"\u003cstring>","warning":"\u003cstring>","error":"\u003cstring>"},"fonts":[{"family":"\u003cstring>"}],"typography":{"fontFamilies":{"primary":"\u003cstring>","heading":"\u003cstring>","code":"\u003cstring>"},"fontSizes":{"h1":"\u003cstring>","h2":"\u003cstring>","h3":"\u003cstring>","body":"\u003cstring>"},"fontWeights":{"light":123,"regular":123,"medium":123,"bold":123},"lineHeights":{"heading":"\u003cstring>","body":"\u003cstring>"}},"spacing":{"baseUnit":123,"borderRadius":"\u003cstring>","padding":{},"margins":{}},"components":{"buttonPrimary":{"background":"\u003cstring>","textColor":"\u003cstring>","borderRadius":"\u003cstring>"},"buttonSecondary":{"background":"\u003cstring>","textColor":"\u003cstring>","borderColor":"\u003cstring>","borderRadius":"\u003cstring>"},"input":{}},"icons":{},"images":{"logo":"\u003cstring>","favicon":"\u003cstring>","ogImage":"\u003cstring>"},"animations":{},"layout":{},"personality":{}},"product":{"title":"\u003cstring>","url":"\u003cstring>","variants":[{"availability":{"inStock":true,"text":"\u003cstring>"},"id":"\u003cstring>","sku":"\u003cstring>","title":"\u003cstring>","values":{},"price":{"amount":123,"currency":"\u003cstring>","formatted":"\u003cstring>"},"sale":{"originalPrice":{"amount":123,"currency":"\u003cstring>","formatted":"\u003cstring>"}},"images":[{"url":"\u003cstring>","alt":"\u003cstring>"}]}],"brand":"\u003cstring>","category":"\u003cstring>","description":"\u003cstring>"},"menu":{"isMenu":true,"sections":[{"name":"\u003cstring>","items":[{"name":"\u003cstring>","id":"\u003cstring>","description":"\u003cstring>","images":[{"url":"\u003cstring>","alt":"\u003cstring>"}],"price":{"amount":123,"currency":"\u003cstring>","formatted":"\u003cstring>"},"availability":{"inStock":true,"text":"\u003cstring>"},"dietary":["\u003cstring>"],"calories":123,"optionGroups":[{}],"identifiers":{"merchantItemId":"\u003cstring>"},"url":"\u003cstring>","sourceUrl":"\u003cstring>"}],"id":"\u003cstring>","description":"\u003cstring>"}],"confidence":123,"merchant":{"name":"\u003cstring>","type":"\u003cstring>"},"currency":"\u003cstring>","sourceUrl":"\u003cstring>"},"tools":[{"provider":"\u003cstring>","capability":"\u003cstring>","description":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","creditsCost":1,"perRecord":true,"options":[{"name":"\u003cstring>","type":"\u003cstring>"}],"response":{"about":"\u003cstring>","key":"\u003cstring>","fields":[{}]},"matchedBy":["semantic"],"matchedUrls":["\u003cstring>"]}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"dc354ec6-c845-409c-9d32-729028abe1df":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","example":"BAD_REQUEST","uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","example":"Invalid multipart form-data request.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"code":"BAD_REQUEST","error":"Invalid multipart form-data request."}}},"exampleType":"generated"}},"exampleType":"generated"},"225e7e32-a332-468b-9d07-f83ebcca1556":{"description":"Payment required","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Payment required to access this resource.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Payment required to access this resource."}}},"exampleType":"generated"}},"exampleType":"generated"},"75d5bd75-365e-455b-898d-85ac2ac028b0":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Request rate limit exceeded. Please wait and try again later.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Request rate limit exceeded. Please wait and try again later."}}},"exampleType":"generated"}},"exampleType":"generated"},"22070355-bc04-4d1a-8924-50d35e1357ab":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","example":"UNKNOWN_ERROR","uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","example":"An unexpected error occurred on the server.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"code":"UNKNOWN_ERROR","error":"An unexpected error occurred on the server."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8cdc10f8-2f84-4a0f-a814-feb948c113f4":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"7d6b709a-8947-4a54-9707-5b3ba8a3f3cc":{"url":"https://api.firecrawl.dev/v2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/v2-openapi.json"},"subdomain":"firecrawl","siteName":"Firecrawl Docs","title":"Parse - Firecrawl Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/endpoint/parse","matchLevel":0},"v1":{"href":"/introduction","matchLevel":4}},"firstHrefInLanguage":{"en":{"href":"/api-reference/endpoint/parse","matchLevel":0},"es":{"href":"/es/api-reference/endpoint/parse","matchLevel":1},"fr":{"href":"/fr/api-reference/endpoint/parse","matchLevel":1},"ja":{"href":"/ja/api-reference/endpoint/parse","matchLevel":1},"pt-BR":{"href":"/pt-BR/api-reference/endpoint/parse","matchLevel":1},"zh":{"href":"/zh/api-reference/endpoint/parse","matchLevel":1}}},"lastModified":"2026-10-22T15:36:52.322Z","originalFileLocation":"api-reference/endpoint/parse.mdx","locale":"en"},"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=\"application-name\" content=\"Firecrawl Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/firecrawl/XqnL63rz4lpKQF4P/_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/firecrawl/XqnL63rz4lpKQF4P/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/firecrawl/XqnL63rz4lpKQF4P/_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/firecrawl/XqnL63rz4lpKQF4P/_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/firecrawl/XqnL63rz4lpKQF4P/_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/firecrawl/XqnL63rz4lpKQF4P/_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/firecrawl/XqnL63rz4lpKQF4P/_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/firecrawl/XqnL63rz4lpKQF4P/_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/firecrawl/XqnL63rz4lpKQF4P/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Parse - Firecrawl Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Firecrawl Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.firecrawl.dev/api-reference/endpoint/parse\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://firecrawl.mintlify.app/_mintlify/api/og/v2?division=Parse+Endpoints\u0026amp;title=Parse\u0026amp;theme=8a1db76e69d61f6ba4524cb0\u0026amp;signature=e33faba68fc8ab6ecf933b1a03c16b967156a7cdef76c868d48d824532e9c249\">\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=\"Parse - Firecrawl Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firecrawl.mintlify.app/_mintlify/api/og/v2?division=Parse+Endpoints\u0026amp;title=Parse\u0026amp;theme=8a1db76e69d61f6ba4524cb0\u0026amp;signature=e33faba68fc8ab6ecf933b1a03c16b967156a7cdef76c868d48d824532e9c249\">\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/firecrawl/XqnL63rz4lpKQF4P/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Firecrawl Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"Y83UZz1dXMKuT59lnLY_7umo6LJorqIwuP_2rFX6_eE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.firecrawl.dev/api-reference/endpoint/parse\">\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/parse.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.firecrawl.dev/api-reference/endpoint/parse\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.firecrawl.dev/es/api-reference/endpoint/parse\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.firecrawl.dev/fr/api-reference/endpoint/parse\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://docs.firecrawl.dev/ja/api-reference/endpoint/parse\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.firecrawl.dev/pt-BR/api-reference/endpoint/parse\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.firecrawl.dev/zh/api-reference/endpoint/parse\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.firecrawl.dev/api-reference/endpoint/parse\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.firecrawl.dev/#organization\",\"name\":\"Firecrawl Docs\",\"url\":\"https://docs.firecrawl.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/firecrawl/iilnMwCX-8eR1yOO/logo/logo.png?fit=max\u0026auto=format\u0026n=iilnMwCX-8eR1yOO\u0026q=85\u0026s=c45b3c967c19a39190e76fe8e9c2ed5a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.firecrawl.dev#website\",\"name\":\"Firecrawl Docs\",\"url\":\"https://docs.firecrawl.dev\",\"publisher\":{\"@id\":\"https://docs.firecrawl.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.firecrawl.dev/api-reference/endpoint/parse#webpage\",\"url\":\"https://docs.firecrawl.dev/api-reference/endpoint/parse\",\"name\":\"Parse\",\"dateModified\":\"2026-10-22T15:36:52.322Z\",\"isPartOf\":{\"@id\":\"https://docs.firecrawl.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.firecrawl.dev/api-reference/endpoint/parse#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.firecrawl.dev/api-reference/endpoint/parse#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Firecrawl Docs\",\"item\":\"https://docs.firecrawl.dev\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Parse\",\"item\":\"https://docs.firecrawl.dev/api-reference/endpoint/parse\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.firecrawl.dev/api-reference/endpoint/parse#apireference\",\"headline\":\"Parse\",\"name\":\"Parse\",\"url\":\"https://docs.firecrawl.dev/api-reference/endpoint/parse\",\"mainEntityOfPage\":{\"@id\":\"https://docs.firecrawl.dev/api-reference/endpoint/parse#webpage\"},\"dateModified\":\"2026-10-22T15:36:52.322Z\",\"publisher\":{\"@id\":\"https://docs.firecrawl.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.firecrawl.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Firecrawl Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Firecrawl Docs","nav":{"global":null,"languages":[{"language":"en","versions":[{"version":"v2","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/overview"}]},{"tab":"API Reference","groups":[{"group":"Using the API","pages":[{"title":"Introduction","href":"/api-reference/v2-introduction"},{"title":"Errors","href":"/api-reference/errors"}]},{"group":"Search Endpoints","pages":[{"title":"Search","openapi":"api-reference/v2-openapi.json POST /search","href":"/api-reference/endpoint/search"},{"title":"Search Feedback","openapi":"api-reference/v2-openapi.json POST /search/{jobId}/feedback","href":"/api-reference/endpoint/search-feedback"}]},{"group":"Scrape Endpoints","pages":[{"title":"Scrape","openapi":"api-reference/v2-openapi.json POST /scrape","href":"/api-reference/endpoint/scrape"},{"title":"Batch Scrape","openapi":"api-reference/v2-openapi.json POST /batch/scrape","href":"/api-reference/endpoint/batch-scrape"},{"title":"Get Batch Scrape Status","openapi":"api-reference/v2-openapi.json GET /batch/scrape/{id}","href":"/api-reference/endpoint/batch-scrape-get"},{"title":"Cancel Batch Scrape","openapi":"api-reference/v2-openapi.json DELETE /batch/scrape/{id}","href":"/api-reference/endpoint/batch-scrape-delete"},{"title":"Get Batch Scrape Errors","openapi":"api-reference/v2-openapi.json GET /batch/scrape/{id}/errors","href":"/api-reference/endpoint/batch-scrape-get-errors"}]},{"group":"Interact / Browser Sandbox Endpoints","pages":[{"title":"Create Interact Session","openapi":"api-reference/v2-openapi.json POST /interact","href":"/api-reference/endpoint/browser-create"},{"title":"Execute Code in a Session","openapi":"api-reference/v2-openapi.json POST /interact/{sessionId}/execute","href":"/api-reference/endpoint/browser-execute"},{"title":"List Interact Sessions","openapi":"api-reference/v2-openapi.json GET /interact","href":"/api-reference/endpoint/browser-list"},{"title":"Delete Interact Session","openapi":"api-reference/v2-openapi.json DELETE /interact/{sessionId}","href":"/api-reference/endpoint/browser-delete"},{"title":"Interact with a Scraped Page","openapi":"api-reference/v2-openapi.json POST /scrape/{jobId}/interact","href":"/api-reference/endpoint/scrape-execute"},{"title":"Stop Interacting","openapi":"api-reference/v2-openapi.json DELETE /scrape/{jobId}/interact","href":"/api-reference/endpoint/scrape-browser-delete"}]},{"group":"Research Index Endpoints","pages":[{"title":"Search Papers","openapi":"api-reference/v2-openapi.json GET /search/research/papers","href":"/api-reference/endpoint/research-search-papers"},{"title":"Inspect or Read Paper","openapi":"api-reference/v2-openapi.json GET /search/research/papers/{id}","href":"/api-reference/endpoint/research-paper"},{"title":"Find Related Papers","openapi":"api-reference/v2-openapi.json GET /search/research/papers/{id}/similar","href":"/api-reference/endpoint/research-related-papers"}]},{"group":"Developer Index Endpoints","pages":[{"title":"Search the Developer Index","openapi":"api-reference/v2-openapi.json GET /search/developer","href":"/api-reference/endpoint/developer-search"}]},{"group":"Government Index Endpoints","pages":[{"title":"Search the Government Index","openapi":"api-reference/v2-openapi.json GET /search/gov","href":"/api-reference/endpoint/gov-search"}]},{"group":"Map Endpoints","pages":[{"title":"Map","openapi":"api-reference/v2-openapi.json POST /map","description":null,"href":"/api-reference/endpoint/map"}]},{"group":"Parse Endpoints","pages":[{"title":"Parse","openapi":"api-reference/v2-openapi.json POST /parse","href":"/api-reference/endpoint/parse"},{"title":"Parse Formats","openapi":"api-reference/v2-openapi.json GET /parse/formats","description":null,"href":"/api-reference/endpoint/parse-formats"}]},{"group":"Crawl Endpoints","pages":[{"title":"Crawl","openapi":"api-reference/v2-openapi.json POST /crawl","href":"/api-reference/endpoint/crawl-post"},{"title":"Get Crawl Status","openapi":"api-reference/v2-openapi.json GET /crawl/{id}","href":"/api-reference/endpoint/crawl-get"},{"title":"Crawl Params Preview","openapi":"api-reference/v2-openapi.json POST /crawl/params-preview","href":"/api-reference/endpoint/crawl-params-preview"},{"title":"Cancel Crawl","openapi":"api-reference/v2-openapi.json DELETE /crawl/{id}","href":"/api-reference/endpoint/crawl-delete"},{"title":"Get Crawl Errors","openapi":"api-reference/v2-openapi.json GET /crawl/{id}/errors","href":"/api-reference/endpoint/crawl-get-errors"},{"title":"Get Active Crawls","openapi":"api-reference/v2-openapi.json GET /crawl/active","href":"/api-reference/endpoint/crawl-active"}]},{"group":"Monitor Endpoints","pages":[{"title":"Create Monitor","openapi":"api-reference/v2-openapi.json POST /monitor","href":"/api-reference/endpoint/monitor-create"},{"title":"List Monitors","openapi":"api-reference/v2-openapi.json GET /monitor","href":"/api-reference/endpoint/monitor-list"},{"title":"Get Monitor","openapi":"api-reference/v2-openapi.json GET /monitor/{monitorId}","href":"/api-reference/endpoint/monitor-get"},{"title":"Update Monitor","openapi":"api-reference/v2-openapi.json PATCH /monitor/{monitorId}","href":"/api-reference/endpoint/monitor-update"},{"title":"Delete Monitor","openapi":"api-reference/v2-openapi.json DELETE /monitor/{monitorId}","href":"/api-reference/endpoint/monitor-delete"},{"title":"Run Monitor","openapi":"api-reference/v2-openapi.json POST /monitor/{monitorId}/run","href":"/api-reference/endpoint/monitor-run"},{"title":"List Monitor Checks","openapi":"api-reference/v2-openapi.json GET /monitor/{monitorId}/checks","href":"/api-reference/endpoint/monitor-checks-list"},{"title":"Get Monitor Check","openapi":"api-reference/v2-openapi.json GET /monitor/{monitorId}/checks/{checkId}","href":"/api-reference/endpoint/monitor-check-get"}]},{"group":"Agent Endpoints","pages":[{"title":"Agent","openapi":"api-reference/v2-openapi.json POST /agent","href":"/api-reference/endpoint/agent"},{"title":"List Agent Runs","openapi":"api-reference/v2-openapi.json GET /agent","href":"/api-reference/endpoint/agent-list"},{"title":"Get Agent Status","openapi":"api-reference/v2-openapi.json GET /agent/{jobId}","href":"/api-reference/endpoint/agent-get"},{"title":"Get Agent Trace","openapi":"api-reference/v2-openapi.json GET /agent/{jobId}/trace","href":"/api-reference/endpoint/agent-trace"},{"title":"Get Agent Snapshot","openapi":"api-reference/v2-openapi.json GET /agent/{jobId}/snapshots/{snapshotId}","href":"/api-reference/endpoint/agent-snapshot"},{"title":"Cancel Agent","openapi":"api-reference/v2-openapi.json DELETE /agent/{jobId}","href":"/api-reference/endpoint/agent-delete"}]},{"group":"Feedback Endpoints","pages":[{"title":"Endpoint Feedback","openapi":"api-reference/v2-openapi.json POST /feedback","href":"/api-reference/endpoint/feedback"}]},{"group":"Extract Endpoints","hidden":true,"pages":[{"title":"Extract","openapi":"api-reference/v2-openapi.json POST /extract","href":"/api-reference/endpoint/extract"},{"title":"Get Extract Status","openapi":"api-reference/v2-openapi.json GET /extract/{id}","href":"/api-reference/endpoint/extract-get"}]},{"group":"Agentic Debugging Endpoints","pages":[{"title":"Ask","openapi":"api-reference/v2-openapi.json POST /support/ask","href":"/api-reference/endpoint/ask"},{"title":"Docs Search","openapi":"api-reference/v2-openapi.json POST /support/docs-search","href":"/api-reference/endpoint/docs-search"}]},{"group":"Account Endpoints","pages":[{"title":"Activity","openapi":"api-reference/v2-openapi.json GET /team/activity","href":"/api-reference/endpoint/activity"},{"title":"Credit Usage","openapi":"api-reference/v2-openapi.json GET /team/credit-usage","href":"/api-reference/endpoint/credit-usage"},{"title":"Historical Credit Usage","openapi":"api-reference/v2-openapi.json GET /team/credit-usage/historical","href":"/api-reference/endpoint/credit-usage-historical"},{"title":"Token Usage","openapi":"api-reference/v2-openapi.json GET /team/token-usage","hidden":true,"href":"/api-reference/endpoint/token-usage"},{"title":"Historical Token Usage","openapi":"api-reference/v2-openapi.json GET /team/token-usage/historical","hidden":true,"href":"/api-reference/endpoint/token-usage-historical"},{"title":"Queue Status","openapi":"api-reference/v2-openapi.json GET /team/queue-status","href":"/api-reference/endpoint/queue-status"},{"title":"Get Threat Protection Policy","openapi":"api-reference/v2-openapi.json GET /team/threat-protection","href":"/api-reference/endpoint/threat-protection"},{"title":"Update Threat Protection Policy","openapi":"api-reference/v2-openapi.json PUT /team/threat-protection","href":"/api-reference/endpoint/threat-protection-update"}]},{"group":"Webhook Payloads","pages":[{"group":"Crawl","pages":[{"title":"Crawl Started","openapi":"api-reference/webhooks-openapi.json webhook crawlStarted","href":"/api-reference/endpoint/webhook-crawl-started"},{"title":"Crawl Page","openapi":"api-reference/webhooks-openapi.json webhook crawlPage","href":"/api-reference/endpoint/webhook-crawl-page"},{"title":"Crawl Completed","openapi":"api-reference/webhooks-openapi.json webhook crawlCompleted","href":"/api-reference/endpoint/webhook-crawl-completed"}]},{"group":"Batch Scrape","pages":[{"title":"Batch Scrape Started","openapi":"api-reference/webhooks-openapi.json webhook batchScrapeStarted","href":"/api-reference/endpoint/webhook-batch-scrape-started"},{"title":"Batch Scrape Page","openapi":"api-reference/webhooks-openapi.json webhook batchScrapePage","href":"/api-reference/endpoint/webhook-batch-scrape-page"},{"title":"Batch Scrape Completed","openapi":"api-reference/webhooks-openapi.json webhook batchScrapeCompleted","href":"/api-reference/endpoint/webhook-batch-scrape-completed"}]},{"group":"Monitor","pages":[{"title":"Monitor Page","openapi":"api-reference/webhooks-openapi.json webhook monitorPage","href":"/api-reference/endpoint/webhook-monitor-page"},{"title":"Monitor Check Completed","openapi":"api-reference/webhooks-openapi.json webhook monitorCheckCompleted","href":"/api-reference/endpoint/webhook-monitor-check-completed"}]},{"group":"Agent","pages":[{"title":"Agent Started","openapi":"api-reference/webhooks-openapi.json webhook agentStarted","href":"/api-reference/endpoint/webhook-agent-started"},{"title":"Agent Action","openapi":"api-reference/webhooks-openapi.json webhook agentAction","href":"/api-reference/endpoint/webhook-agent-action"},{"title":"Agent Completed","openapi":"api-reference/webhooks-openapi.json webhook agentCompleted","href":"/api-reference/endpoint/webhook-agent-completed"},{"title":"Agent Failed","openapi":"api-reference/webhooks-openapi.json webhook agentFailed","href":"/api-reference/endpoint/webhook-agent-failed"},{"title":"Agent Cancelled","openapi":"api-reference/webhooks-openapi.json webhook agentCancelled","href":"/api-reference/endpoint/webhook-agent-cancelled"}]}]},{"group":"Firecrawl for Platforms","pages":[{"title":"Firecrawl for Platforms","href":"/firecrawl-for-platforms"}]}]},{"tab":"Build with AI","pages":[{"title":"Build with AI","href":"/ai-onboarding"}]}]},{"version":"v1","hidden":true,"pages":[{"title":"v1","href":"/introduction","hidden":true}]}],"global":{"anchors":[{"anchor":"Playground","icon":"play","href":"https://firecrawl.dev/playground"},{"anchor":"Blog","icon":"newspaper","href":"https://firecrawl.dev/blog"},{"anchor":"Community","icon":"comment-dots","href":"https://community.firecrawl.dev/"},{"anchor":"Changelog","icon":"list","href":"https://firecrawl.dev/changelog"}]}},{"language":"es","pages":[{"title":"es","href":"/es/api-reference/endpoint/parse"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/api-reference/endpoint/parse"}]},{"language":"ja","pages":[{"title":"ja","href":"/ja/api-reference/endpoint/parse"}]},{"language":"pt-BR","pages":[{"title":"pt-BR","href":"/pt-BR/api-reference/endpoint/parse"}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/api-reference/endpoint/parse"}]}]},"title":"Parse - Firecrawl Docs","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}