Search query to use for mapping. During the Alpha phase, the 'smart' part of the search functionality is limited to 500 search results. However, if map finds more results, there is no limit applied.
Location settings for the request. When specified, this will use an appropriate proxy if available and emulate the corresponding language and timezone settings. Defaults to 'US' if not specified.
Per-request Threat Protection override. Fields you provide replace the corresponding fields of your organization's policy for this request only; omitted fields keep their organization-level values. Requires Threat Protection to be enabled for your team (enterprise feature) — otherwise the request is rejected with a 403. If your organization has disabled request overrides, any request that includes this object is rejected with a 403. If Threat Protection is enforced for your team, mode may not be set to off.
{"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":"6aec159515b1ab255d6b416e","collectionId":"1d9c25ea-eee5-416c-8095-cec5ae79379a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aec159515b1ab255d6b416e"},"feedback":{"thumbs":false,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aeded33cf5f3c82974f5ba0","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"en","tag":"Documentation","count":116},{"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":68},{"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":{},"basePath":"","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instinct-self-updating-docs","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"li.navbar-link a[href*=\"firecrawl.dev/signin\"]{background-color:#ff4d00;color:#fff}li.navbar-link a[href*=\"firecrawl.dev/signin\"]:hover{background-color:#e64500}.dark li.navbar-link a[href*=\"firecrawl.dev/signin\"]{background-color:#ff4d00;color:#fff}.dark li.navbar-link a[href*=\"firecrawl.dev/signin\"]:hover{background-color:#e64500}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, 0.04) 0%, rgba(255, 77, 0, 0.02) 100%);border:1px solid rgba(255, 77, 0, 0.15);border-radius:12px;padding:20px}.firecrawl-cta-logo{height:20px;width:auto;object-fit:contain;margin-bottom:12px}.firecrawl-cta-logo-dark{display:none}.dark .firecrawl-cta-logo-light{display:none}.dark .firecrawl-cta-logo-dark{display:block}.firecrawl-cta-title{font-size:18px;font-weight:600;color:#111;margin:0 0 8px 0;line-height:1.3}.firecrawl-cta-description{font-size:13px;line-height:1.5;color:#666;margin:0 0 16px 0}.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:none!important;box-shadow:none!important;text-decoration:none!important;transition:background-color 0.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 0.2s ease, background-color 0.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, 0.08) 0%, rgba(255, 77, 0, 0.04) 100%);border-color:rgba(255, 77, 0, 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-primary:hover{background-color:#e64500}.dark .firecrawl-cta-btn-secondary{background-color:rgba(255, 255, 255, 0.05);border-color:rgba(255, 255, 255, 0.1);color:#ddd!important}.dark .firecrawl-cta-btn-secondary:hover{background-color:rgba(255, 255, 255, 0.1);border-color:rgba(255, 255, 255, 0.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 p,.fc-agent-first-header [data-as=\"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:transparent;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-client-tab:focus-visible,.fc-copy-button:focus-visible,.fc-install-button:focus-visible,.fc-agent-prompt-button:focus-visible,.fc-all-options-link: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{filter:invert(1) brightness(1.6)}.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{overflow:hidden;color:var(--fc-text);font-size:14px;line-height:20px;text-overflow:ellipsis;white-space:nowrap}.fc-client-tab-copy>span{overflow:hidden;color:var(--fc-text-muted);font-size:13px;line-height:18px;text-overflow:ellipsis;white-space:nowrap}.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:0.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:transparent;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{flex:none;color:var(--fc-text-muted);font-family:ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;font-size:13px;line-height:20px;user-select:none}.fc-command-scroll code{padding:0 20px 0 0;border:0;border-radius:0;background:transparent;color:var(--fc-text);font-family:ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;font-size:13px;line-height:20px;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:transparent;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{background:var(--fc-subtle-hover);color:var(--fc-text)}.fc-copy-button.is-copied{background:var(--fc-heat-soft);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;background:var(--fc-subtle-hover);color:var(--fc-text)!important;font-size:13px;font-weight:600;text-decoration:none!important;transition:background-color 160ms ease, transform 160ms ease}.fc-install-button:hover{background:var(--fc-heat-soft)}.fc-install-button:active,.fc-agent-prompt-button:active{transform:scale(0.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 0.75px 0.75px 0 rgba(0, 0, 0, 0.02),\n inset 0 0.25px 0.25px 0 rgba(0, 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, 0.08)}.dark .fc-agent-prompt-button:hover{background:rgba(255, 255, 255, 0.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-curvy-corners,.fc-curve{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:nth-last-child(-n+2):nth-child(odd),.fc-client-tab:last-child{border-bottom:0}.fc-client-panel{padding:16px 20px 20px}.fc-command-scroll code,.fc-command-prompt{font-size:12px}.fc-agent-first-footer{padding:14px 20px 18px}.fc-install-button,.fc-agent-prompt-button{width:100%}}@media (prefers-reduced-motion: reduce){.fc-agent-first *,.fc-agent-prompt *{scroll-behavior:auto!important;transition-duration:0.01ms!important}}"}],"page":{"pagePath":"api-reference/v1-endpoint/map","slug":"/api-reference/v1-endpoint/map","pageMetadata":{"title":"Map","openapi":"api-reference/v1-openapi.json POST /map","description":null,"href":"/api-reference/v1-endpoint/map","hidden":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,blockquote:`blockquote`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.blockquote,{children:[`\n`,_jsxs(_components.p,{children:[`Note: A new `,_jsx(_components.a,{href:`/api-reference/endpoint/map`,children:`v2 version of this API`}),` is now available with improved features and performance.`]}),`\n`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Map","openapi":"api-reference/v1-openapi.json POST /map","description":null,"href":"/api-reference/v1-endpoint/map","hidden":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/firecrawl/0081870911af9531/ready-to-build-cta.js","/_mintlify/custom/firecrawl/d82a383589d76971/chatbase-widget.js"],"openApiReferenceData":{"operation":{"summary":"Map multiple URLs based on options","operationId":"mapUrls","tags":["Mapping"],"security":["39616a84-9b19-474d-9807-c71f7184a1d2"],"requestBody":"d2417daf-73f2-417c-8bed-3bd51424f118","responses":{"200":"2925ff4e-415d-4a46-abf9-629f6aa014be","402":"21af77fb-c022-4707-beeb-d1c7d252cb67","429":"856c7ee1-c74b-4746-8483-15227e585ce9","500":"a4a5d20e-28c0-40b5-b2f1-ce543fd08c54"},"method":"post","type":"path","servers":["dd67838c-9794-4605-946c-f91cee1ddecd"],"path":"/map","baseUrlOptions":["https://api.firecrawl.dev/v1"],"title":"Map multiple URLs based on options","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The base URL to start crawling from","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"search":{"type":"string","description":"Search query to use for mapping. During the Alpha phase, the 'smart' part of the search functionality is limited to 500 search results. However, if map finds more results, there is no limit applied.","uniqueKey":"search","typeLabel":"string"},"ignoreSitemap":{"type":"boolean","description":"Ignore the website sitemap when crawling.","default":true,"uniqueKey":"ignoreSitemap","typeLabel":"boolean"},"sitemapOnly":{"type":"boolean","description":"Only return links found in the website sitemap","default":false,"uniqueKey":"sitemapOnly","typeLabel":"boolean"},"includeSubdomains":{"type":"boolean","description":"Include subdomains of the website","default":true,"uniqueKey":"includeSubdomains","typeLabel":"boolean"},"limit":{"type":"integer","description":"Maximum number of links to return","default":5000,"maximum":30000,"uniqueKey":"limit","typeLabel":"integer"},"timeout":{"type":"integer","description":"Timeout in milliseconds. There is no timeout by default.","uniqueKey":"timeout","typeLabel":"integer"},"location":{"type":"object","description":"Location settings for the request. When specified, this will use an appropriate proxy if available and emulate the corresponding language and timezone settings. Defaults to 'US' if not specified.","properties":{"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code (e.g., 'US', 'AU', 'DE', 'JP')","pattern":"^[A-Z]{2}$","default":"US","uniqueKey":"location.country","typeLabel":"string"},"languages":{"type":"array","description":"Preferred languages and locales for the request in order of priority. Defaults to the language of the specified location. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language","items":{"type":"string","example":"en-US","uniqueKey":"location.languages.items.[INDEX]","typeLabel":"string"},"uniqueKey":"location.languages","typeLabel":"string[]"}},"uniqueKey":"location","typeLabel":"object"},"threatProtection":{"type":"object","title":"Threat Protection Override","description":"Per-request [Threat Protection](https://docs.firecrawl.dev/features/threat-protection) override. Fields you provide replace the corresponding fields of your organization's policy for this request only; omitted fields keep their organization-level values. Requires Threat Protection to be enabled for your team (enterprise feature) — otherwise the request is rejected with a 403. If your organization has disabled request overrides, any request that includes this object is rejected with a 403. If Threat Protection is enforced for your team, `mode` may not be set to `off`.","properties":{"mode":{"type":"string","enum":["off","normal"],"description":"URL scanning mode for this request. `normal` checks URLs against Google Web Risk (+2 credits per URL scanned).","uniqueKey":"threatProtection.mode","typeLabel":"enum\u003cstring>"},"riskScoreThreshold":{"type":"integer","minimum":0,"maximum":100,"description":"Normalized risk score (0–100) at or above which a classifier verdict blocks the URL. Lower is stricter.","example":75,"uniqueKey":"threatProtection.riskScoreThreshold","typeLabel":"integer"},"blacklist":{"type":"array","maxItems":1000,"items":{"type":"string","uniqueKey":"threatProtection.blacklist.items.[INDEX]","typeLabel":"string"},"description":"Domains to always block, as plain domains (`example.com`) or wildcard globs (`*.example.com`). No protocol, path, or port.","uniqueKey":"threatProtection.blacklist","typeLabel":"string[]"},"whitelist":{"type":"array","maxItems":1000,"items":{"type":"string","uniqueKey":"threatProtection.whitelist.items.[INDEX]","typeLabel":"string"},"description":"Domains to always allow, as plain domains or wildcard globs. Wins over every other rule.","uniqueKey":"threatProtection.whitelist","typeLabel":"string[]"},"blockedTlds":{"type":"array","maxItems":1000,"items":{"type":"string","uniqueKey":"threatProtection.blockedTlds.items.[INDEX]","typeLabel":"string"},"description":"Top-level domains to block outright, lowercase without the leading dot (e.g. `zip`).","uniqueKey":"threatProtection.blockedTlds","typeLabel":"string[]"},"failurePolicy":{"type":"string","enum":["open","closed"],"description":"What to do when the classifier can't be reached: `closed` blocks the request, `open` allows it.","uniqueKey":"threatProtection.failurePolicy","typeLabel":"enum\u003cstring>"}},"uniqueKey":"threatProtection","typeLabel":"Threat Protection Override · object"}},"required":["url"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"url":"\u003cstring>","search":"\u003cstring>","ignoreSitemap":true,"sitemapOnly":false,"includeSubdomains":true,"limit":5000,"timeout":123,"location":{"country":"US","languages":["en-US"]},"threatProtection":{"riskScoreThreshold":75,"blacklist":["\u003cstring>"],"whitelist":["\u003cstring>"],"blockedTlds":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"2925ff4e-415d-4a46-abf9-629f6aa014be":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"links":{"type":"array","items":{"type":"string","uniqueKey":"links.items.[INDEX]","typeLabel":"string"},"uniqueKey":"links","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"links":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"21af77fb-c022-4707-beeb-d1c7d252cb67":{"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"},"856c7ee1-c74b-4746-8483-15227e585ce9":{"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"},"a4a5d20e-28c0-40b5-b2f1-ce543fd08c54":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"An unexpected error occurred on the server.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"An unexpected error occurred on the server."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"39616a84-9b19-474d-9807-c71f7184a1d2":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"dd67838c-9794-4605-946c-f91cee1ddecd":{"url":"https://api.firecrawl.dev/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"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/v1-openapi.json"},"subdomain":"firecrawl","siteName":"Firecrawl Docs","title":"Map - Firecrawl Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/endpoint/map","matchLevel":1},"v1":{"href":"/api-reference/v1-endpoint/map","matchLevel":0}},"firstHrefInLanguage":{"en":{"href":"/api-reference/v1-endpoint/map","matchLevel":0},"es":{"href":"/es/api-reference/v1-endpoint/map","matchLevel":1,"hidden":true},"fr":{"href":"/fr/api-reference/v1-endpoint/map","matchLevel":1,"hidden":true},"ja":{"href":"/ja/api-reference/v1-endpoint/map","matchLevel":1,"hidden":true},"pt-BR":{"href":"/pt-BR/api-reference/v1-endpoint/map","matchLevel":1,"hidden":true},"zh":{"href":"/zh/api-reference/v1-endpoint/map","matchLevel":1,"hidden":true}}},"lastModified":"2026-11-04T13:20:32.400Z","originalFileLocation":"api-reference/v1-endpoint/map.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\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\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=\"Map - 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/v1-endpoint/map\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://firecrawl.mintlify.site/_mintlify/api/og/v2?division=Map+Endpoints\u0026amp;title=Map\u0026amp;theme=8a1db76e69d61f6ba4524cb0\u0026amp;signature=00c1a9a0fa340bef0ecbcca7e122f2a2b97f29aa00e7149be4f8e12ce5d8bc31\">\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=\"Map - Firecrawl Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firecrawl.mintlify.site/_mintlify/api/og/v2?division=Map+Endpoints\u0026amp;title=Map\u0026amp;theme=8a1db76e69d61f6ba4524cb0\u0026amp;signature=00c1a9a0fa340bef0ecbcca7e122f2a2b97f29aa00e7149be4f8e12ce5d8bc31\">\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/v1-endpoint/map\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v1-endpoint/map.md\">\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/v1-endpoint/map#webpage\",\"url\":\"https://docs.firecrawl.dev/api-reference/v1-endpoint/map\",\"name\":\"Map\",\"dateModified\":\"2026-11-04T13:20:32.400Z\",\"isPartOf\":{\"@id\":\"https://docs.firecrawl.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.firecrawl.dev/api-reference/v1-endpoint/map#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.firecrawl.dev/api-reference/v1-endpoint/map#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Firecrawl Docs\",\"item\":\"https://docs.firecrawl.dev\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Map\",\"item\":\"https://docs.firecrawl.dev/api-reference/v1-endpoint/map\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.firecrawl.dev/api-reference/v1-endpoint/map#apireference\",\"headline\":\"Map\",\"name\":\"Map\",\"url\":\"https://docs.firecrawl.dev/api-reference/v1-endpoint/map\",\"mainEntityOfPage\":{\"@id\":\"https://docs.firecrawl.dev/api-reference/v1-endpoint/map#webpage\"},\"dateModified\":\"2026-11-04T13:20:32.400Z\",\"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","pages":[{"title":"v2","href":"/api-reference/endpoint/map"}]},{"version":"v1","hidden":true,"tabs":[{"tab":"Documentation","hidden":true,"searchable":true,"pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"SDKs","hidden":true,"searchable":true,"pages":[{"title":"SDKs","href":"/sdks/overview"}]},{"tab":"Integrations","href":"https://www.firecrawl.dev/app"},{"tab":"API Reference","groups":[{"group":"Using the API","pages":[{"title":"Introduction","description":"Firecrawl API Reference","href":"/v1/api-reference/introduction"}]},{"group":"Scrape Endpoints","pages":[{"title":"Scrape","openapi":"api-reference/v1-openapi.json POST /scrape","description":null,"href":"/api-reference/v1-endpoint/scrape"},{"title":"Batch Scrape","openapi":"api-reference/v1-openapi.json POST /batch/scrape","description":null,"href":"/api-reference/v1-endpoint/batch-scrape"},{"title":"Get Batch Scrape Status","openapi":"api-reference/v1-openapi.json GET /batch/scrape/{id}","description":null,"href":"/api-reference/v1-endpoint/batch-scrape-get"},{"title":"Cancel Batch Scrape","openapi":"api-reference/v1-openapi.json DELETE /batch/scrape/{id}","description":null,"href":"/api-reference/v1-endpoint/batch-scrape-delete"},{"title":"Get Batch Scrape Errors","openapi":"api-reference/v1-openapi.json GET /batch/scrape/{id}/errors","description":null,"href":"/api-reference/v1-endpoint/batch-scrape-get-errors"}]},{"group":"Crawl Endpoints","pages":[{"title":"Crawl","openapi":"api-reference/v1-openapi.json POST /crawl","description":null,"href":"/api-reference/v1-endpoint/crawl-post"},{"title":"Get Crawl Status","openapi":"api-reference/v1-openapi.json GET /crawl/{id}","description":null,"href":"/api-reference/v1-endpoint/crawl-get"},{"title":"Cancel Crawl","openapi":"api-reference/v1-openapi.json DELETE /crawl/{id}","description":null,"href":"/api-reference/v1-endpoint/crawl-delete"},{"title":"Get Crawl Errors","openapi":"api-reference/v1-openapi.json GET /crawl/{id}/errors","description":null,"href":"/api-reference/v1-endpoint/crawl-get-errors"},{"title":"Get Active Crawls","openapi":"api-reference/v1-openapi.json GET /crawl/active","description":null,"href":"/api-reference/v1-endpoint/crawl-active"}]},{"group":"Map Endpoints","pages":[{"title":"Map","openapi":"api-reference/v1-openapi.json POST /map","href":"/api-reference/v1-endpoint/map"}]},{"group":"Search Endpoints","pages":[{"title":"Search","openapi":"api-reference/v1-openapi.json POST /search","description":null,"href":"/api-reference/v1-endpoint/search"}]},{"group":"Extract Endpoints","pages":[{"title":"Extract","openapi":"api-reference/v1-openapi.json POST /extract","description":null,"href":"/api-reference/v1-endpoint/extract"},{"title":"Get Extract Status","openapi":"api-reference/v1-openapi.json GET /extract/{id}","description":null,"href":"/api-reference/v1-endpoint/extract-get"}]},{"group":"Account Endpoints","pages":[{"title":"Credit Usage","openapi":"api-reference/v1-openapi.json GET /team/credit-usage","description":null,"href":"/api-reference/v1-endpoint/credit-usage"},{"title":"Historical Credit Usage","openapi":"api-reference/v1-openapi.json GET /team/credit-usage/historical","description":null,"href":"/api-reference/v1-endpoint/credit-usage-historical"},{"title":"Token Usage","openapi":"api-reference/v1-openapi.json GET /team/token-usage","description":null,"href":"/api-reference/v1-endpoint/token-usage"},{"title":"Historical Token Usage","openapi":"api-reference/v1-openapi.json GET /team/token-usage/historical","description":null,"href":"/api-reference/v1-endpoint/token-usage-historical"},{"title":"Queue Status","openapi":"api-reference/v1-openapi.json GET /team/queue-status","description":null,"href":"/api-reference/v1-endpoint/queue-status"}]}]}]}],"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/v1-endpoint/map"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/api-reference/v1-endpoint/map"}]},{"language":"ja","pages":[{"title":"ja","href":"/ja/api-reference/v1-endpoint/map"}]},{"language":"pt-BR","pages":[{"title":"pt-BR","href":"/pt-BR/api-reference/v1-endpoint/map"}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/api-reference/v1-endpoint/map"}]}]},"basePath":"","title":"Map - Firecrawl Docs","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}