Flow Relay API

Flow Relay captures, synthesizes, and redistributes your work context. Everything the product does is exposed through a project-scoped REST API – you can call it over HTTP from any language. The MCP server and the editor extension are simply clients of this same API.

curl
curl "https://www.flowrelay.it/api/v1/projects" \
  -H "Authorization: Bearer fr_your_api_key"

How it works

  • Project-scoped. Reads and generations target a project you can access; the key inherits your tenant role.
  • Asynchronous generation. Handoffs and insights return a jobId – you poll the job until it completes.
  • Bearer auth. Every request carries an fr_ key. Rate limit: 60 requests / minute / key.

Quickstart

Create a key, list projects, generate your first handoff.

Authentication

Bearer keys, rotation, rate limits, 401 / 429.

Async jobs

Generation is async – enqueue, then poll the job.

Filters

Scope generation per source with SourceFilter.

Errors

Structured error codes and what to do about them.

API reference

Every endpoint, parameter, and example response.

Next Quickstart