Skip to content
FairCrawl Docs

OpenAPI

The Fair API publishes a live OpenAPI 3.1 document and a Swagger UI.

  • JSON spec: https://api.faircompany.ai/v1/docs
  • Swagger UI: https://api.faircompany.ai/v1/docs/ui

Download the spec

Terminal window
curl https://api.faircompany.ai/v1/docs -o fair-openapi.json

Inspect it from TypeScript

const response = await fetch("https://api.faircompany.ai/v1/docs");
const spec = await response.json();


console.log(spec.openapi);
console.log(Object.keys(spec.paths).filter((path) => path.startsWith("/v1/crawl")));

Inspect it from Python

import httpx


response = httpx.get("https://api.faircompany.ai/v1/docs", timeout=30)
response.raise_for_status()
spec = response.json()


print(spec["openapi"])
print([path for path in spec["paths"] if path.startswith("/v1/crawl")][:10])

Notes

  • the published spec covers the shared Fair API, not only FairCrawl
  • the generated JSON is the best source for codegen or client contract checks
  • FairCrawl docs pages link to the concrete route families that matter most for product work