Die Agents API ist die nächste Generation unserer API, entwickelt für bessere Kompatibilität mit modernen AI SDKs wie dem Vercel AI SDK.
Überblick
Die Agents API stellt eine deutliche Verbesserung gegenüber der Assistants API dar. Das Hauptziel ist native Kompatibilität mit branchenüblichen AI SDKs. Der wesentliche Unterschied liegt in der Abschaffung benutzerdefinierter Input/Output-Transformationen zugunsten von Standardformaten.Warum migrieren?
- Vercel AI SDK Kompatibilität: Funktioniert nativ mit der
useChat-Funktion von AI SDK 5 - Standardformate: Verwendet branchenübliche Nachrichtenformate statt benutzerdefinierter Transformationen
- Besseres Streaming: Native Unterstützung für AI SDK Streaming-Patterns
- Zukunftssicher: Die Assistants API wird in einem zukünftigen Release eingestellt
Wesentliche Unterschiede
Endpoint-Änderungen
| Assistants API | Agents API | Breaking? |
|---|---|---|
/assistant/v1/chat/completions | /agent/v1/chat/completions | Ja - Formatänderungen |
/assistant/v1/create | /agent/v1/create | Nein - Nur Parameternamen |
/assistant/v1/get | /agent/v1/get | Nein - Nur Parameternamen |
/assistant/v1/update | /agent/v1/update | Nein - Nur Parameternamen |
/assistant/v1/models | /agent/v1/models | Nein - Identisch |
Parameter-Änderungen (nicht-breaking)
Bei den Endpoints für Create, Get und Update ändert sich nur die Parameterbenennung:assistantId→agentId- Request/Response-Struktur bleibt identisch
- Alle anderen Parameter unverändert
Breaking Changes in /chat/completions
Der Chat-Completions-Endpoint hat signifikante Formatänderungen, um Vercel AI SDK Kompatibilität zu unterstützen.
Änderungen am Request-Format
Altes Format (Assistants API)
Neues Format (Agents API)
Wichtige Request-Unterschiede
-
Nachrichtenstruktur:
- Alt:
contentals String - Neu:
partsals Array mit typisierten Objekten
- Alt:
-
Nachrichten-ID:
- Alt: Optional oder automatisch generiert
- Neu: Pflichtfeld
idfür jede Nachricht
-
Anhänge:
- Alt:
attachmentIdsArray auf Nachrichtenebene - Neu:
metadata.attachmentsArray am Nachrichtenobjekt
- Alt:
-
Parametername:
- Alt:
assistantId - Neu:
agentId
- Alt:
Änderungen am Response-Format
Altes Format (Assistants API)
Neues Format (Agents API)
Wichtige Response-Unterschiede
-
Top-Level-Struktur:
- Alt: Verpackt in
resultArray - Neu: Verpackt in
messagesArray
- Alt: Verpackt in
-
Content-Feld:
- Alt:
contentArray - Neu:
contentString
- Alt:
Streaming-Änderungen
Altes Format (Assistants API)
Neues Format (Agents API)
Verwendet das Vercel AI SDK Streaming-Format:useChat Hook.
Migrationsschritte
Schritt 1: Endpoint-URLs aktualisieren
Schritt 2: Parameternamen aktualisieren (nicht-breaking Endpoints)
Für Create-, Get- und Update-Endpoints:Schritt 3: Nachrichtenformat aktualisieren (Breaking - Chat Completions)
Nachrichten konvertieren
Verwendung mit Vercel AI SDK
Die Agents API funktioniert nativ mit demuseChat Hook des Vercel AI SDK:
Schritt 4: Response-Verarbeitung aktualisieren
Schritt 5: Streaming-Code aktualisieren
Vorher (Custom SSE Parsing)
Nachher (Vercel AI SDK)
Code-Beispiele
Vollständiges Migrations-Beispiel
Vorher (Assistants API)
Nachher (Agents API)
Verwendung mit Next.js und Vercel AI SDK
Migration testen
Checkliste
- Alle Endpoint-URLs von
/assistant/v1/*zu/agent/v1/*aktualisieren -
assistantIddurchagentIdin allen Requests ersetzen - Nachrichten-
content-Strings zuparts-Arrays konvertieren (für Chat Completions) -
id-Feld zu allen Nachrichten hinzufügen (für Chat Completions) - Anhang-Referenzen auf
metadata.attachments-Format aktualisieren - Response-Verarbeitung für das neue Format anpassen
- Streaming mit neuem Format testen (oder Vercel AI SDK verwenden)
- Fehlerbehandlung für neue Response-Struktur aktualisieren
Schrittweise Migrationsstrategie
Du kannst Endpoints schrittweise migrieren:- Mit nicht-breaking Endpoints starten: Zuerst Create, Get, Update und Models migrieren (nur Parameternamen ändern sich)
- Gründlich testen: Sicherstellen, dass diese korrekt funktionieren
- Chat Completions zuletzt migrieren: Dieser Endpoint erfordert die meisten Code-Änderungen
- Feature Flags verwenden: Während der Übergangszeit zwischen alter und neuer API umschalten
Häufige Migrationsprobleme
Problem 1: Fehlende Nachrichten-IDs
Problem: Die Agents API erfordert Nachrichten-IDsProblem 2: Anhangsformat
Problem: Altes Anhangsformat wird nicht erkanntmetadata.attachments
Problem 3: Response-Parsing
Problem: Suche nachresult Array
messages Array mit content String
Support
Falls du während der Migration auf Probleme stößt:- Schau dir die Agents API Dokumentation für detaillierte Beispiele an
- Lies die Vercel AI SDK Dokumentation für SDK-spezifische Hilfe
- Kontaktiere den Support unter support@langdock.com
Zeitplan
- Aktuell: Beide APIs sind verfügbar
- Zukünftig: Die Assistants API wird eingestellt (Datum noch offen)
- Empfehlung: Migriere neue Projekte jetzt zur Agents API
Bei Fragen oder für Unterstützung bei der Migration kontaktiere unser Support-Team unter support@langdock.com.