SDK - Avala Documentation

Avala は、お好みの言語やフレームワークからプラットフォームと統合するための公式 SDK とクライアントライブラリを提供しています。各 SDK は、慣用的なメソッド、組み込み認証、自動リトライ、完全な型安全性で Avala REST API をラップしています。

クライアントライブラリ

Python

同期・非同期サポート。完全な型ヒント。Python 3.9+。

TypeScript

完全型付き。ゼロ依存。Node.js、Deno、Bun で動作。

CLI

ターミナルからデータセット、エクスポート、ストレージを管理。curl -fsSL https://avala.ai/install.sh | bash。

REST API

任意の言語から HTTP リクエストで API を直接使用。

OpenAPI

OpenAPI 仕様から独自のクライアントを生成。

クイック比較

機能	Python	TypeScript	CLI	REST API
インストール	`pip install avala`	`npm install @avala-ai/sdk`	`curl -fsSL https://avala.ai/install.sh \| bash`	直接 HTTP
非同期	同期 + 非同期	非同期	N/A	任意
型安全性	完全な型ヒント	完全な TypeScript 型	N/A	N/A
自動リトライ	はい	はい	SDK 経由	手動
ページネーション	組み込みイテレーター	組み込みイテレーター	`--limit` フラグ	手動
依存関係	httpx, pydantic	なし（ネイティブ fetch）	click, rich	N/A

環境変数

すべての SDK は以下の環境変数をサポートしているため、一度設定すればスタック全体で使用できます。

変数	説明	デフォルト
`AVALA_API_KEY`	認証用の Avala API キー。クライアントコンストラクタにキーが渡されない場合、自動的に使用されます。	なし（必須）
`AVALA_BASE_URL`	デフォルトの API ベース URL を上書きします。セルフホストデプロイメントや開発環境に便利です。	`https://api.avala.ai/api/v1`

認証

Avala API へのすべてのリクエストには、X-Avala-Api-Key ヘッダーに API キーを含める必要があります。API キーは Avala ダッシュボードの設定 > セキュリティで確認できます。

export AVALA_API_KEY="your-api-key"

環境変数が設定されると、すべての SDK が追加設定なしで自動的に使用します。

MCP インテグレーション

Model Context Protocol を通じて、Claude、Cursor、VS Code などの AI アシスタントで Avala を使用できます。@avala-ai/mcp-server パッケージは、データセット、プロジェクト、エクスポートを AI アシスタントが直接呼び出せるツールとして公開します。

​クライアントライブラリ