urlstringrequired
The starting URL to crawl.
https://api.sandbase.ai/v1/api/firecrawl/crawlCrawl an entire website starting from a URL. Discovers and scrapes all reachable pages, returning clean markdown for each. Runs asynchronously — submit the job, then poll for results.
Your output will appear here
Complete the inputs, then click Run.
Crawls a website from a starting URL and returns the content of each page it finds as markdown, plus page metadata. It needs a url and a limit for the maximum number of pages. The job runs asynchronously, so you submit it and then poll for the result.
curl -X POST "https://api.sandbase.ai/v1/api/firecrawl/crawl" \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com", "limit": 2}'
The result is returned in outputs[0].data.
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | Yes | Maximum number of pages to crawl. |
url | string | Yes | The starting URL to crawl. |
scrapeOptions | object | No | Options passed to the scraper for each page. |
Real response for the request above, trimmed: lists keep their first item and long strings are cut.
{
"completed": 2,
"completedAt": "2026-11-03T07:33:32.633Z",
"createdAt": "2026-11-03T07:33:31.620Z",
"creditsUsed": 2,
"data": [
{
"markdown": "This domain is for use in documentation examples without needing permission. Thi…",
"metadata": {
"cacheState": "hit",
"cachedAt": "2026-11-03T07:33:19.669Z",
"contentType": "text/html; charset=utf-8",
"creditsUsed": 1,
"favicon": "data:,",
"language": "en",
"proxyUsed": "basic",
"scrapeId": "01a1a053-d857-759b-8946-800c1acf51cf"
},
"warning": "This scrape job was throttled at your current concurrency limit. If you'd like t…"
}
],
"duration": 1.013,
"expiresAt": "2026-11-04T07:33:41.000Z",
"status": "completed",
"success": true,
"total": 2
}
| Field | Meaning |
|---|---|
status / success | status shows the job state, such as completed. success is a boolean for the request. |
total / completed | total is the number of pages found for the job. completed is the number of pages finished so far. |
data[].markdown | The page content converted to markdown. |
data[].metadata.language / data[].metadata.contentType | The page language code (for example en) and the content type of the response (for example text/html; charset=utf-8). |
data[].metadata.scrapeId | An ID for the scrape of that single page. |
data[].metadata.cacheState / data[].metadata.cachedAt | cacheState shows whether the page came from a cache (for example hit). cachedAt is the ISO timestamp of the cached copy. |
data[].metadata.creditsUsed / creditsUsed | Credits used for one page and for the whole job. |
data[].warning | An optional message on a page, such as a note that the scrape was throttled. It appears only on some items. |
createdAt / completedAt / expiresAt | ISO 8601 UTC timestamps for when the job started, when it finished, and when the result expires. |
duration | How long the job took. The value in the example is 1.013. |
GET /v1/run/{id} until status is completed, then read the result from outputs[0].data.limit between 1 and 10000 to cap the number of pages crawled.scrapeOptions.formats to choose the output formats: markdown, html, rawHtml, links or screenshot.Billed at the actual cost of each call, about $0.0075 for the request above. Failed calls are not charged.
Start building
Platform API endpoint with unified authentication and usage tracking.
# The quoted heredoc keeps Unicode and shell metacharacters unchanged.
result=$(curl --fail-with-body --silent \
-X POST "https://api.sandbase.ai/v1/api/firecrawl/crawl" \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @- <<'SANDBASE_JSON'
{}
SANDBASE_JSON
)
printf '%s\n' "$result"Set your SandBase API key in your server environment. Requests use Bearer authentication.
export SANDBASE_API_KEY="YOUR_API_KEY"Keep your key on the server. Do not expose it in browser code.
urlstringrequiredThe starting URL to crawl.
limitintegerrequiredMaximum number of pages to crawl.
scrapeOptionsobjectOptions passed to the scraper for each page.
Saved example response for this API; no live request is made when viewing it.
No saved response has been published. Run the API in Playground to inspect its response.
Explore more
| API | Price | Response |
|---|---|---|
Firecrawl CrawlThis API Firecrawl | From $0.0075 per call | Async JSON |
Firecrawl | From $0.0075 per call | Async JSON |
Firecrawl | $0.0075 per call | JSON |
Firecrawl | $0.0075 per call | JSON |
Firecrawl | $0.015 per call | JSON |
Questions
Send a POST request to https://api.sandbase.ai/v1/api/firecrawl/crawl with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.
From $0.0075 per call, billed from your SandBase balance. You are only charged for calls you make; there is no subscription.
Required: url (string) and limit (integer). Optional: scrapeOptions (object). The Parameters table and the Playground on this page list every field.
A JSON result. This endpoint runs asynchronously, so the response tells you how to fetch the finished result. The README on this page includes a sample response.
No. Firecrawl Crawl runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for Firecrawl API access separately.