superagent-ai / superagent-js

Superagent Javascript SDK

Superagent JavaScript SDK 🥷

The open framework for building AI Assistants

---

Superagent is an open source framework that enables any developer to integrate production ready AI Assistants into any application in a matter of minutes.

---

Installation

Add this dependency to your project's build file:

npm install superagentai-js
# or
yarn add superagentai-js

Usage

import { Superagent, SuperAgentClient } from "superagentai-js";

const client = new SuperAgentClient(token="API_TOKEN")
const agent = await client.agent.create({
    name: "My Agent",
    description: "My Awesome Agent",
    isActive: True,
    llmModel: "GPT_4_1106_PREVIEW",
    promprt: "You are a helpful assistant"
});

output = await client.agent.invoke(agent.data.id, {
    input: "Hi there!",
    enableStreaming: false,
    sessionId: "123",
});

console.log("Received response from superagent", agent.data)

Handling Exceptions

All exceptions thrown by the SDK will sublcass SuperAgentError.

improt { SuperAgentError } from "superagentai-js";

try {
  client.agent.invoke(...)
} catch (err) {
  if (err instanceof SuperAgentError) {
    console.log(err.statusCode);
    console.log(err.message);
  }
}

Acknowledgements

A special thanks to the Fern team for all support with the Superagent libraries and SDKs ❤️.

Beta status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

superagent-js's Issues

Add Typescript support

Summary

Add support for using this library with Typescript.

Error while creating a tool `Cannot read properties of undefined (reading 'status')`

Creating an Tool using the Superagent client returns the following error Cannot read properties of undefined (reading 'status').

Steps to reproduce

1. Create a Superagent client using superagent-js
2. Create a tool using the Superagent client

import { SuperAgentClient } from "superagentai-js"

const client = new SuperAgentClient({
    environment: "https://api.beta.superagent.sh",
    token: process.env.SUPERAGENT_API_TOKEN
})

const {data: tool} = await client.tool.create({
    name: "Browser",
    description: "A portal to the internet, useful for answering questions about websites or urls.",
    type: "BROWSER",
})

Add usage examples

Description

Add usage examples to the README.