Examples

Each snippet uses the public Worker endpoint.

Scrape

curl -X POST https://fireflare-api.oladapo.workers.dev/scrape \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com",
  "formats": ["markdown"]
  }'

curl https://fireflare-api.oladapo.workers.dev/scrape/af12...

Search

curl -X POST https://fireflare-api.oladapo.workers.dev/search \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Cloudflare Workers Browser Rendering",
    "limit": 5
  }'

Map

curl -X POST https://fireflare-api.oladapo.workers.dev/map \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "limit": 100,
    "includeSubdomains": true
  }'

Async Crawl status loop

curl -X POST https://fireflare-api.oladapo.workers.dev/crawl \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "limit": 5,
    "maxDepth": 1,
    "async": true
  }'

curl https://fireflare-api.oladapo.workers.dev/crawl/af12... | jq

Batch scrape

curl -X POST https://fireflare-api.oladapo.workers.dev/batch/scrape \
  -H "Content-Type: application/json" \
  -d '{
    "urls": [
      "https://example.com",
      "https://example.com/docs"
    ],
    "formats": ["markdown"],
    "concurrency": 2
  }'

curl https://fireflare-api.oladapo.workers.dev/batch/scrape/af12...

Feedback

curl -X POST https://fireflare-api.oladapo.workers.dev/search/search-job-id/feedback \
  -H "Content-Type: application/json" \
  -d '{"resultIndex": 0, "relevant": true}'

OpenAPI pull

curl https://fireflare-api.oladapo.workers.dev/openapi.json | jq '.paths | keys | length'