Installation
Schnellstart
Konto erstellen
Die Funktionsignup erstellt ein neues Avala-Konto und gibt einen API Key zurück. Sie erfordert keine Authentifizierung.
Authentifizierung
Das SDK authentifiziert sich mit Ihrem Avala API Key, der über denX-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
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 einCursorPage<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.
fleet-Namespace bietet Zugriff auf Geräteregister, Aufnahmen, Events, Regeln und Warnungen.
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.