Skip to main content

Installation

Schnellstart

Konto erstellen

Die Funktion signup erstellt ein neues Avala-Konto und gibt einen API Key zurück. Sie erfordert keine Authentifizierung.
Verwenden Sie den zurückgegebenen API Key, um den Client zu initialisieren:

Authentifizierung

Das SDK authentifiziert sich mit Ihrem Avala API Key, der über den X-Avala-Api-Key Header bei jeder Anfrage gesendet wird. Sie können den Key direkt übergeben oder das SDK ihn aus der Umgebung lesen lassen. Option 1: Key direkt übergeben
Option 2: Umgebungsvariable verwenden

Arbeiten mit Datensätzen

Das TypeScript SDK ist derzeit schreibgeschützt für Datensätze — Sie können Datensätze auflisten und abrufen, aber nicht erstellen, aktualisieren oder löschen. Verwenden Sie die REST API für Uploads und Mutationen.

Datensätze auflisten

Datensatz abrufen

Arbeiten mit Projekten

Projekte auflisten

Projekt abrufen

Arbeiten mit Aufgaben

Aufgaben auflisten

Aufgabe abrufen

Arbeiten mit Exporten

Export erstellen

Auf Fertigstellung warten

TypeScript-Typen

Das SDK exportiert vollständige TypeScript-Interfaces für alle API-Objekte. Verwenden Sie sie, um Ihre Funktionen und Variablen zu typisieren.

Fehlerbehandlung

Das SDK wirft typisierte Fehler, sodass Sie verschiedene Fehlermodi präzise behandeln können.

Paginierung

Listen-Methoden geben ein CursorPage<T>-Objekt mit cursorbasierter Paginierung zurück.

Arbeiten mit Agents

Agent erstellen

Agent-Ausführungen auflisten

Arbeiten mit Webhooks

Webhook erstellen

Zustellungen inspizieren

Arbeiten mit Qualität & Konsens

Qualitätsziel erstellen

Konsens prüfen

Flottenmanagement

Flottenmanagement ist in der Vorschau. Die hier beschriebenen APIs können sich ändern.
Der fleet-Namespace bietet Zugriff auf Geräteregister, Aufnahmen, Events, Regeln und Warnungen.
Siehe den Fleet Dashboard Guide für vollständige Beispiele.

Konfiguration

Sie können das Client-Verhalten bei der Initialisierung anpassen.

Keine Abhängigkeiten

Das Paket @avala-ai/sdk hat keine Laufzeitabhängigkeiten. Es verwendet die native fetch API, die in Node.js 18+, Deno und Bun verfügbar ist.

Framework-Beispiele

Next.js (App Router)

Express