@pillar-ai/sdk

Pillar is an open-source product copilot SDK for SaaS and web apps — embed an AI assistant that executes tasks, not just answers questions. GitHub · Docs

What is Pillar?

Pillar is a product copilot for SaaS and web applications. Users say what they want, and Pillar uses your UI to make it happen — navigating pages, pre-filling forms, and calling your APIs.

A CRM user could ask:

"Close the Walmart deal as won in Salesforce and notify implementation"

An analytics user could ask:

"Add a weekly signups chart to my Amplitude dashboard"

Or an HR user:

"How do I change my direct deposit in Rippling?"

Pillar understands the intent, builds a multi-step plan, and executes it client-side with the user's session.

Features

• Task Execution — Navigate pages, pre-fill forms, call APIs on behalf of users
• Multi-Step Plans — Chain actions into workflows for complex tasks
• Context-Aware — Knows current page, user state, and selected text
• Knowledge Sync — Trained on your docs, Zendesk, Intercom, and more
• Custom Action Cards — Render interactive UI for confirmations and data input
• Framework Bindings — First-class support for React, Vue, and Svelte

Why Pillar?

• Runs client-side with the user's session — no proxy servers, no token forwarding
• One npm install, define your actions, and you're live
• Syncs with your docs for grounded, accurate answers

Documentation

View Full Documentation | Getting Started | API Reference

Installation

npm install @pillar-ai/sdk
# or
pnpm add @pillar-ai/sdk
# or
yarn add @pillar-ai/sdk

Quick Start

1. Get Your Product Key

⚠️ Beta Onboarding: Cloud access is currently manual while we learn from early teams. Join the waitlist at trypillar.com, and we will reach out to onboard you.

By default, you'll get an engineer from Pillar to help with setup. If you prefer onboarding without engineering support, include that in your waitlist request and we will support that too.

2. Initialize the SDK

import { Pillar } from "@pillar-ai/sdk";

// Initialize and get the instance
const pillar = await Pillar.init({
  productKey: "your-product-key", // Provided during onboarding
});

// Now you can use instance methods
pillar.setContext({ currentPage: "/dashboard" });
pillar.open();

You can also get the instance later using Pillar.getInstance():

// Anywhere in your app after init
const pillar = Pillar.getInstance();
pillar?.setContext({ currentPage: "/settings" });

Defining Actions

Define what your co-pilot can do. When users make requests, Pillar matches intent to actions and executes them.

Register Task Handlers

Use onTask to handle actions when the AI executes them:

const pillar = await Pillar.init({
  productKey: "your-product-key",
});

// Handle navigation
pillar.onTask("go_to_settings", (data) => {
  router.push("/settings");
});

// Handle triggers
pillar.onTask("export_to_csv", async (data) => {
  await downloadCSV();
});

// Handle actions with data
pillar.onTask("update_preferences", (data) => {
  updateUserPreferences(data.emailAlerts, data.frequency);
});

Code-First Action Definitions

For production, define tools in code and sync them via the pillar-sync CLI during CI/CD. See Setting Up Tools for details.

Configuration

const pillar = await Pillar.init({
  productKey: "your-product-key",

  panel: {
    position: "right", // 'left' | 'right'
    mode: "push", // 'overlay' | 'push'
  },

  edgeTrigger: {
    enabled: true, // Set to false to use your own button
  },

  theme: {
    mode: "auto", // 'light' | 'dark' | 'auto'
    colors: {
      primary: "#6366f1",
    },
  },
});

API Reference

| Method | Description | |--------|-------------| | Pillar.init(config) | Initialize the SDK, returns the instance | | Pillar.getInstance() | Get the initialized SDK instance | | pillar.open() | Open the co-pilot panel | | pillar.close() | Close the co-pilot panel | | pillar.toggle() | Toggle the co-pilot panel | | pillar.setContext(context) | Update the user/product context | | pillar.on(event, callback) | Subscribe to SDK events |

Note: Pillar.init() and Pillar.getInstance() are static methods on the class. All other methods (lowercase pillar) are instance methods - call them on the instance returned from init() or getInstance().

For complete API documentation, see the API Reference.

Framework Integrations

For idiomatic integration with your framework, use our framework-specific packages:

| Framework | Package | Installation | |-----------|---------|--------------| | React | @pillar-ai/react | npm install @pillar-ai/react | | Vue | @pillar-ai/vue | npm install @pillar-ai/vue | | Svelte | @pillar-ai/svelte | npm install @pillar-ai/svelte |

License

MIT