Skip to main content

ActionFlows

List and get ActionFlow metadata with the TypeScript SDK. The SDK does not return the graph. To execute a flow, start a run.

ActionFlows

Discover ActionFlows you already designed in the app. The SDK returns metadata only (id, name, slug, active, organization). It does not create, update, or delete flows, and it does not return nodes or edges.

To execute a flow, use Runs (runActionFlow).

import { ActionFlows } from "actionflows";

const client = new ActionFlows({
  apiKey: process.env.ACTIONFLOWS_API_KEY!,
});

See Installation for install and auth.

List flows

const flows = await client.listActionFlows();

const orgFlows = await client.listActionFlows({
  organizationId: "org_123",
});
ParamTypeDescription
organizationIdstringOptional. Limit the list to one organization

Each item includes id, name, organizationId, active, slug, public, template, and timestamps.

Get one flow

const flow = await client.getActionFlow("flow_456");
console.log(flow.name, flow.active, flow.organizationId);

AI models

There is no client.generateText (or similar) method. Models run inside a flow:

  1. In Actionflow Studio, add a Generate Text, Generate JSON, or Generate Image node and pick the model.
  2. Call runActionFlow for that flow.
  3. Read the model output from getRun.

Provider keys and cost stay on the organization. See AI Vendors and AI Model Selection Guide.

On this page