apunkt/webclaw
1
0
Fork 0
mirror of https://github.com/0xMassi/webclaw.git synced 2026-06-06 22:05:13 +02:00
Code Issues Projects Releases Packages Wiki Activity
webclaw/examples/firecrawl-compatible-api/README.md
Valerio aab51bea91 docs: add workflow examples
2026-05-18 18:56:00 +02:00

1.3 KiB
Raw Blame History

Firecrawl-Compatible API

webclaw exposes Firecrawl-compatible v2 routes for teams migrating existing scrape, crawl, map, or search calls.

Scrape

curl https://api.webclaw.io/v2/scrape \
  -H "Authorization: Bearer $WEBCLAW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "formats": ["markdown"]
  }'

Crawl

curl https://api.webclaw.io/v2/crawl \
  -H "Authorization: Bearer $WEBCLAW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://docs.example.com",
    "limit": 25,
    "maxDepth": 2
  }'

Poll the returned crawl id:

curl https://api.webclaw.io/v2/crawl/$CRAWL_ID \
  -H "Authorization: Bearer $WEBCLAW_API_KEY"

Map

curl https://api.webclaw.io/v2/map \
  -H "Authorization: Bearer $WEBCLAW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://docs.example.com"
  }'

Search

curl https://api.webclaw.io/v2/search \
  -H "Authorization: Bearer $WEBCLAW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "site:docs.rs tokio tutorial",
    "limit": 5
  }'

Compatibility routes are meant to reduce migration friction. For new projects, prefer the native /v1 API because it exposes webclaw-specific options more directly.