Перейти к основному содержанию

ВИДЕО СКОРО

Начало работы с Avala

5-6 мин • Настройка API-ключа, установка SDK, первый вызов API

Предварительные требования: Вам нужен аккаунт Avala. Зарегистрируйтесь на avala.ai или создайте аккаунт программно через SDK (см. ниже), затем создайте API-ключ в разделе Настройки > Безопасность.
pip install avala

from avala import Client

client = Client(api_key="avk_your_api_key")

for dataset in client.datasets.list():
    print(dataset.name, dataset.item_count)
Вот и всё. Ниже — пошаговое руководство о том, что происходит и что можно делать дальше.

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

Вы можете зарегистрироваться на avala.ai или создать аккаунт программно. Функция SDK signup не требует API-ключа — она возвращает его при успешной регистрации. 
from avala import signup

result = signup(email="dev@acme.com", password="SecurePass123!")
print(f"API Key: {result.api_key}")

​
Получение API-ключа

  1. Войдите в Mission Control.
  2. Перейдите в Настройки > Безопасность.
  3. Нажмите Создать API-ключ, дайте ему имя, выберите области доступа и скопируйте ключ.
API-ключи отображаются только один раз при создании. Сохраните ключ в надёжном месте перед закрытием диалога.
Установите его как переменную окружения, чтобы все SDK и CLI подхватывали его автоматически: 
export AVALA_API_KEY="avk_your_api_key"

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

from avala import Client

client = Client()  # читает AVALA_API_KEY из окружения

for dataset in client.datasets.list():
    print(f"{dataset.name} — {dataset.item_count} items")

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

for project in client.projects.list():
    print(f"{project.name} ({project.status})")

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

export = client.exports.create(project="proj_uid_here")
print(f"Export {export.uid}: {export.status}")
Экспорты выполняются асинхронно. Проверяйте статус с помощью client.exports.get(uid) или командой avala exports get <uid> до завершения.

​
Проверка использования лимита запросов

SDK предоставляют заголовки лимита запросов из каждого ответа: 
info = client.rate_limit_info
print(f"{info['remaining']}/{info['limit']} requests remaining")
print(f"Resets at: {info['reset']}")

​
Следующие шаги

Python SDK

Поддержка async, пагинация, обработка ошибок и полные аннотации типов.

TypeScript SDK

Ноль зависимостей. Работает в Node.js, Deno и Bun.

Справочник CLI

Управляйте наборами данных, проектами, экспортами и хранилищем из терминала.

Вебхуки

Получайте уведомления в реальном времени о событиях наборов данных, экспортов и задач.

MCP-сервер

Используйте Avala с Claude, Cursor и VS Code через AI-ассистентов.

Справочник API

Полный справочник эндпоинтов со схемами запросов и ответов.