Skip to content

aeriox/sdk-typescript

BranchesTags

Repository files navigation

@aeriox-co/api

TypeScript SDK for the AERIOX Studio public API.

Auto-generated from the OpenAPI 3.1 spec via Speakeasy.

Install

npm install @aeriox-co/api

Usage

import { Aeriox } from "@aeriox-co/api";

const sdk = new Aeriox({
  apiKey: process.env.AERIOX_API_KEY,
});

const { value } = await sdk.openapi.getOpenApiSpec();
console.log(value);

Authentication

Two auth methods are supported:

Development

This SDK is auto-regenerated by .github/workflows/sdk-generation.yml whenever the OpenAPI spec at https://api.aeriox.co/openapi.json changes (and on a weekly Monday schedule). Manual runs:

gh workflow run sdk-generation.yml --repo aeriox/sdk-typescript

Releases publish via npm Trusted Publishing on tag push. Tag v1.0.0 to ship the first release.

License

MIT

Summary

AERIOX Studio API: Programmatic access to AERIOX Studio's creative OS. Generate images, videos, voice; train custom characters; apply prism presets; manage wallet balance.

Audience priority: MCP-native agents → indie developers → agencies → enterprise.

Authentication: API keys (Authorization: Bearer sk_live_* or x-api-key: header). OAuth 2.0 PKCE flow available for end-user-facing apps.

Pricing: USD-denominated PAYG wallet. $5 free trial on first key, $5 minimum top-up via Stripe. Every cost-bearing call is atomically reserved against the wallet before dispatch and refunded on provider failure.

Table of Contents

SDK Installation

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

NPM

npm add @aeriox-co/api

PNPM

pnpm add @aeriox-co/api

Bun

bun add @aeriox-co/api

Yarn

yarn add @aeriox-co/api

Note

This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import("@aeriox-co/api") to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Aeriox } from "@aeriox-co/api";

const aeriox = new Aeriox();

async function run() {
  const result = await aeriox.discovery.getOpenApiSpec();

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name Type Scheme
apiKey http HTTP Bearer
apiKeyHeader apiKey API key

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import { Aeriox } from "@aeriox-co/api";

const aeriox = new Aeriox({
  security: {
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
  },
});

async function run() {
  const result = await aeriox.discovery.getOpenApiSpec();

  console.log(result);
}

run();

Available Resources and Operations

Available methods

APIKeys

  • getMe - Get current API key + workspace
  • rotateApiKey - Rotate an API key
  • oauthAuthorize - Begin OAuth 2.0 PKCE authorization
  • oauthToken - Exchange authorization code or refresh token for an access token
  • oauthRevoke - Revoke an OAuth access or refresh token
  • oauthJwks - JSON Web Key Set for OAuth access token verification

Characters

Discovery

Generation

Jobs

  • getGeneration - (Deprecated) Poll generation status ⚠️ Deprecated
  • getJob - Poll unified job status
  • cancelJob - Cancel a queued or running job

Prisms

Wallet

  • getWallet - Get wallet balance and recent transactions
  • topUpWallet - Create a Stripe PaymentIntent to credit the wallet
  • configureAutoRecharge - Configure or clear wallet auto-recharge
  • getCredits - (Deprecated) Get legacy credit balance ⚠️ Deprecated

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

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 { Aeriox } from "@aeriox-co/api";

const aeriox = new Aeriox();

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

  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 { Aeriox } from "@aeriox-co/api";

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

async function run() {
  const result = await aeriox.discovery.getOpenApiSpec();

  console.log(result);
}

run();

Error Handling

AerioxError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
error.message string Error message
error.statusCode number HTTP response status code eg 404
error.headers Headers HTTP response headers
error.body string HTTP body. Can be empty string if no body is returned.
error.rawResponse Response Raw HTTP response
error.data$ Optional. Some errors may contain structured data. See Error Classes.

Example

import { Aeriox } from "@aeriox-co/api";
import * as errors from "@aeriox-co/api/models/errors";

const aeriox = new Aeriox();

async function run() {
  try {
    const result = await aeriox.discovery.getPricing();

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.AerioxError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorT) {
        console.log(error.data$.error); // models.ErrorT
      }
    }
  }
}

run();

Error Classes

Primary errors:

  • AerioxError: The base class for HTTP error responses.
    • ErrorT: Missing or invalid API key. *
Less common errors (6)

Network errors:

Inherit from AerioxError:

  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number 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 Description
0 https://api.aeriox.co Production
1 https://api-staging.aeriox.co Staging (preview deploys)

Example

import { Aeriox } from "@aeriox-co/api";

const aeriox = new Aeriox({
  serverIdx: 0,
});

async function run() {
  const result = await aeriox.discovery.getOpenApiSpec();

  console.log(result);
}

run();

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 { Aeriox } from "@aeriox-co/api";

const aeriox = new Aeriox({
  serverURL: "https://api-staging.aeriox.co",
});

async function run() {
  const result = await aeriox.discovery.getOpenApiSpec();

  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:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { Aeriox } from "@aeriox-co/api";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@aeriox-co/api/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

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 Aeriox({ httpClient: 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 { Aeriox } from "@aeriox-co/api";

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

About

AERIOX Studio TypeScript SDK — generated from OpenAPI 3.1 spec via Speakeasy. Published to npm as @aeriox-co/api.

Resources

Readme

Contributing

Contributing
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

1 tags

Packages

 
 
 

Contributors

Languages