Flowral

Flowral Flows API

Projects, and everything that operates on a whole one.

GitHub OpenAPI

Operations 14

GET /v1/flows List flows #
POST /v1/flows Create a flow #
GET /v1/flows/{flowId} Get a flow #
PATCH /v1/flows/{flowId} Update a flow #
DELETE /v1/flows/{flowId} Archive a flow #
POST /v1/flows/{flowId}/restore Restore an archived flow #
GET /v1/flows/{flowId}/schedule Get the schedule #
GET /v1/flows/{flowId}/report Get the delivery report #
POST /v1/flows/{flowId}/exports Export a flow #
GET /v1/flows/{flowId}/shares List a flow's guests #
POST /v1/flows/{flowId}/shares Share a flow with a guest #
POST /v1/flows/{flowId}/publish Publish a flow #
DELETE /v1/flows/{flowId}/publish Un-publish a flow #
DELETE /v1/flows/{flowId}/shares/{shareId} Remove a guest from a flow #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/flowral-app/openapi/flowral-app-flows-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/flowral-app/json-schema/flowral-app-task-schema.json
📊
JSONSchema
https://artifacts.apis.io/flowral-app/json-schema/flowral-app-report-schema.json
📊
JSONSchema
https://artifacts.apis.io/flowral-app/json-schema/flowral-app-flow-summary-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/flowral-app:flowral-app-flows-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

flowral-app-flows-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Flowral Flows API
  version: 1.0.0
  summary: Client projects as dependency graphs — over HTTP.
  description: 'The Flowral public API: flows, the tasks in them, and the derived state that

    makes a dependency planner useful — what is ready, what is blocked, and when a

    project actually lands.


    **Authentication.** Every request carries a credential created in the app under

    **API & AI**. Either send an API key as a bearer token, or exchange a client id

    and secret for a short-lived token at `POST /v1/oauth/token`. A credential

    belongs to a workspace and carries its own role: it can never do more than that

    role allows, and it cannot move between workspaces.


    **Errors** are `{ "error": { "code", "message" } }`. Switch on `code`; the

    message is for humans and may change.


    **Lists** are `{ "total", "items" }` and take `size` and `from`.


    **Rate limit** 120 requests/minute per credential, burst 240. Exceeding it

    returns `429` with `Retry-After`.


    **Stability.** This is v1. Fields get added; nothing that exists is removed or

    repurposed without a new major version. The platform API the web app uses is a

    different, unversioned surface — it is not this, and it will change without

    notice.'
  contact:
    name: Flowral
    email: hello@flowral.app
    url: https://flowral.app/api
  license:
    name: Proprietary
    url: https://flowral.app/terms
servers:
- url: https://api.flowral.app
  description: Production
security:
- apiKey: []
- oauth2: []
tags:


# --- truncated at 32 KB (43 KB total) ---
# Full source: https://artifacts.apis.io/flowral-app/openapi/flowral-app-flows-api-openapi.yml