Add Flowlib to any Next.js app with a single catch-all API route. Handles all endpoints — flows, executions, credentials, agent tools, and OAuth2.

For production deployments on Vercel, add one dedicated Flowlib cron route as well. That single route runs Flowlib maintenance work for the app: batch polling, paused-flow resumption, stale-run cleanup, and Flowlib cron triggers.

Install

npx flowlib-cli init

Or install manually:

npm install @flowlib/core @flowlib/nextjs

Usage

Create a catch-all route in your Next.js App Router:

// app/api/flowlib/[...flowlib]/route.ts
import { createFlowlibHandler } from '@flowlib/nextjs';

const handler = createFlowlibHandler({
  database: {
    type: 'sqlite',
    connectionString: process.env.DATABASE_URL || 'file:./dev.db',
  },
  encryptionKey: process.env.FLOWLIB_ENCRYPTION_KEY, // npx flowlib-cli secret
});

export const GET = handler.GET;
export const POST = handler.POST;
export const PUT = handler.PUT;
export const PATCH = handler.PATCH;
export const DELETE = handler.DELETE;

All Flowlib API endpoints are now available under /api/flowlib/.

Vercel Cron

Create a dedicated maintenance route for production cron jobs:

// app/api/flowlib/cron/route.ts
import { createFlowlibCronHandler } from '@flowlib/nextjs';

const handleCron = createFlowlibCronHandler({
  database: {
    type: 'sqlite',
    connectionString: process.env.DATABASE_URL || 'file:./dev.db',
  },
  encryptionKey: process.env.FLOWLIB_ENCRYPTION_KEY,
  triggers: {
    cronEnabled: true,
    webhookBaseUrl: 'https://your-app.com/api/flowlib',
  },
});

export const GET = handleCron;

Then configure one Vercel cron in vercel.json:

{
  "crons": [{ "path": "/api/flowlib/cron", "schedule": "* * * * *" }]
}

This single Flowlib cron is the fan-out point for background work in the app.

Frontend

Add the flow editor to any page:

// app/flowlib/[[...slug]]/page.tsx
import { Flowlib } from '@flowlib/ui';
import '@flowlib/ui/styles';

export default function FlowlibPage() {
  return <Flowlib apiBaseUrl="/api/flowlib" basePath="/flowlib" />;
}

License

MIT