flowcode-sdk v1.0.1

Flowcode SDK

A TypeScript SDK for interacting with Flowcode - the platform that helps you build, deploy, and manage AI workflows with ease. Flowcode allows you to create complex AI flows using a visual interface and then execute them programmatically using this SDK.

Installation

npm install flowcode-sdk
# or
pnpm add flowcode-sdk
# or
yarn add flowcode-sdk

Usage

import Flowcode from "flowcode-sdk";

// Initialize the SDK
const flowcode = new Flowcode({
  apiKey: "your-api-key",
  workspaceId: "your-workspace-id",
  baseUrl: "https://app.getflowcode.io", // optional
});

// Run a flow
const result = await flowcode.run("myFlowName", {
  // optional inputs for your flow
  userName: "John",
  age: 30,
});

console.log(result); // Flow execution result

Configuration

The SDK accepts the following configuration options:

• apiKey (required): Your Flowcode API key
• workspaceId (required): Your Flowcode workspace ID
• baseUrl (optional): Custom API base URL. Defaults to 'https://app.getflowcode.io'
• httpClient (optional): Custom HTTP client implementation

Custom HTTP Client

You can provide your own HTTP client implementation for complete control over the request/response cycle:

class MyCustomClient implements HttpClient {
  async request(req: HttpRequest): Promise<HttpResponse> {
    // Your custom implementation here
    // Use fetch, axios, or any other HTTP client
    const response = await fetch(req.url, {
      method: req.method,
      headers: req.headers,
      body: JSON.stringify(req.body),
    });

    const data = await response.json();
    return {
      data,
      status: response.status,
    };
  }
}

const flowcode = new Flowcode({
  apiKey: "your-api-key",
  workspaceId: "your-workspace-id",
  httpClient: new MyCustomClient(),
});

Response

The run method returns a promise that resolves to the flow execution result directly. The shape of the result depends on your flow's configuration.

Error Handling

The SDK throws errors with descriptive messages when API calls fail. Make sure to wrap your calls in try-catch blocks:

try {
  const result = await flowcode.run("myFlow", { param: "value" });
} catch (error) {
  console.error("Flow execution failed:", error.message);
}

Learn More

Visit Flowcode to learn more about:

• Creating AI workflows visually
• Managing your workspaces and flows
• Monitoring flow executions
• API documentation and best practices