Skip to main content

​
Build powerful ML annotation workflows

The Avala TypeScript SDK provides a type-safe, intuitive interface to the Avala API. Manage datasets, projects, exports, tasks, and more with full TypeScript support.

Installation

Get started with npm, yarn, or pnpm in seconds

Quick start

Your first API call in under 5 minutes

Authentication

Secure your API requests with API keys

API reference

Explore all available resources and methods

​
Key features

Type-safeFull TypeScript support with complete type definitions

ComprehensiveAccess datasets, projects, exports, tasks, agents, and more

High performanceBuilt for speed with efficient cursor-based pagination

Error handlingStructured error types for robust error management

MCP supportUse with AI assistants via Model Context Protocol

ModernESM and CJS support, Node.js 18+

​
What you can build

Browse, inspect, and manage ML annotation datasets programmatically. List datasets with filters, retrieve detailed metadata, and access dataset items.
Automate project workflows by creating exports, managing tasks, and orchestrating annotation pipelines at scale.
Set up quality targets, compute consensus scores, and track annotation issues to maintain high-quality datasets.
Register agents that respond to annotation events, enabling automated validation, data augmentation, and custom workflows.
Monitor devices, track recordings, create rules, and manage alerts for edge AI deployments.

​
Quick example

Here’s a taste of what working with the Avala SDK looks like: 
import Avala from "@avala-ai/sdk";

const avala = new Avala(); // reads AVALA_API_KEY from env

// List datasets
const datasets = await avala.datasets.list({ limit: 10 });
datasets.items.forEach(d => console.log(d.uid, d.name));

// Create an export
const exp = await avala.exports.create({ project: "project-uid" });
console.log(`Export ${exp.uid} status: ${exp.status}`);
The SDK automatically reads your API key from the AVALA_API_KEY environment variable. See Authentication for more options.

​
Ready to get started?

Install the SDK

Add @avala-ai/sdk to your project

Follow the quick start

Make your first API call

Build docs developers (and LLMs) love

Get started for freeTalk to us