Appearance
POST /v1/map
POST
/v1/map
Map a website to get all URLs
Authorizations
bearerAuth
TypeHTTP (bearer)
Request Body
application/json
JSON
{
"includePaths": [
[
"/blog/*",
"/articles/*",
"/docs/*"
]
],
"excludePaths": [
[
"/admin/*",
"/private/*",
"/api/*"
]
],
"maxDepth": 3,
"limit": 1000,
"allowBackwardLinks": false,
"allowExternalLinks": false,
"ignoreSitemap": true,
"url": "string",
"origin": "api",
"includeSubdomains": true,
"search": "documentation"
}
Responses
Successful response
application/json
JSON
{
"success": true,
"links": [
[
"https://firecrawl.dev/pricing",
"https://firecrawl.dev/docs",
"https://firecrawl.dev/blog",
"https://firecrawl.dev/contact"
]
],
"scrape_id": "map_987fcdeb-51a2-4bc3-8765-fedcba098765"
}