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

# Schnellstart

> Starten Sie mit Avala in unter 60 Sekunden

<Tip>
  **Voraussetzungen:** Sie benötigen ein Avala-Konto. [Registrieren Sie sich auf avala.ai](https://avala.ai) oder erstellen Sie eines programmatisch mit dem SDK (siehe unten), dann erstellen Sie einen API Key unter **[Einstellungen > Sicherheit](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>

Das war's. Im Folgenden finden Sie eine Schritt-für-Schritt-Anleitung, was passiert und was Sie als Nächstes tun können.

***

## Konto erstellen

Sie können sich auf [avala.ai](https://avala.ai) registrieren oder ein Konto programmatisch erstellen. Die SDK-Funktion `signup` erfordert keinen API Key — sie gibt bei Erfolg einen zurück.

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

1. Melden Sie sich bei [Mission Control](https://avala.ai) an.
2. Gehen Sie zu **[Einstellungen > Sicherheit](https://avala.ai/settings?section=security)**.
3. Klicken Sie auf **API Key erstellen**, geben Sie einen Namen ein, wählen Sie Berechtigungen und kopieren Sie den Key.

<Warning>
  API Keys werden nur einmal bei der Erstellung angezeigt. Speichern Sie den Key an einem sicheren Ort, bevor Sie den Dialog schließen.
</Warning>

Setzen Sie ihn als Umgebungsvariable, damit alle SDKs und das CLI ihn automatisch verwenden:

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

## Datensätze auflisten

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

  client = Client()  # liest AVALA_API_KEY aus der Umgebung

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

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

  const avala = new Avala();  // liest AVALA_API_KEY aus der Umgebung

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

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

## Projekte auflisten

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

## Export erstellen

<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>
  Exporte laufen asynchron. Fragen Sie den Status mit `client.exports.get(uid)` ab oder prüfen Sie `avala exports get <uid>`, bis der Vorgang abgeschlossen ist.
</Info>

## Rate-Limit-Nutzung prüfen

Die SDKs stellen Rate-Limit-Header aus jeder Antwort bereit:

<CodeGroup>
  ```python Python theme={null}
  info = client.rate_limit_info
  print(f"{info['remaining']}/{info['limit']} Anfragen verbleibend")
  print(f"Zurückgesetzt um: {info['reset']}")
  ```

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

## Nächste Schritte

<CardGroup cols={3}>
  <Card title="Python SDK" icon="python" href="/docs/de/sdks/python">
    Async-Unterstützung, Paginierung, Fehlerbehandlung und vollständige Type Hints.
  </Card>

  <Card title="TypeScript SDK" icon="js" href="/docs/de/sdks/typescript">
    Keine Abhängigkeiten. Funktioniert in Node.js, Deno und Bun.
  </Card>

  <Card title="CLI-Referenz" icon="terminal" href="/docs/de/sdks/cli">
    Verwalten Sie Datensätze, Projekte, Exporte und Speicher von Ihrem Terminal aus.
  </Card>
</CardGroup>

<CardGroup cols={3}>
  <Card title="Webhooks" icon="bell" href="/docs/integrations/webhooks">
    Erhalten Sie Echtzeitbenachrichtigungen für Datensatz-, Export- und Aufgabenereignisse.
  </Card>

  <Card title="MCP Server" icon="robot" href="/docs/integrations/mcp-setup">
    Nutzen Sie Avala mit Claude, Cursor und VS Code über KI-Assistenten.
  </Card>

  <Card title="API-Referenz" icon="square-terminal" href="/docs/api-reference/overview">
    Vollständige Endpoint-Referenz mit Request- und Response-Schemas.
  </Card>
</CardGroup>
