FlowDot API Client

@flowdot.ai/api is the official TypeScript API client and shared type definitions for the FlowDot platform. It's used internally by the FlowDot CLI, MCP Server, and Native app — and you can install it directly if you are building your own integration on top of the FlowDot REST API.

Installation

Install via npm:

npm install "@flowdot.ai/api"

Or with yarn / pnpm:

yarn add "@flowdot.ai/api"
pnpm add "@flowdot.ai/api"

Requires Node.js 20 or newer. The package ships as ESM with TypeScript declarations.

Quick Start

Create a client instance with your API token and make your first call:

import { FlowDotApiClient } from '@flowdot.ai/api';

const client = new FlowDotApiClient({
  baseUrl: 'https://flowdot.ai',
  token: process.env.FLOWDOT_TOKEN,
});

// List your workflows
const workflows = await client.listWorkflows();

// Execute a workflow by ID
const run = await client.executeWorkflow(workflows[0].id, {
  inputs: { prompt: 'Hello from the API client' },
});

console.log(run.outputs);

Get an API Token

1. Sign in at flowdot.ai
2. Go to Settings → API Tokens
3. Create a new token with the scopes you need
4. Store it in an environment variable (never commit it to source control)

When to Use This

Install @flowdot.ai/api directly if:

• You're building a custom integration — a Next.js app, a Slack bot, a backend service — that needs to call FlowDot programmatically.
• You want full TypeScript types for every workflow, app, recipe, custom node, and toolkit API response.
• You're writing an internal tool and want the same HTTP layer the official FlowDot CLI uses.

You probably don't need to install this directly if:

• You're using the FlowDot CLI — it already bundles the API client.
• You're using the FlowDot MCP Server — same story, the server depends on this package internally.
• You just want to call FlowDot from an AI assistant — install the MCP Server instead.

Related Documentation