PlebAI-SDK

A TS/JS wrapper for communicating with plebAI agents through nostr.

Depends on the @nostr-tools package.

This package is a work-in-progress and its API might still change over time.

Link to NPM package registry: https://www.npmjs.com/package/plebai-sdk

Usage

import { Conversation } from "plebai-sdk";

// Instantiate a Conversation, passing the agents Publickey, a list of relays that you want to use for communication, and a config object.
const conv = new Conversation('<Agent PublicKey>', ['<List of Relays>'], {
  secretKeyMethod: 'nip07',
});

// create a subscription to receive all messages that are sent between you and the agent
// Expects two callbacks: one for incoming messages, one for incoming payment requests
// Invoice callback can be omitted when using webLN
conv.sub(
  (event, message) => {
    console.log(event);
    console.log(message);
  },
  (invoice) => {
    console.log(invoice);
  },
);

// send a prompt to the agent
conv.sendPrompt('Write a text about artificial intelligence');

Config Object

useWebLN: Boolean wether WebLN should be used automatically to pay invoices. (Defaults to false)
secretKeyMethod (Defaults to throwaway)
- nip07: Attempt to call a nip07 provider.
- throwaway: create a new key for the conversation and save it in memory
- localstorage: look for a private key in localstorage, if there is none create it
providerHost: Hostname of plebai provider. (Defaults to https://plebai.com)

type ConversationConfig = {
  useWebLn: boolean;
  secretKeyMethod: 'nip07' | 'throwaway' | 'localstorage';
  providerHost: string;
};

License

Distributed under the MIT License.