Typescript SDK

The official Alephant TypeScript SDK provides access to the Alephant SaaS API from TypeScript and Node.js applications. It is generated from our OpenAPI specification using Fern.

Installation

Install the SDK via npm, yarn, or pnpm:

$
npm install @alephantai/saas-api

Initialization

Import and initialize the client with your SaaS API base URL and an authentication token. Pass the full value expected by the Authorization header, for example Bearer <token>.

1
import { AlephantSaaSClient } from "@alephantai/saas-api";
2
3
const client = new AlephantSaaSClient({
4
  baseUrl: process.env.ALEPHANT_SAAS_BASE_URL!,
5
  apiKey: `Bearer ${process.env.ALEPHANT_API_TOKEN}`,
6
});

Example Usage

Smoke test

Use the health endpoint to verify that the SDK can reach your configured SaaS API host.

1
const health = await client.system.healthCheck();
2
console.log(health.data);

Listing Workspaces

Retrieve a list of all workspaces your account has access to.

1
async function fetchWorkspaces() {
2
  try {
3
    const response = await client.workspaces.listUsersWorkspaces();
4
    console.log(response);
5
  } catch (error) {
6
    console.error("Failed to fetch workspaces:", error);
7
  }
8
}

Creating an Agent and Virtual Key

You can programmatically provision new AI Agents and their associated Virtual Keys using the SDK.

1
async function createNewAgent() {
2
  const newAgent = await client.agents.createAgent({
3
    name: "Customer Support Bot",
4
    provider: "openai",
5
    model: "gpt-4-turbo",
6
    environment: "production"
7
  });
8
9
  console.log(`Created agent with ID: ${newAgent.id}`);
10
  // A Virtual Key is automatically generated for this agent
11
}

Error Handling

The SDK throws structured errors for non-2xx API responses, allowing you to catch and handle specific failure scenarios (like rate limits or validation errors) programmatically.

Repository

For advanced configurations, types, and source code, refer to the generated SDK package.