> ## 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.

# クイックスタート

> 60秒以内に Avala を使い始めましょう

<Tip>
  **前提条件:** Avala アカウントが必要です。[avala.ai でサインアップ](https://avala.ai)するか、SDK を使ってプログラムでアカウントを作成し（下記参照）、**[設定 > セキュリティ](https://avala.ai/settings?section=security)** で API キーを作成してください。
</Tip>

<CodeGroup>
  ```bash Python theme={null}
  pip install avala
  ```

  ```bash TypeScript theme={null}
  npm install @avala-ai/sdk
  ```

  ```bash CLI theme={null}
  curl -fsSL https://avala.ai/install.sh | bash
  ```
</CodeGroup>

<CodeGroup>
  ```python Python theme={null}
  from avala import Client

  client = Client(api_key="avk_your_api_key")

  for dataset in client.datasets.list():
      print(dataset.name, dataset.item_count)
  ```

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

  const avala = new Avala({ apiKey: "avk_your_api_key" });

  const page = await avala.datasets.list();
  page.items.forEach(d => console.log(d.name, d.itemCount));
  ```

  ```bash CLI theme={null}
  export AVALA_API_KEY="avk_your_api_key"
  avala datasets list
  ```

  ```bash cURL theme={null}
  curl https://api.avala.ai/api/v1/datasets/ \
    -H "X-Avala-Api-Key: avk_your_api_key"
  ```
</CodeGroup>

以上です。以下では、何が起こっているかのステップバイステップの説明と、次にできることを紹介します。

***

## アカウントの作成

[avala.ai](https://avala.ai) でサインアップするか、プログラムでアカウントを作成できます。SDK の `signup` 関数は API キーを必要としません — 成功するとキーが返されます。

<CodeGroup>
  ```python Python theme={null}
  from avala import signup

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

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

  const result = await signup({ email: "dev@acme.com", password: "SecurePass123!" });
  console.log(`API Key: ${result.apiKey}`);
  ```

  ```bash cURL theme={null}
  curl -X POST https://api.avala.ai/api/v1/signup/ \
    -H "Content-Type: application/json" \
    -d '{"email": "dev@acme.com", "password": "SecurePass123!"}'
  ```
</CodeGroup>

***

## API キーの取得

1. [Mission Control](https://avala.ai) にログインします。
2. **[設定 > セキュリティ](https://avala.ai/settings?section=security)** に移動します。
3. **API キーを作成** をクリックし、名前を付け、スコープを選択し、キーをコピーします。

<Warning>
  API キーは作成時に一度だけ表示されます。ダイアログを閉じる前に安全な場所に保存してください。
</Warning>

すべての SDK と CLI が自動的に使用できるよう、環境変数として設定します：

```bash theme={null}
export AVALA_API_KEY="avk_your_api_key"
```

## データセットの一覧表示

<CodeGroup>
  ```python Python theme={null}
  from avala import Client

  client = Client()  # 環境変数から AVALA_API_KEY を読み取ります

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

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

  const avala = new Avala();  // 環境変数から AVALA_API_KEY を読み取ります

  const page = await avala.datasets.list();
  for (const d of page.items) {
    console.log(`${d.name} — ${d.itemCount} items`);
  }
  ```

  ```bash CLI theme={null}
  avala datasets list
  ```

  ```bash cURL theme={null}
  curl https://api.avala.ai/api/v1/datasets/ \
    -H "X-Avala-Api-Key: $AVALA_API_KEY"
  ```
</CodeGroup>

## プロジェクトの一覧表示

<CodeGroup>
  ```python Python theme={null}
  for project in client.projects.list():
      print(f"{project.name} ({project.status})")
  ```

  ```typescript TypeScript theme={null}
  const projects = await avala.projects.list();
  projects.items.forEach(p => console.log(`${p.name} (${p.status})`));
  ```

  ```bash CLI theme={null}
  avala projects list
  ```

  ```bash cURL theme={null}
  curl https://api.avala.ai/api/v1/projects/ \
    -H "X-Avala-Api-Key: $AVALA_API_KEY"
  ```
</CodeGroup>

## エクスポートの作成

<CodeGroup>
  ```python Python theme={null}
  export = client.exports.create(project="proj_uid_here")
  print(f"Export {export.uid}: {export.status}")
  ```

  ```typescript TypeScript theme={null}
  const exp = await avala.exports.create({ project: "proj_uid_here" });
  console.log(`Export ${exp.uid}: ${exp.status}`);
  ```

  ```bash CLI theme={null}
  avala exports create --project proj_uid_here
  ```

  ```bash cURL theme={null}
  curl -X POST https://api.avala.ai/api/v1/exports/ \
    -H "X-Avala-Api-Key: $AVALA_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"project": "proj_uid_here"}'
  ```
</CodeGroup>

<Info>
  エクスポートは非同期で実行されます。`client.exports.get(uid)` でステータスをポーリングするか、`avala exports get <uid>` で完了するまで確認してください。
</Info>

## レート制限の使用状況を確認

SDK はすべてのレスポンスからレート制限ヘッダーを公開します：

<CodeGroup>
  ```python Python theme={null}
  info = client.rate_limit_info
  print(f"{info['remaining']}/{info['limit']} requests remaining")
  print(f"Resets at: {info['reset']}")
  ```

  ```typescript TypeScript theme={null}
  const info = avala.rateLimitInfo;
  console.log(`${info.remaining}/${info.limit} requests remaining`);
  ```
</CodeGroup>

## 次のステップ

<CardGroup cols={3}>
  <Card title="Python SDK" icon="python" href="/docs/ja/sdks/python">
    非同期サポート、ページネーション、エラーハンドリング、完全な型ヒント。
  </Card>

  <Card title="TypeScript SDK" icon="js" href="/docs/ja/sdks/typescript">
    ゼロ依存。Node.js、Deno、Bun で動作します。
  </Card>

  <Card title="CLI リファレンス" icon="terminal" href="/docs/ja/sdks/cli">
    ターミナルからデータセット、プロジェクト、エクスポート、ストレージを管理できます。
  </Card>
</CardGroup>

<CardGroup cols={3}>
  <Card title="ウェブフック" icon="bell" href="/docs/integrations/webhooks">
    データセット、エクスポート、タスクイベントのリアルタイム通知を受信できます。
  </Card>

  <Card title="MCP サーバー" icon="robot" href="/docs/integrations/mcp-setup">
    AI アシスタントを通じて Claude、Cursor、VS Code で Avala を使用できます。
  </Card>

  <Card title="API リファレンス" icon="square-terminal" href="/docs/api-reference/overview">
    リクエストとレスポンススキーマを含む完全なエンドポイントリファレンスです。
  </Card>
</CardGroup>