@aurora-interactive/chatbot-api-sdk

API Schema Reference

Summary

Aurora AI Chat REST API: REST API used in storing and executing AI chat completions in a personalized and conversational manner. It comes with support for streaming chat responses.

Table of Contents

• SDK Installation
• Requirements
• SDK Example Usage
• Available Resources and Operations
• Standalone functions
• Server-sent event streaming
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Debugging

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add <UNSET>

PNPM

pnpm add <UNSET>

Bun

bun add <UNSET>

Yarn

yarn add <UNSET> zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import() to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example 1

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK();

async function run() {
    const result = await auroraChatbotSDK.users.login();

    // Handle the result
    console.log(result);
}

run();

Example 2

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK();

async function run() {
    const result = await auroraChatbotSDK.users.getInfo();

    // Handle the result
    console.log(result);
}

run();

Example 3

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK();

async function run() {
    const result = await auroraChatbotSDK.users.setInfo("<value>", "<value>", "<value>");

    // Handle the result
    console.log(result);
}

run();

Example 4

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK();

async function run() {
    const result = await auroraChatbotSDK.characters.list(25, 150);

    // Handle the result
    console.log(result);
}

run();

Example 5

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK();

async function run() {
    const result = await auroraChatbotSDK.characters.create({
        name: "<value>",
        description: "Multi-tiered human-resource model",
        aiPrompt: "<value>",
        initialResponse: "<value>",
        banner: "AAAAbx",
        icon: "AAAAbx",
        specialMessages: [
            {
                startsWith: "<value>",
                endsWith: ["<value>"],
                prompt: "<value>",
            },
        ],
    });

    // Handle the result
    console.log(result);
}

run();

Example 6

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK();

async function run() {
    const result = await auroraChatbotSDK.chats.list();

    // Handle the result
    console.log(result);
}

run();

Example 7

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK();

async function run() {
    const result = await auroraChatbotSDK.chats.initialize(330905);

    // Handle the result
    console.log(result);
}

run();

Example 8

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK();

async function run() {
    const result = await auroraChatbotSDK.chats.delete(8);

    // Handle the result
    console.log(result);
}

run();

Example 9

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK();

async function run() {
    const result = await auroraChatbotSDK.messages.save("system", "<value>", 25408, 337);

    // Handle the result
    console.log(result);
}

run();

Example 10

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK();

async function run() {
    const result = await auroraChatbotSDK.messages.getMany(8, 10, 150);

    // Handle the result
    console.log(result);
}

run();

Example 11

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK();

async function run() {
    const result = await auroraChatbotSDK.messages.send(516969, 157994, "<value>");

    for await (const event of result) {
        // Handle the event
        console.log(event);
    }
}

run();

Available Resources and Operations

users

• login - Login
• getInfo - Get User Info
• setInfo - Update account information
• quota - Quota and plan info
• signup - User signup

characters

• list - Character metadata
• get - Get information about a character
• create - Create character

chats

• list - Get all chats assigned to a user
• preview - Get the latest message from the given chat
• initialize - Initialize chat with AI character
• delete - Delete a chat

messages

• save - Save chat message
• getMany - Get a certain number of messages from the message history, up to 100 per request.
• send - Send message
• delete - Delete message

Error Handling

All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

| Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | / |

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";
import { SDKValidationError } from "@aurora-interactive/chatbot-api-sdk/models/errors";

const auroraChatbotSDK = new AuroraChatbotSDK();

async function run() {
    let result;
    try {
        result = await auroraChatbotSDK.users.login();
    } catch (err) {
        switch (true) {
            case err instanceof SDKValidationError: {
                // Validation errors can be pretty-printed
                console.error(err.pretty());
                // Raw value may also be inspected
                console.error(err.rawValue);
                return;
            }
            default: {
                throw err;
            }
        }
    }

    // Handle the result
    console.log(result);
}

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server | Variables | | - | ------ | --------- | | 0 | https://chat-api.aurora-interactive.online:8443 | None |

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK({
    serverIdx: 0,
});

async function run() {
    const result = await auroraChatbotSDK.users.login();

    // Handle the result
    console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL optional parameter when initializing the SDK client instance. For example:

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK({
    serverURL: "https://chat-api.aurora-interactive.online:8443",
});

async function run() {
    const result = await auroraChatbotSDK.users.login();

    // Handle the result
    console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";
import { HTTPClient } from "@aurora-interactive/chatbot-api-sdk/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new AuroraChatbotSDK({ httpClient });

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• charactersCreate
• charactersGet
• charactersList
• chatsDelete
• chatsInitialize
• chatsList
• chatsPreview
• messagesDelete
• messagesGetMany
• messagesSave
• messagesSend
• usersGetInfo
• usersLogin
• usersQuota
• usersSetInfo
• usersSignup

Server-sent event streaming

Server-sent events are used to stream content from certain operations. These operations will expose the stream as an async iterable that can be consumed using a for await...of loop. The loop will terminate when the server no longer has any events to send and closes the underlying connection.

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK();

async function run() {
    const result = await auroraChatbotSDK.messages.send(516969, 157994, "<value>");

    for await (const event of result) {
        // Handle the event
        console.log(event);
    }
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK();

async function run() {
    const result = await auroraChatbotSDK.users.login({
        retries: {
            strategy: "backoff",
            backoff: {
                initialInterval: 1,
                maxInterval: 50,
                exponent: 1.1,
                maxElapsedTime: 100,
            },
            retryConnectionErrors: false,
        },
    });

    // Handle the result
    console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const auroraChatbotSDK = new AuroraChatbotSDK({
    retryConfig: {
        strategy: "backoff",
        backoff: {
            initialInterval: 1,
            maxInterval: 50,
            exponent: 1.1,
            maxElapsedTime: 100,
        },
        retryConnectionErrors: false,
    },
});

async function run() {
    const result = await auroraChatbotSDK.users.login();

    // Handle the result
    console.log(result);
}

run();

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { AuroraChatbotSDK } from "@aurora-interactive/chatbot-api-sdk";

const sdk = new AuroraChatbotSDK({ debugLogger: console });

Development

Getting Character Images

Banner and icon (pfp-style) images for each character are stored on an S3 server instance that isn't tied to the API, thus querying for these images is not included in this SDK. To get the character images, make a GET request to our CDN using the following format: https://ai-chat-cdn.aurora-interactive.online/characters/<characterId>/<(banner | icon).avif>

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy