メインコンテンツへスキップ

動画は近日公開

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

非同期サポート、ページネーション、エラーハンドリング、完全な型ヒント。

TypeScript SDK

ゼロ依存。Node.js、Deno、Bun で動作します。

CLI リファレンス

ターミナルからデータセット、プロジェクト、エクスポート、ストレージを管理できます。

ウェブフック

データセット、エクスポート、タスクイベントのリアルタイム通知を受信できます。

MCP サーバー

AI アシスタントを通じて Claude、Cursor、VS Code で Avala を使用できます。

API リファレンス

リクエストとレスポンススキーマを含む完全なエンドポイントリファレンスです。