> ## Documentation Index
> Fetch the complete documentation index at: https://avala.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# TypeScript SDK

> Полное руководство по Avala TypeScript SDK

## Установка

<CodeGroup>
  ```bash npm theme={null}
  npm install @avala-ai/sdk
  ```

  ```bash yarn theme={null}
  yarn add @avala-ai/sdk
  ```

  ```bash pnpm theme={null}
  pnpm add @avala-ai/sdk
  ```
</CodeGroup>

## Быстрый старт

```typescript theme={null}
import Avala from "@avala-ai/sdk";

const avala = new Avala({ apiKey: "your-api-key" });

const datasets = await avala.datasets.list();
for (const dataset of datasets.items) {
  console.log(dataset.name, dataset.uid);
}
```

## Создание аккаунта

Функция `signup` создаёт новый аккаунт Avala и возвращает API-ключ. Аутентификация не требуется.

```typescript theme={null}
import { signup } from "@avala-ai/sdk";

const result = await signup({
  email: "dev@acme.com",
  password: "SecurePass123!",
  firstName: "Jane",       // optional
  lastName: "Doe",         // optional
});

console.log(`User: ${result.user.email}`);
console.log(`API Key: ${result.apiKey}`);
```

Используйте полученный API-ключ для инициализации клиента:

```typescript theme={null}
import Avala, { signup } from "@avala-ai/sdk";

const { apiKey } = await signup({ email: "dev@acme.com", password: "SecurePass123!" });
const avala = new Avala({ apiKey });
```

## Аутентификация

SDK аутентифицируется с помощью API-ключа Avala, который передаётся через заголовок `X-Avala-Api-Key` в каждом запросе.

Вы можете передать ключ напрямую или позволить SDK прочитать его из переменной окружения.

**Вариант 1: Передача ключа напрямую**

```typescript theme={null}
import Avala from "@avala-ai/sdk";

const avala = new Avala({ apiKey: "your-api-key" });
```

**Вариант 2: Использование переменной окружения**

```bash theme={null}
export AVALA_API_KEY="your-api-key"
```

```typescript theme={null}
import Avala from "@avala-ai/sdk";

// Automatically reads AVALA_API_KEY from the environment
const avala = new Avala();
```

## Работа с наборами данных

<Note>
  TypeScript SDK в настоящее время работает **только на чтение для наборов данных** — вы можете получать списки и просматривать наборы данных, но не создавать, обновлять или удалять их. Для загрузки и мутаций используйте [REST API](/docs/sdks/rest-api#file-uploads).
</Note>

### Список наборов данных

```typescript theme={null}
const datasets = await avala.datasets.list();

for (const dataset of datasets.items) {
  console.log(`${dataset.name} (${dataset.uid})`);
  console.log(`  Items: ${dataset.itemCount}`);
  console.log(`  Created: ${dataset.createdAt}`);
}
```

### Получение набора данных

```typescript theme={null}
const dataset = await avala.datasets.get("550e8400-e29b-41d4-a716-446655440000");

console.log(dataset.name);
console.log(dataset.slug);
console.log(dataset.itemCount);
```

## Работа с проектами

### Список проектов

```typescript theme={null}
const projects = await avala.projects.list();

for (const project of projects.items) {
  console.log(`${project.name} (${project.uid})`);
  console.log(`  Status: ${project.status}`);
  console.log(`  Created: ${project.createdAt}`);
}
```

### Получение проекта

```typescript theme={null}
const project = await avala.projects.get("770a9600-a40d-63f6-c938-668877660000");

console.log(project.name);
console.log(project.status);
```

## Работа с задачами

### Список задач

```typescript theme={null}
const tasks = await avala.tasks.list({
  project: "770a9600-a40d-63f6-c938-668877660000",
  status: "pending",
});

for (const task of tasks.items) {
  console.log(`${task.uid} — ${task.name} (${task.status})`);
}
```

### Получение задачи

```typescript theme={null}
const task = await avala.tasks.get("990c1800-b62f-85a8-e150-880099880000");

console.log(task.name);
console.log(task.status);
```

## Работа с экспортами

### Создание экспорта

```typescript theme={null}
const exportJob = await avala.exports.create({
  project: "770a9600-a40d-63f6-c938-668877660000",
});

console.log(`Export started: ${exportJob.uid}`);
console.log(`Status: ${exportJob.status}`);
```

### Ожидание завершения

```typescript theme={null}
let exportJob = await avala.exports.create({
  project: "770a9600-a40d-63f6-c938-668877660000",
});

while (exportJob.status !== "completed") {
  await new Promise((resolve) => setTimeout(resolve, 2000));
  exportJob = await avala.exports.get(exportJob.uid);
  console.log(`Status: ${exportJob.status}`);
}

console.log(`Download: ${exportJob.downloadUrl}`);
```

## Типы TypeScript

SDK экспортирует полные интерфейсы TypeScript для всех объектов API. Используйте их для типизации ваших функций и переменных.

```typescript theme={null}
import Avala from "@avala-ai/sdk";
import type { Dataset, Project, Export, Task, CursorPage } from "@avala-ai/sdk";

function processDataset(dataset: Dataset): void {
  console.log(dataset.name);       // string
  console.log(dataset.uid);        // string
  console.log(dataset.itemCount);  // number
  console.log(dataset.createdAt);  // string | null
}

function processTask(task: Task): void {
  console.log(task.uid);           // string
  console.log(task.name);          // string | null
  console.log(task.status);        // string | null
  console.log(task.project);       // string | null
}
```

## Обработка ошибок

SDK выбрасывает типизированные ошибки для точной обработки различных типов сбоев.

```typescript theme={null}
import Avala, { AvalaError, NotFoundError, RateLimitError } from "@avala-ai/sdk";

const avala = new Avala();

try {
  const dataset = await avala.datasets.get("nonexistent");
} catch (error) {
  if (error instanceof NotFoundError) {
    console.log(`Dataset not found: ${error.message}`);
  } else if (error instanceof RateLimitError) {
    console.log(`Rate limited. Retry after ${error.retryAfter} seconds.`);
  } else if (error instanceof AvalaError) {
    console.log(`API error (${error.statusCode}): ${error.message}`);
  } else {
    throw error;
  }
}
```

| Исключение            | Описание                                                                |
| --------------------- | ----------------------------------------------------------------------- |
| `AvalaError`          | Базовый класс ошибок для всех ошибок Avala API.                         |
| `AuthenticationError` | Недействительный или отсутствующий API-ключ (HTTP 401).                 |
| `NotFoundError`       | Запрошенный ресурс не существует (HTTP 404).                            |
| `RateLimitError`      | Превышен лимит запросов API (HTTP 429). Содержит свойство `retryAfter`. |
| `ValidationError`     | Тело запроса не прошло валидацию (HTTP 400/422).                        |
| `ServerError`         | Сервер вернул внутреннюю ошибку (HTTP 5xx).                             |

## Пагинация

Методы списков возвращают объект `CursorPage<T>` с курсорной пагинацией.

```typescript theme={null}
// Access items on the current page
const page = await avala.datasets.list({ limit: 10 });
for (const dataset of page.items) {
  console.log(dataset.name);
}

// Fetch the next page
if (page.hasMore) {
  const nextPage = await avala.datasets.list({
    limit: 10,
    cursor: page.nextCursor!,
  });
}
```

## Работа с агентами

### Создание агента

```typescript theme={null}
const agent = await avala.agents.create({
  name: "QA Bot",
  events: ["task.completed"],
  callbackUrl: "https://example.com/webhook",
  taskTypes: ["annotation"],
});
```

### Список выполнений агента

```typescript theme={null}
const executions = await avala.agents.listExecutions(agent.uid);
for (const exec of executions.items) {
  console.log(`${exec.eventType} — ${exec.status}`);
}
```

## Работа с вебхуками

### Создание вебхука

```typescript theme={null}
const webhook = await avala.webhooks.create({
  targetUrl: "https://example.com/webhook",
  events: ["task.completed", "export.ready"],
});
```

### Просмотр доставок

```typescript theme={null}
const deliveries = await avala.webhookDeliveries.list();
for (const d of deliveries.items) {
  console.log(`${d.eventType} — ${d.status} (attempts: ${d.attempts})`);
}
```

## Работа с качеством и консенсусом

### Создание цели качества

```typescript theme={null}
const target = await avala.qualityTargets.create("proj_uid", {
  name: "Accuracy",
  metric: "accuracy",
  operator: "gte",
  threshold: 0.95,
  notifyEmails: ["alerts@example.com"],
});
```

### Проверка консенсуса

```typescript theme={null}
const summary = await avala.consensus.getSummary("proj_uid");
console.log(`Mean score: ${summary.meanScore}`);
console.log(`Coverage: ${summary.itemsWithConsensus}/${summary.totalItems}`);
```

## Управление парком

<Info>
  Управление парком находится в предварительном доступе. Описанные API могут измениться.
</Info>

Пространство имён `fleet` предоставляет доступ к реестру устройств, записям, событиям, правилам и оповещениям.

```typescript theme={null}
// List online devices
const devices = await avala.fleet.devices.list({ status: "online" });

// Create a timeline event on a recording
const event = await avala.fleet.events.create({
  recordingId: "rec_abc123",
  timestamp: "2026-01-15T10:30:00Z",
  type: "anomaly",
  label: "Gripper force spike",
  metadata: { force_n: 45.2 },
});

// Create a recording rule
const rule = await avala.fleet.rules.create({
  name: "High Latency Alert",
  condition: { type: "threshold", topic: "/diagnostics/latency", field: "data.value", operator: "gt", value: 100 },
  actions: [{ type: "tag", value: "high-latency" }, { type: "notify", channelId: "ch_your_channel_id" }],
});
```

Подробные примеры см. в руководстве [Панель управления парком](/docs/visualization/fleet/fleet-dashboard).

## Конфигурация

Вы можете настроить поведение клиента при инициализации.

```typescript theme={null}
import Avala from "@avala-ai/sdk";

const avala = new Avala({
  apiKey: "your-api-key",
  baseUrl: "https://api.avala.ai/api/v1", // Default
  timeout: 60_000,    // Request timeout in ms (default: 30000)
});
```

| Параметр  | Тип      | По умолчанию                         | Описание                         |
| --------- | -------- | ------------------------------------ | -------------------------------- |
| `apiKey`  | `string` | Переменная окружения `AVALA_API_KEY` | Ваш API-ключ Avala.              |
| `baseUrl` | `string` | `https://api.avala.ai/api/v1`        | Базовый URL API.                 |
| `timeout` | `number` | `30000`                              | Таймаут запроса в миллисекундах. |

## Ноль зависимостей

Пакет `@avala-ai/sdk` не имеет runtime-зависимостей. Он использует нативный API `fetch`, доступный в Node.js 18+, Deno и Bun.

## Примеры для фреймворков

### Next.js (App Router)

```typescript theme={null}
// app/api/datasets/route.ts
import Avala from "@avala-ai/sdk";
import { NextResponse } from "next/server";

const avala = new Avala({ apiKey: process.env.AVALA_API_KEY! });

export async function GET() {
  const datasets = await avala.datasets.list();
  return NextResponse.json(datasets);
}
```

### Express

```typescript theme={null}
import express from "express";
import Avala from "@avala-ai/sdk";

const app = express();
const avala = new Avala(); // Reads AVALA_API_KEY from env

app.get("/datasets", async (req, res) => {
  try {
    const datasets = await avala.datasets.list();
    res.json(datasets);
  } catch (error) {
    res.status(500).json({ error: "Failed to fetch datasets" });
  }
});

app.listen(3000, () => {
  console.log("Server running on port 3000");
});
```