What SDKs are available for FlowDot?

FlowDot provides an official MCP server (@flowdot.ai/mcp-server) for integrating with Claude Desktop, Cursor, and other MCP-compatible AI clients. Install it with 'npx @flowdot.ai/mcp-server'.

FlowDot Documentation

Welcome to the FlowDot API documentation. FlowDot is an AI-powered workflow automation platform that lets you build, deploy, and share intelligent automations. This documentation covers everything you need to integrate with FlowDot programmatically.

TL;DR - Quick Summary

FlowDot is an AI workflow automation platform. Here's what you need to know:

What it does: Build, deploy, and share AI-powered workflow automations visually
API Authentication: Use Bearer tokens from Settings → MCP Tokens
Base URL: https://flowdot.ai/api/mcp/v1/
Key Endpoints: List workflows, execute workflows, get execution results
MCP Integration: Install with npx @flowdot.ai/mcp-server
Workflow Execution: POST to /workflows/{hash}/execute with JSON inputs
Response Format: JSON with node outputs, execution status, and metadata
Rate Limits: Based on your subscription tier (Free: 100/day, Pro: 10,000/day)

107

API Endpoints

1

Guides

2

SDKs

9

Error Codes

Quick Start

Get started with FlowDot in minutes:

1. Get Your API Token

Navigate to Settings → MCP Tokens in your FlowDot dashboard to generate an API token.

2. Make Your First Request

Use the token to authenticate API requests:

curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://flowdot.ai/api/mcp/v1/workflows

3. Execute a Workflow

Trigger workflow execution programmatically:

curl -X POST \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"inputs": {"message": "Hello"}}' \
  https://flowdot.ai/api/mcp/v1/workflows/WORKFLOW_HASH/execute

Authentication

All API requests require authentication using a Bearer token. Include your token in the Authorization header:

Authorization: Bearer fd_mcp_xxxxxxxxxxxxx

Tokens can be created and managed in your FlowDot dashboard under Settings → MCP Tokens.

Key Features

FlowDot provides a comprehensive platform for AI workflow automation:

Visual Workflow Builder: Drag-and-drop interface for creating complex automations
50+ Built-in Nodes: LLM, HTTP, conditionals, loops, transformers, and more
Custom Nodes: Write JavaScript to create reusable automation components
Multi-LLM Support: OpenAI, Anthropic, Google, Mistral, and local models
Real-time Execution: Watch workflows run with live node status updates
Version Control: Track changes and rollback to previous workflow versions
Team Collaboration: Share workflows with team members and set permissions
Webhook Triggers: Start workflows from external events
Scheduled Runs: Execute workflows on a recurring schedule
Execution History: Review past runs with full input/output logging

Common Use Cases

FlowDot workflows can automate a wide variety of tasks:

Content Generation: Blog posts, social media content, product descriptions
Data Processing: ETL pipelines, data transformation, API orchestration
Customer Support: Ticket classification, response drafting, knowledge base queries
Research & Analysis: Web scraping, document summarization, competitive analysis
Code Assistance: Code review, documentation generation, test creation
Marketing Automation: Email personalization, ad copy generation, SEO analysis
Document Processing: PDF extraction, invoice parsing, contract analysis
Chatbot Backends: Complex conversation flows with tool use and memory

Getting Help

Resources for learning more and getting support:

Documentation: You're here! Browse guides, API reference, and tutorials
Tutorials: Step-by-step video and written guides at /tutorials
FAQ: Common questions answered at /faqs
GitHub: Report issues and contribute at github.com/flowdot-llc
Twitter: Follow updates at @FlowDot_AI
Email Support: Contact support@flowdot.ai for account issues

API Reference

Complete API documentation with interactive testing is available on the dedicated API Reference page.

Explore the Full API

View all endpoints, test API calls with Swagger UI, and see error code references.

View API Reference →

Frequently Asked Questions

Common questions about using the FlowDot API and platform.

How do I authenticate with the FlowDot API?

All API requests require authentication using a Bearer token. Follow these steps:

Log in to your FlowDot dashboard at flowdot.ai
Navigate to Settings → MCP Tokens
Click "Create New Token" and copy your token
Include the token in your requests: Authorization: Bearer fd_mcp_xxxxxxxxxxxxx

How do I execute a workflow via the API?

To execute a workflow programmatically:

Get your workflow hash from the workflow URL or API list
Send a POST request to /api/mcp/v1/workflows/{WORKFLOW_HASH}/execute
Include your inputs as JSON in the request body
Add your Bearer token in the Authorization header

curl -X POST https://flowdot.ai/api/mcp/v1/workflows/abc123/execute \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"inputs": {"message": "Hello World"}}'

What SDKs and integrations are available?

FlowDot offers several integration options:

MCP Server: Official integration for Claude Desktop, Cursor, and MCP-compatible AI clients
REST API: Direct HTTP API for any programming language
Webhooks: Receive workflow completion notifications
Custom Nodes: Build reusable automation components with JavaScript

Install the MCP server with: npx @flowdot.ai/mcp-server

What are the API rate limits?

Rate limits depend on your subscription tier:

Free tier: 100 API requests per day, 10 workflow executions per day
Pro tier: 10,000 API requests per day, 1,000 workflow executions per day
Enterprise: Custom limits based on your agreement

Rate limit headers are included in API responses: X-RateLimit-Remaining

How do I handle errors in API responses?

FlowDot API uses standard HTTP status codes and JSON error responses:

400 Bad Request: Invalid input parameters or malformed JSON
401 Unauthorized: Missing or invalid Bearer token
403 Forbidden: Insufficient permissions for the resource
404 Not Found: Workflow or resource does not exist
429 Too Many Requests: Rate limit exceeded
500 Internal Error: Server-side error, retry with exponential backoff

All errors include a JSON body with error and message fields.

Can I use FlowDot workflows in my own applications?

Yes! FlowDot is designed for programmatic integration:

Use the REST API to trigger workflows from any backend
Embed workflow execution in web apps, mobile apps, or scripts
Build chatbots and AI agents that leverage your workflows
Create automated pipelines with webhooks and scheduled triggers
Integrate with Zapier, Make, or n8n using HTTP requests

Guides

Step-by-step tutorials to help you get the most out of FlowDot.

CLI Authentication Guide

Learn how to authenticate CLI applications using the device authorization flow.

Intermediate 10 min read

▼

CLI Authentication Guide

The FlowDot CLI uses a secure device authorization flow that doesn't require you to enter your password in the terminal.

How It Works

Initiate: CLI requests an auth token from the server
Browser: User visits the auth URL and logs in
Confirm: User confirms the device authorization
Complete: CLI receives an API token

Implementation

Step 1: Initiate the Flow

const response = await fetch('https://flowdot.ai/api/cli/auth/initiate', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ device_name: 'My CLI App' })
});

const { auth_token, auth_url } = response.data;
console.log(`Please visit: ${auth_url}`);

Step 2: Poll for Completion

async function pollForToken(authToken) {
  while (true) {
    const response = await fetch(
      `https://flowdot.ai/api/cli/auth/verify/${authToken}`
    );
    const { data } = await response.json();

    if (data.status === 'confirmed') {
      return data.api_token;
    }
    if (data.status === 'expired') {
      throw new Error('Auth session expired');
    }

    await new Promise(r => setTimeout(r, 2000));
  }
}

Step 3: Store Token Securely

Use the system keychain (not plain text files):

import keytar from 'keytar';

await keytar.setPassword('flowdot', 'api-token', token);

Security Notes

Auth tokens expire after 15 minutes
API tokens should be stored in the system keychain
Never log or display the full API token

SDKs & Libraries

Official SDKs and community libraries for integrating with FlowDot.

FlowDot CLI

v1.0.0 typescript

▼

Command-line interface for managing and executing FlowDot workflows. Supports authentication, workflow execution, and real-time output streaming.

Installation

## Installation

### npm (recommended)
```bash
npm install -g @flowdot/cli
```

### yarn
```bash
yarn global add @flowdot/cli
```

### From source
```bash
git clone https://github.com/flowdot/cli
cd cli
npm install
npm run build
npm link
```

Quick Start

1. Authenticate

flowdot auth login

This opens your browser for secure authentication.

2. List your workflows

flowdot workflows list

3. Run a workflow

flowdot run <workflow-hash>

4. Run with inputs

flowdot run wf_abc123 --input document_url="https://example.com/doc.pdf"

5. Interactive agent mode

flowdot agent

Features

Secure keychain-based authentication
Real-time execution streaming
Interactive agent mode
Workflow management
JSON output for scripting

GitHub → Package →

Mobile SDK

v1.0.0 react-native

▼

React Native SDK for building mobile applications with FlowDot workflow integration.

Installation

## Installation

```bash
npm install @flowdot/mobile-sdk
# or
yarn add @flowdot/mobile-sdk
```

### iOS Setup
```bash
cd ios && pod install
```

### Android Setup
No additional setup required.

Quick Start

import { FlowDotClient } from '@flowdot/mobile-sdk';

// Initialize
const client = new FlowDotClient({
  apiUrl: 'https://flowdot.ai/api',
});

// Authenticate
await client.login(email, password);

// List workflows
const workflows = await client.getWorkflows();

// Execute workflow
const result = await client.executeWorkflow(workflowId, {
  inputs: { message: 'Hello' }
});

Features

Offline request queuing
Automatic retry on network failure
AsyncStorage-based token management
Real-time execution status

Changelog

Recent updates and changes to the FlowDot API.

v1.0.0 Major Release Dec 1, 2024 ▼

Initial Public Release

FlowDot API v1.0.0

We're excited to announce the first public release of the FlowDot API!

Features

Authentication: Bearer token, OAuth (Google/GitHub), CLI device flow
Workflows: Create, edit, execute, and share AI workflows
Async Execution: Long-running workflows with status polling
Teams: Collaboration with team members
Apps: Publish workflow templates

API Highlights

RESTful design with consistent response formats
Comprehensive error codes and messages
Rate limiting with clear headers
OpenAPI specification available

✨ New Endpoints

/api/auth/*
/api/hub/workflows/*
/api/hub/teams/*
/api/hub/apps/*