4.7k

Reference

REST API

Everything you can do from the Fimaflow UI — managing workflows, projects, workspaces, exports — is also available as a REST API, with a live, interactive reference.

Demo placeholderThe interactive Scalar API reference

Why a full REST API exists

The dashboard is one client of this API, not a privileged one — every action it performs (listing workflows, triggering a run, pulling an export) goes through the same endpoints documented here. That means anything you can do by hand in the UI, you can script, automate, or build your own tooling on top of, without waiting for a dedicated integration to be built for it.

Interactive reference

The full, always up-to-date API reference is generated from the same OpenAPI schema the server validates requests against — browse it, try requests directly, and copy working examples:

  • /scalar — interactive reference (Scalar)
  • /docs — Swagger UI
  • /openapi.json — the raw OpenAPI 3.0 spec

Authentication

Requests are authenticated with your Fimaflow session — sign in once, and the API accepts the same credentials as the dashboard. On the Starter plan and above, REST API access is available for server-to-server use outside the browser.

Example: listing your workflows

Shell
curl https://api.fimaflow.com/api/workflows \
  -H "Cookie: better-auth.session_token=..."

Returns the same list of workflows — id, name, status, timestamps — that powers your dashboard.

Interactions with the rest of the platform

  • • Both the CLI and the SDK are thin wrappers around this same API — reach for one of those instead of raw HTTP calls unless you have a specific reason to call the API directly.
  • • Error responses follow the shape documented in Error Codes.

Next steps

REST API Reference | Fimaflow