> ## 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>
  **Prerequisites:** You need an Avala account. [Sign up at avala.ai](https://avala.ai) or create one programmatically with the SDK (see below), then create an API key under **[Settings > Security](https://avala.ai/settings?section=security)**.
</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>

That's it. Below is a step-by-step walkthrough of what's happening and what you can do next.

***

## Create an Account

You can sign up at [avala.ai](https://avala.ai) or create an account programmatically. The SDK `signup` function does not require an API key — it returns one on success.

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

***

## Get Your API Key

1. Log in to [Mission Control](https://avala.ai).
2. Go to **[Settings > Security](https://avala.ai/settings?section=security)**.
3. Click **Create API Key**, give it a name, select scopes, and copy the key.

<Warning>
  API keys are shown only once at creation time. Store it somewhere secure before closing the dialog.
</Warning>

Set it as an environment variable so all SDKs and the CLI pick it up automatically:

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

## List Datasets

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

  client = Client()  # reads AVALA_API_KEY from env

  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();  // reads AVALA_API_KEY from env

  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>

## List Projects

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

## Create an Export

<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>
  Exports run asynchronously. Poll the status with `client.exports.get(uid)` or check `avala exports get <uid>` until it completes.
</Info>

## Check Rate Limit Usage

The SDKs expose rate limit headers from every response:

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

## Next Steps

<CardGroup cols={3}>
  <Card title="Python SDK" icon="python" href="/docs/ta/sdks/python">
    Async support, pagination, error handling, and full type hints.
  </Card>

  <Card title="TypeScript SDK" icon="js" href="/docs/ta/sdks/typescript">
    Zero dependencies. Works in Node.js, Deno, and Bun.
  </Card>

  <Card title="CLI Reference" icon="terminal" href="/docs/ta/sdks/cli">
    Manage datasets, projects, exports, and storage from your terminal.
  </Card>
</CardGroup>

<CardGroup cols={3}>
  <Card title="Webhooks" icon="bell" href="/docs/integrations/webhooks">
    Receive real-time notifications for dataset, export, and task events.
  </Card>

  <Card title="MCP Server" icon="robot" href="/docs/ta/integrations/mcp-setup">
    Use Avala with Claude, Cursor, and VS Code through AI assistants.
  </Card>

  <Card title="API Reference" icon="square-terminal" href="/docs/api-reference/overview">
    Full endpoint reference with request and response schemas.
  </Card>
</CardGroup>