atoma-sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage atoma-sdk API.

Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

SDK Installation

Tip

To finish publishing your SDK to npm and others you must run your first generation action.

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

NPM

npm add https://github.com/atoma-network/atoma-sdk-typescript.git

PNPM

pnpm add https://github.com/atoma-network/atoma-sdk-typescript.git

Bun

bun add https://github.com/atoma-network/atoma-sdk-typescript.git

Yarn

yarn add https://github.com/atoma-network/atoma-sdk-typescript.git 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 { AtomaSDK } from "atoma-sdk";

const atomaSDK = new AtomaSDK({
  bearerAuth: process.env["ATOMASDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await atomaSDK.chat.create({
    messages: [
      {
        content: "<value>",
        role: "<value>",
      },
    ],
    model: "LeBaron",
  });

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

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`bearerAuth`	http	HTTP Bearer	`ATOMASDK_BEARER_AUTH`

To authenticate with the API the bearerAuth parameter must be set when initializing the SDK client instance. For example:

import { AtomaSDK } from "atoma-sdk";

const atomaSDK = new AtomaSDK({
  bearerAuth: process.env["ATOMASDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await atomaSDK.chat.create({
    messages: [
      {
        content: "<value>",
        role: "<value>",
      },
    ],
    model: "LeBaron",
  });

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

run();

Available Resources and Operations

Available methods

chat

create - Create chat completion
createStream

confidentialChat

create - Create confidential chat completion
createStream

confidentialEmbeddings

create - Create confidential embeddings

confidentialImages

generate - Create confidential image

embeddings

create - Create embeddings

health

health - Health

images

generate - Create image

models

modelsList - List models

nodes

nodesCreate - Create node
nodesCreateLock - Create a node lock for confidential compute

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.

Available standalone functions

chatCreate - Create chat completion
chatCreateStream
confidentialChatCreate - Create confidential chat completion
confidentialChatCreateStream
confidentialEmbeddingsCreate - Create confidential embeddings
confidentialImagesGenerate - Create confidential image
embeddingsCreate - Create embeddings
healthHealth - Health
imagesGenerate - Create image
modelsModelsList - List models
nodesNodesCreate - Create node
nodesNodesCreateLock - Create a node lock for confidential compute

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 { AtomaSDK } from "atoma-sdk";

const atomaSDK = new AtomaSDK({
  bearerAuth: process.env["ATOMASDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await atomaSDK.chat.createStream({
    messages: [
      {
        content: "<value>",
        role: "<value>",
      },
    ],
    model: "Impala",
  });

  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 { AtomaSDK } from "atoma-sdk";

const atomaSDK = new AtomaSDK({
  bearerAuth: process.env["ATOMASDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await atomaSDK.chat.create({
    messages: [
      {
        content: "<value>",
        role: "<value>",
      },
    ],
    model: "LeBaron",
  }, {
    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 { AtomaSDK } from "atoma-sdk";

const atomaSDK = new AtomaSDK({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearerAuth: process.env["ATOMASDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await atomaSDK.chat.create({
    messages: [
      {
        content: "<value>",
        role: "<value>",
      },
    ],
    model: "LeBaron",
  });

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

run();

Error Handling

If the request fails due to, for example 4XX or 5XX status codes, it will throw a APIError.

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

import { AtomaSDK } from "atoma-sdk";
import { SDKValidationError } from "atoma-sdk/models/errors";

const atomaSDK = new AtomaSDK({
  bearerAuth: process.env["ATOMASDK_BEARER_AUTH"] ?? "",
});

async function run() {
  let result;
  try {
    result = await atomaSDK.chat.create({
      messages: [
        {
          content: "<value>",
          role: "<value>",
        },
      ],
      model: "LeBaron",
    });

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError):
        {
          // Pretty-print will provide a human-readable multi-line error message
          console.error(err.pretty());
          // Raw value may also be inspected
          console.error(err.rawValue);
          return;
        }
        apierror.js;
      // Server returned an error status code or an unknown content type
      case (err instanceof APIError): {
        console.error(err.statusCode);
        console.error(err.rawResponse.body);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        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 multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in 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

Server Selection

Override Server URL Per-Client

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

import { AtomaSDK } from "atoma-sdk";

const atomaSDK = new AtomaSDK({
  serverURL: "https://api.atoma.network",
  bearerAuth: process.env["ATOMASDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await atomaSDK.chat.create({
    messages: [
      {
        content: "<value>",
        role: "<value>",
      },
    ],
    model: "LeBaron",
  });

  // 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 { AtomaSDK } from "atoma-sdk";
import { HTTPClient } from "atoma-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 AtomaSDK({ httpClient });

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 { AtomaSDK } from "atoma-sdk";

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

You can also enable a default debug logger by setting an environment variable ATOMASDK_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.

Name		Name	Last commit message	Last commit date
Latest commit History 14 Commits
.devcontainer		.devcontainer
.speakeasy		.speakeasy
docs		docs
src		src
tests/integration		tests/integration
.env.example		.env.example
.eslintrc.cjs		.eslintrc.cjs
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
CONTRIBUTING.md		CONTRIBUTING.md
FUNCTIONS.md		FUNCTIONS.md
LICENSE		LICENSE
README.md		README.md
RUNTIMES.md		RUNTIMES.md
USAGE.md		USAGE.md
codeSamples.yaml		codeSamples.yaml
jest.config.js		jest.config.js
jsr.json		jsr.json
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

License

atoma-network/atoma-sdk-typescript

Folders and files

Latest commit

History

Repository files navigation