Map website with Firecrawl - Automate.ax

firecrawl.mapWebsite discovers pages from sitemaps and links without downloading full page content. Use it to inspect a site before choosing URLs to scrape or crawl. Inputs accept literal values or compatible signals. An optional second argument { account } selects the Firecrawl binding.

Example

automations/map-documentation.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { firecrawl } from "automate.ax/firecrawl"

export default automation("Map documentation", () => {
  onDashboardRun({ title: "Map documentation" })

  firecrawl.mapWebsite({
    url: "https://docs.example.com",
    search: "authentication",
    sitemap: "include",
    limit: 500,
  })
})

Inputs

Input	Type	Required	Default	Description
`url`	`string`	Yes	—	Website root URL.
`search`	`string`	No	None	Rank discovered pages against this text.
`sitemap`	`'only' \| 'include' \| 'skip'`	No	`include`	Use only the sitemap, combine it with link discovery, or skip it.
`includeSubdomains`	`boolean`	No	`true`	Include pages from subdomains.
`ignoreQueryParameters`	`boolean`	No	`true`	Exclude URL variants that differ only by query parameters.
`limit`	`number`	No	`5000`	Maximum discovered links, up to 100,000.
`location`	`{ country?: string; languages?: string[] }`	No	US	Proxy location and preferred languages.
`timeout`	`number`	No	Provider default	Maximum provider map time in milliseconds.
`threatProtection`	`object`	No	Account policy	Enterprise threat-protection overrides.
`auditMetadata`	`{ username: string }`	No	None	User identity attached to Firecrawl audit logs.

Output

Returns { id?, links }. Every link contains url and can include Firecrawl’s title and description. Mapping does not return page bodies; pass selected URLs to firecrawl.scrapeUrl when you need content.