Onboarding API Pipeline

Pipeline for managing interactive onboarding sessions with fields and answers.

Interactive Demo

Create sessions and submit answers

Operation

Pipeline ID

Fields (JSON)

Code Example

onboarding-demo.ts

import { OnboardingApiPipeline, Brain, InMemorySessionStore } from "@shivamsharma11/agent-sdk";

const brain = new Brain({
  providers: [new OpenAIProvider({ apiKey: process.env.OPENAI_API_KEY })],
});

const pipeline = new OnboardingApiPipeline({
  brain,
  memory: new InMemorySessionStore(),
});

// Create a session
const session = await pipeline.run({
  operation: "createSession",
  pipelineId: "signup",
  fields: [
    { id: "name", question: "What is your name?" },
    { id: "email", question: "What is your email?" },
  ],
});

// Answer a field
await pipeline.run({
  operation: "answer",
  sessionId: session.id,
  fieldId: "name",
  value: "Alice",
});