canonical: https://jentic.com/apis/flowfast.io/flowfast

# FlowFast API

Jentic publishes the only available OpenAPI specification for FlowFast API, keeping it validated and agent-ready. FlowFast is a process automation platform that lets teams define multi-step flows and run them on demand. The API exposes a small surface for listing flows, triggering executions, and retrieving execution results, with authentication via an Authorization header API key.

## For AI agents

Trigger FlowFast process automations, list available flows, and read back execution status from agent code.

## Scope

Does not handle source control, deployments, or monitoring - use for triggering FlowFast flow executions and reading their results only.

## Capabilities

- List all flows defined in a FlowFast workspace
- Trigger a specific flow execution with input parameters
- Retrieve the status and output of a completed execution
- Wire FlowFast flows into chat agents as a single tool call
- Forward FlowFast execution results back into a downstream system

## Use cases

### Trigger Automations from Agents

Expose FlowFast flows as agent tools by listing them via /flows and triggering them through /executions. This lets an LLM-driven agent run prebuilt automations - for example, an onboarding flow - without the agent having to assemble the underlying steps. Setup is minutes once the API key is wired.

Example prompt: Trigger flow 'send-welcome-email' via POST /executions with input {email: 'user@example.com'} and return the resulting execution ID.

### Flow Discovery for Agents

Pull the catalogue of available flows via GET /flows so an agent can decide which automation matches the user's request. The endpoint returns flow names and IDs that can be passed to /executions. Use this when the set of flows changes over time and you don't want to hardcode IDs.

Example prompt: Call GET /flows and return the names and IDs of all flows whose name contains 'invoice'.

### Execution Result Polling

After triggering a flow, poll GET /executions to read the status and output. Useful when the agent needs the flow's output to continue the conversation, for example confirming a sent email or returning a generated document URL. Each execution has an ID and a terminal state once complete.

Example prompt: Poll GET /executions for execution ID 'exec_42' until status is 'success' or 'failed' and return the output payload.

### AI Agent Integration via Jentic

Agents use Jentic's intent search to locate FlowFast operations, load the schema for /executions, and call it with a scoped credential. This is the recommended path for embedding FlowFast in MCP-based assistants where the agent needs to invoke business automations on behalf of a user. Jentic keeps the API key isolated.

Example prompt: Use Jentic to search 'trigger a FlowFast flow', load the POST /executions schema, and execute the flow chosen by the user with the input values they provided.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/flows` | List all flows in the workspace |
| POST | `/executions` | Trigger a flow execution |
| GET | `/executions` | List or read execution status and output |

## Key resources

- **Flows** — List flows defined in the FlowFast workspace.
- **Executions** — Trigger flow runs and read execution status and output.

## Why Jentic

- **Setup:** Wiring the FlowFast API by hand means setting its Authorization header key on every request and building your own retry and error handling around the flow-execution endpoints. Through Jentic you install once, import FlowFast from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** FlowFast identifies the flow in the request body rather than the URL path, so scoping is operations-only: you limit the agent to the operations it needs, such as listing flows or reading executions, and leave out triggering a new execution unless you add it. Every operation the agent can run is one you chose.
- **Credential handling:** Your FlowFast API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'trigger a FlowFast flow', and Jentic returns the POST /executions operation with its input schema so the agent triggers the right flow without browsing the reference docs.

## Related APIs

- **n8n API** — Open-source workflow automation platform with a much larger surface and self-hosted option.
- **Zapier NLA API** — Hosted automation platform with thousands of app integrations.
- **Pipedream API** — Code-first event workflows that pair with FlowFast for richer scripting needs.

## FAQ

### Why is there no official OpenAPI spec for FlowFast API?

FlowFast does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call FlowFast API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the FlowFast API use?

The FlowFast API uses an API key passed in the Authorization header. Jentic stores the key encrypted in your Jentic One instance and injects it on outbound calls so the agent never holds the raw secret.

### Can I trigger flows on demand with the FlowFast API?

Yes, POST /executions starts a flow with the input you supply. The response includes an execution ID that you then read back via GET /executions for status and output.

### What are the rate limits for the FlowFast API?

The OpenAPI spec does not declare explicit rate limits. Apply client-side throttling for bursty agent traffic and back off on 429 responses returned by the service.

### How do I find the right flow to trigger through Jentic?

Search Jentic for 'list FlowFast flows', load the GET /flows schema, and execute the call. The returned list contains the IDs you pass to POST /executions when triggering the flow.

### Can I limit what my agent is allowed to do with the FlowFast API?

Yes. Because Jentic One runs self-hosted, your own rules decide which FlowFast operations and credentials the agent may use. Since FlowFast names the flow in the request body rather than the URL, scoping is operations-only: you can allow the agent to list flows with GET /flows and read results with GET /executions while withholding POST /executions so it cannot trigger a new run unless you grant it. Every operation the agent can call is one you chose.