Skip to main content

​
System requirements

Before installing the SDK, ensure your environment meets these requirements:

Node.jsVersion 18 or higher

TypeScriptVersion 5.0+ recommended (optional)
While TypeScript is recommended for the best developer experience, the SDK works perfectly with plain JavaScript.

​
Install the SDK

Choose your preferred package manager to install @avala-ai/sdk: 
npm install @avala-ai/sdk

​
Verify installation

Once installed, verify that the SDK is working by importing it: 
import Avala from "@avala-ai/sdk";

console.log("Avala SDK imported successfully!");
The SDK supports both ESM (import) and CommonJS (require) module systems, so you can use whichever your project prefers.

​
Module formats

The SDK ships with multiple build formats to ensure compatibility:
FormatEntry PointUse Case
ESMdist/index.jsModern Node.js projects using import
CommonJSdist/index.cjsLegacy Node.js projects using require
TypeScriptdist/index.d.tsType definitions for TypeScript projects
Your bundler or Node.js runtime will automatically select the correct format based on your project configuration.

​
TypeScript configuration

If you’re using TypeScript, ensure your tsconfig.json includes these recommended settings:
tsconfig.json
{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  }
}
The SDK includes complete TypeScript type definitions, providing full IntelliSense support in VS Code and other editors.

​
Next steps

1

Set up authentication

Configure your API key to start making requests. See Authentication.
2

Make your first API call

Follow the Quick start guide to list datasets and create exports.
3

Explore the API

Browse the API Reference to discover all available resources and methods.

Build docs developers (and LLMs) love

Get started for freeTalk to us