Skip to content
telipot
telipot
Join the waitlistSign in

Start a website crawl from a URL; returns the job id.

Crawl multiple URLs based on options

Job web.crawl.start

Your AI asks

checks the price first
telipot run firecrawl.web.crawl.start \
  --input-json '{"url":"https://example.com","limit":1,"maxDiscoveryDepth":1}' \
  --quote

Price

$0.0038 / page
Priced· before it runs

firecrawl.web.crawl.start

$0.0038 / pageYour plan

Whose account it uses

1The person asking
not needed
2Your company’s Firecrawl plan
Selected identity for this example
3Our account
not used

What it sends

{
  "url": "https://example.com",
  "limit": 1,
  "maxDiscoveryDepth": 1
}

Your Firecrawl login is added for you. Your AI never sees it.

What it costs

$0.0038

per page · billed per result

rate1 credit per page, billed per result
sourcedocs · docs.firecrawl.dev/billing · checked 2026-10-05
confidencedocumented
note1 credit per page crawled, billed as each page finishes, up to limit pages; the status route reports creditsUsed. A PDF costs 1 credit per PDF page. The JSON format that adds 4 credits per page is not offered by this task.

Preview the price first. --quote runs nothing.

For developers · run it

Shell · runs the task on the named account

telipot run firecrawl.web.crawl.start \
  --input-json '{"url":"https://example.com","limit":1,"maxDiscoveryDepth":1}'

url

string · required

The base URL to start crawling from

limit

integer · default 10000

Maximum number of pages to crawl. Always set it; the default is 10000 pages, 10000 credits.

maxDiscoveryDepth

integer

Maximum depth to crawl by discovery order. The root and sitemap pages have depth 0.

includePaths

array · at most 1000

URL pathname regex patterns; only matching URLs are crawled, and the starting URL must match too

excludePaths

array · at most 1000

URL pathname regex patterns; matching URLs are skipped

sitemap

string · one of "skip", "include", "only" · default "include"

skip ignores the sitemap; only crawls the start URL and sitemap URLs without following links

crawlEntireDomain

boolean · default false

Follow internal links to sibling and parent URLs, not only child paths

allowSubdomains

boolean · default false

Follow links to subdomains of the main domain

allowExternalLinks

boolean · default false

Follow links to external websites, one hop

success

boolean

id

string

The crawl job id to pass to the status task

url

string

The status URL of the job
Full output schema · JSONNested fields and constraints

Output JSON Schema

{
  "type": "object",
  "required": [
    "success",
    "id",
    "url"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "id": {
      "type": "string",
      "description": "The crawl job id to pass to the status task"
    },
    "url": {
      "type": "string",
      "description": "The status URL of the job"
    }
  }
}

A real answer

No example captured yet: one is recorded when telipot catalog verify passes.