Concatflow client

The server-side client from @concatflow/node. Node 18 or later, no dependencies.

npm install @concatflow/node

import { Concatflow } from "@concatflow/node";

const concatflow = new Concatflow({ apiKey: process.env.CONCATFLOW_API_KEY! });

Create one client and reuse it. It holds no connection and no state besides its key.

Constructor

apiKey · string · required

Your secret API key, lyra_sk_…. See Where to find your identifiers.

baseUrl · string · default: "https://app.concatflow.com"

The Concatflow API origin. A trailing / is removed.

The constructor throws an Error:

• if apiKey does not start with lyra_sk_;
• if it runs in a browser (a global window exists). Your key would be sent to every visitor.

Resources

Method	Does
sessions.create()	Opens a session for one customer.
conversations.list()	Reads a customer’s conversation.
conversations.erase()	Erases a customer’s conversation.

Every method returns a promise. A non-2xx answer rejects with a ConcatflowError.

Runtime

• Uses the global fetch of Node 18 and later.
• ESM only: import, not require.
• Your key is sent as Authorization: Bearer lyra_sk_…. It never appears in error messages.

Exports

import {
  Concatflow,
  ConcatflowError,
  DEFAULT_BASE_URL, // "https://app.concatflow.com"
  encodePartition,
} from "@concatflow/node";

import type {
  ConcatflowConfig,
  Partitions,
  Session,
  Thread,
  ThreadMessage,
  ThreadBlock,
  ConversationParams,
} from "@concatflow/node";

encodePartition({ customer_id: "4712", region: "eu" }) returns "customer_id=4712,region=eu", the form the HTTP API expects.