@flowdot/api

Shared FlowDot API client and type definitions used by both the FlowDot CLI and MCP Server.

Installation

npm install @flowdot/api

Usage

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

const client = new FlowDotApiClient('https://flowdot.ai', 'your-token');

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

// Execute a workflow
const result = await client.executeWorkflow('workflow-id', { input: 'value' });

API Reference

The FlowDotApiClient class provides methods for interacting with the FlowDot Hub API:

Workflows

• listWorkflows() - List all workflows
• getWorkflow(id) - Get workflow details
• executeWorkflow(id, inputs) - Execute a workflow
• createWorkflow(name, description) - Create a new workflow
• deleteWorkflow(id) - Delete a workflow
• duplicateWorkflow(id, name) - Duplicate a workflow

Executions

• getExecution(id) - Get execution status
• cancelExecution(id) - Cancel a running execution
• retryExecution(id) - Retry a failed execution

Apps

• listApps() - List all apps
• getApp(id) - Get app details
• createApp(input) - Create a new app
• updateApp(id, updates) - Update an app
• deleteApp(id) - Delete an app

Custom Nodes

• listCustomNodes() - List custom nodes
• getCustomNode(id) - Get custom node details
• createCustomNode(input) - Create a custom node
• updateCustomNode(id, updates) - Update a custom node
• deleteCustomNode(id) - Delete a custom node

Knowledge Base

• listKnowledgeCategories() - List categories
• listKnowledgeDocuments() - List documents
• queryKnowledgeBase(input) - Query with RAG
• uploadTextDocument(input) - Upload text content

Agent Toolkits

• listAgentToolkits() - List toolkits
• getAgentToolkit(id) - Get toolkit details
• invokeToolkitTool(input) - Invoke a toolkit tool

Agent Recipes

• listRecipes() - List recipes
• getRecipe(hash) - Get recipe details
• createRecipe(input) - Create a recipe
• forkRecipe(hash, name) - Fork a recipe

Goals

• listGoals(status?) - List goals, optionally filtered by status
• createGoal(input) - Create a goal (name, description, priority, allowed_actions)
• getGoal(hash) - Get goal details
• updateGoal(hash, input) - Update a goal
• deleteGoal(hash) - Delete a goal
• pauseGoal(hash) / resumeGoal(hash) - Pause or resume a goal
• completeGoal(hash) / abandonGoal(hash) - Transition goal status
• listGoalTasks(goalHash, status?) - List tasks for a goal
• addGoalTask(goalHash, input) - Add a task (title, task_type, scheduled_for)
• deleteGoalTask(goalHash, taskId) - Delete a task
• listGoalMilestones(goalHash) - List milestones
• addGoalMilestone(goalHash, input) - Add a milestone (title, target_date)
• completeGoalMilestone(goalHash, milestoneId) - Complete a milestone
• deleteGoalMilestone(goalHash, milestoneId) - Delete a milestone

See the TypeScript type definitions for complete API documentation.