@compilot/js-sdk NPM

ComPilot JS SDK

ComPilot JS SDK, use anywhere JS runs.

How to install

npm install @compilot/js-sdk

First steps

Access your ComPilot Application's Settings > API page and get the API key.

How to use

/**
 * Create an API client and authenticate with your API key
 */
const compilotSdk = createSdk({
  apiKey: API_KEY,
});

Self-provided authentication

If you already have your own authentication system, you can create a user session like so:

/*
 * Get access token
 * This has to be done from secured server, to avoid leaking API_KEY
 */
const sessionRes = await compilotSdk.createSession({
  /**
   * The workflow id that this session will be bound to.
   * You can find this id in compilot's dashboard.
   */
  workflowId: WORKFLOW_ID,
  /**
   * The unique identifier to associate this used to.
   * This id is used to differenciate users on ComPilot and will be
   * given back to you on every webhook we send.
   */
  externalUserId: "35194",
});

Please find below an example endpoint using express:

const compilotSdk = createSdk({
  apiKey: API_KEY,
});

app.get('/my-compilot-auth', (req, res) => {
    const userId = req.userId;
    const authSession = await compilotSdk.createSession({
        workflowId: WORKFLOW_ID,
        externalUserId: userId,
    });
    res.json(authSession);
});