@isosceles-ai/sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @isosceles-ai/sdk API.

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

• [ ] 🛠 Make your SDK feel handcrafted by customizing it
• [ ] ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
• [ ] 🎁 Publish your SDK to package managers by configuring automatic publishing
• [ ] ✨ When ready to productionize, delete this section from the README

Summary

Table of Contents

• SDK Installation
• Requirements
• SDK Example Usage
• Available Resources and Operations
• Standalone functions
• File uploads
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Debugging

SDK Installation

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

NPM

npm add @isosceles-ai/sdk

PNPM

pnpm add @isosceles-ai/sdk

Bun

bun add @isosceles-ai/sdk

Yarn

yarn add @isosceles-ai/sdk zod

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

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Isosceles } from "@isosceles-ai/sdk";

const isosceles = new Isosceles({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const result = await isosceles.getOrganisationGetApiKeys();

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

run();

Available Resources and Operations

brain

• createBrain - Create Brain
• getBrains - Get All Brains
• createTextDocument - Create Text Document
• createDocumentWithUrl - Create Document by URL
• updateBrain - Update Brain
• getBrain - Get Brain by ID
• deleteBrain - Delete Brain
• getDocuments - List Documents
• uploadDocument - Upload Document
• searchDocuments - Search documents

chat

• createChatThread - Create New Chat Thread
• listChatThreads - List Chat Threads
• getChatThread - Get Chat Thread
• updateChatThread - Update Chat Thread
• deleteChatThread - Delete Chat Thread
• createChatThreadWithMsg - Create New Chat Thread With Message
• sendChatMessage - Send Chat Message
• getChat - Get Chat Interactions

chatbot

• postChatbotCreate - Create Chatbot
• getChatbotList - List Chatbots
• postChatbotGet - Get Chatbot
• getChatbotAnalytics - Get Chatbot analytics
• getChatbotGetMessages - Get Chatbot messages
• postChatbotUpdate - Update Chatbot
• postChatbotDelete - Delete Chatbot
• postChatbotReset - Reset Token

document

• downloadDocument - Download
• getDocument - Get Document
• deleteDocument - Delete Document
• ~~createDocumentReview~~ - Create document review :warning: Deprecated
• ~~listDocumentReviews~~ - List document reviews :warning: Deprecated

integration

• postIntegrationIntegrationNameConnect - Connect
• postIntegrationIntegrationNameDisconnect - Disconnect
• getIntegrationIntegrationNameList - List
• postIntegrationIntegrationNameAdd - Add To Brain

Isosceles SDK

• getOrganisationGetApiKeys - Get API Keys
• postOrganisationRemoveApiKey - Delete API Key
• addApiKey - Create API Key
• getTenantAdminAnalytics - Get Analytics
• getTenantAdminUsers - Get All Users
• putTenantAdminUsersUserId - Update credits
• getUserMe - Get User details
• putUserMe - Update User

ogranisation

• getOrganisation - get user org

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.

• addApiKey - Create API Key
• brainCreateBrain - Create Brain
• brainCreateDocumentWithUrl - Create Document by URL
• brainCreateTextDocument - Create Text Document
• brainDeleteBrain - Delete Brain
• brainGetBrain - Get Brain by ID
• brainGetBrains - Get All Brains
• brainGetDocuments - List Documents
• brainSearchDocuments - Search documents
• brainUpdateBrain - Update Brain
• brainUploadDocument - Upload Document
• chatbotGetChatbotAnalytics - Get Chatbot analytics
• chatbotGetChatbotGetMessages - Get Chatbot messages
• chatbotGetChatbotList - List Chatbots
• chatbotPostChatbotCreate - Create Chatbot
• chatbotPostChatbotDelete - Delete Chatbot
• chatbotPostChatbotGet - Get Chatbot
• chatbotPostChatbotReset - Reset Token
• chatbotPostChatbotUpdate - Update Chatbot
• chatCreateChatThread - Create New Chat Thread
• chatCreateChatThreadWithMsg - Create New Chat Thread With Message
• chatDeleteChatThread - Delete Chat Thread
• chatGetChat - Get Chat Interactions
• chatGetChatThread - Get Chat Thread
• chatListChatThreads - List Chat Threads
• chatSendChatMessage - Send Chat Message
• chatUpdateChatThread - Update Chat Thread
• documentDeleteDocument - Delete Document
• documentDownloadDocument - Download
• documentGetDocument - Get Document
• getOrganisationGetApiKeys - Get API Keys
• getTenantAdminAnalytics - Get Analytics
• getTenantAdminUsers - Get All Users
• getUserMe - Get User details
• integrationGetIntegrationIntegrationNameList - List
• integrationPostIntegrationIntegrationNameAdd - Add To Brain
• integrationPostIntegrationIntegrationNameConnect - Connect
• integrationPostIntegrationIntegrationNameDisconnect - Disconnect
• ogranisationGetOrganisation - get user org
• postOrganisationRemoveApiKey - Delete API Key
• putTenantAdminUsersUserId - Update credits
• putUserMe - Update User
• ~~documentCreateDocumentReview~~ - Create document review :warning: Deprecated
• ~~documentListDocumentReviews~~ - List document reviews :warning: Deprecated

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

• Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
• Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
• Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
• Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { Isosceles } from "@isosceles-ai/sdk";
import { openAsBlob } from "node:fs";

const isosceles = new Isosceles({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const result = await isosceles.brain.uploadDocument({
    brainId: "",
    requestBody: {
      file: await openAsBlob("example.file"),
    },
  });

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

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 { Isosceles } from "@isosceles-ai/sdk";

const isosceles = new Isosceles({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const result = await isosceles.getOrganisationGetApiKeys({
    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 { Isosceles } from "@isosceles-ai/sdk";

const isosceles = new Isosceles({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const result = await isosceles.getOrganisationGetApiKeys();

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

run();

Error Handling

All SDK methods return a response object or throw an error. By default, an API error will throw a errors.SDKError.

If a HTTP request fails, an operation my also throw an error from the models/errors/httpclienterrors.ts module:

| HTTP Client Error | Description | | ---------------------------------------------------- | ---------------------------------------------------- | | RequestAbortedError | HTTP request was aborted by the client | | RequestTimeoutError | HTTP request timed out due to an AbortSignal signal | | ConnectionError | HTTP client was unable to make a request to a server | | InvalidRequestError | Any input used to create a request is invalid | | UnexpectedClientError | Unrecognised or unexpected error |

In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the uploadDocument method may throw the following errors:

| Error Type | Status Code | Content Type | | -------------------------------------- | -------------------------------------- | -------------------------------------- | | errors.UploadDocumentResponseBody | 400 | application/json | | errors.UploadDocumentBrainResponseBody | 500 | application/json | | errors.SDKError | 4XX, 5XX | */* |

import { Isosceles } from "@isosceles-ai/sdk";
import {
  SDKValidationError,
  UploadDocumentBrainResponseBody,
  UploadDocumentResponseBody,
} from "@isosceles-ai/sdk/models/errors";
import { openAsBlob } from "node:fs";

const isosceles = new Isosceles({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  let result;
  try {
    result = await isosceles.brain.uploadDocument({
      brainId: "",
      requestBody: {
        file: await openAsBlob("example.file"),
      },
    });

    // Handle the result
    console.log(result);
  } 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;
      }
      case (err instanceof UploadDocumentResponseBody): {
        // Handle err.data$: UploadDocumentResponseBodyData
        console.error(err);
        return;
      }
      case (err instanceof UploadDocumentBrainResponseBody): {
        // Handle err.data$: UploadDocumentBrainResponseBodyData
        console.error(err);
        return;
      }
      default: {
        throw err;
      }
    }
  }
}

run();

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.

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://api.isosceles.ai | None |

import { Isosceles } from "@isosceles-ai/sdk";

const isosceles = new Isosceles({
  serverIdx: 0,
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const result = await isosceles.getOrganisationGetApiKeys();

  // 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 { Isosceles } from "@isosceles-ai/sdk";

const isosceles = new Isosceles({
  serverURL: "https://api.isosceles.ai",
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const result = await isosceles.getOrganisationGetApiKeys();

  // 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 { Isosceles } from "@isosceles-ai/sdk";
import { HTTPClient } from "@isosceles-ai/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 Isosceles({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | | username password | http | HTTP Basic | ACP_USERNAME ACP_PASSWORD |

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

import { Isosceles } from "@isosceles-ai/sdk";

const isosceles = new Isosceles({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const result = await isosceles.getOrganisationGetApiKeys();

  // 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 { Isosceles } from "@isosceles-ai/sdk";

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

You can also enable a default debug logger by setting an environment variable ACP_DEBUG to true.

Development

Maturity

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

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