API Overview

Duraflow provides multiple APIs to interact with the workflow engine.

gRPC API (Primary)

The main API for high-performance communication. Use this for:

• Task submission
• Status polling
• Task cancellation
• Step operations (for SDK)

import { AgentServiceClient, credentials } from "@duraflow/proto";

const client = new AgentServiceClient(
  "localhost:50051",
  credentials.createInsecure(),
);

REST API (Coming Soon)

HTTP-based access for web applications and easier integration.

SDK API

The TypeScript SDK provides the easiest way to define workflows.

import { workflow } from "@duraflow/sdk";

const myWorkflow = workflow("my-workflow", async (ctx) => {
  const result = await ctx.step.run("my-step", async () => {
    return { data: "value" };
  });
  return result;
});

step isn't a top-level import - it's ctx.step, handed to you inside the workflow handler.

Port Configuration

Service	Default Port	Environment Variable
gRPC Server	50051	PORT
(REST - Coming Soon)	3000	REST_PORT

Quick Examples

Submit a Task (gRPC)

const response = await client.submitTask({
  workflowName: "my-workflow",
  input: JSON.stringify({ key: "value" }),
});

console.log("Task ID:", response.taskId);

Get Task Status (gRPC)

const status = await client.getTaskStatus({
  taskId: "task-uuid-here",
});

console.log("Status:", status.status); // PENDING, RUNNING, COMPLETED, FAILED, etc.
console.log("Output:", status.output); // Task result (if completed)
console.log("Error:", status.error); // Error details (if failed)

Cancel a Task (gRPC)

const result = await client.cancelTask({
  taskId: "task-uuid-here",
});

console.log("Success:", result.success);

---

See SDK Reference for the full TypeScript API, gRPC Reference for the wire-level spec, or Database Schema for the underlying tables.