API Reference

FairFlow API.

REST API. Auth with a Bearer token.

Base URL

https://api.faircompany.ai/v1/flow

Authentication

All requests use a Bearer token. Get one from fairflow.ai/app.

Authorization: Bearer fair_live_...

Endpoints

POST/v1/flow/runs

Create a new workflow run.

{
  "input": "...",
  "metadata": { "ref": "your-internal-id" }
}

Returns the resource:

{
  "id": "workflow run_01HX...",
	  "status": "queued"
}

GET/v1/flow/runs/:id

Fetch a workflow run by ID. Returns full state.

GET/v1/flow/runs

List workflow runs. Supports cursor pagination, created_after, status, and metadata filters.

DELETE/v1/flow/runs/:id

Cancel a queued workflow run.

Errors

  • 401 Unauthorized — missing or invalid Bearer token.
  • 422 Unprocessable — input failed validation.