API Reference

The Fair API.

Every Fair product is API-first. One Bearer token works across all 38 products. This page is the umbrella overview — for product-specific endpoint reference, jump to fair<product>.ai/api.

Base URL

https://api.faircompany.ai

Every product is namespaced under /v1/<product>/ — for example /v1/sign/envelopes, /v1/mail/campaigns, /v1/crawl/web/scrape.

Authentication

Every request uses a single Bearer token issued at tryfair.ai/api-keys. One token, every product. The token is bound to a wallet — operations draw from that wallet at the published per-unit rate.

Authorization: Bearer fair_live_...

The hold/settle/void gate

Every metered request returns a hold_id. We hold the per-unit cost against your wallet at request time, settle on success, void on failure. If a product can't deliver, you're charged \$0. Receipts include the gate decision.

Per-product endpoints

Each Fair product has its own portal with a full endpoint reference:

OpenAPI spec

The full machine-readable spec lives at api.faircompany.ai/openapi. Drop it into Postman, generate a typed client, or build agent tooling.

SDKs

Typed clients for TypeScript / Python:

npm install @fair/sdk
pip install fair-sdk

The SDK handles auth, retries, and quality-gate settlement automatically.

Errors

  • 402 Payment Required — wallet balance below the hold amount. Top up at tryfair.ai/wallet.
  • 401 Unauthorized — missing or invalid Bearer token.
  • 422 Unprocessable — input failed validation.
  • 429 Rate Limit — exponential backoff with the Retry-After header.
  • 5xx — held funds are auto-voided after 5 minutes if no settlement arrives.

Support

Questions? Email hello@faircompany.ai.