API Reference

Contract generated from Chanfana classes in src/openapi-routes.ts. Schema is source-of-truth:

• https://fireflare-api.oladapo.workers.dev/openapi.json
• http://localhost:8787/openapi.json when running wrangler dev

Base URL and headers

• Base URL: https://fireflare-api.oladapo.workers.dev
• Content-Type: application/json

{
  "success": true,
  "id": "uuid-or-job-id",
  "data": {},
  "error": null,
  "code": "OK"
}

Single canonical route set (/scrape, /extract, /search, /map, /crawl, /batch/scrape). openapi.json reflects every registered route.

Deployment flow

1. GET / — service health
2. POST ... — launch work, returns job id
3. GET .../{id} — status and payload
4. DELETE .../{id} — cancel if still running

Chanfana workflow

• Do not hand-write OpenAPI JSON.
• Update src/openapi-routes.ts endpoint classes.
• Keep route behavior in src/handlers/**.
• Deploy — schema regenerates at runtime.

---

Table of contents

• Scrape
• Extract
• Search
• Map
• Crawl
• Batch Scrape