Skip to main content
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 am 16. August eingestellt

Wesentliche Unterschiede

Endpoint-Änderungen

Parameter-Änderungen (nicht-breaking)

Bei den Endpoints für Create, Get und Update ändert sich nur die Parameterbenennung:
  • assistantIdagentId
  • Die Anfragefelder bleiben identisch
  • Das Antwortobjekt ändert sich von assistant zu agent
  • 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

  1. Nachrichtenstruktur:
    • Alt: content als String
    • Neu: parts als Array mit typisierten Objekten
  2. Nachrichten-ID:
    • Alt: Optional oder automatisch generiert
    • Neu: Pflichtfeld id für jede Nachricht
  3. Anhänge:
    • Alt: attachmentIds Array auf Nachrichtenebene
    • Neu: metadata.attachments Array am Nachrichtenobjekt
  4. Parametername:
    • Alt: assistantId
    • Neu: agentId

Änderungen am Response-Format

Altes Format (Assistants API)

Neues Format (Agents API)

Wichtige Response-Unterschiede

  1. Top-Level-Struktur:
    • Alt: Verpackt in result Array
    • Neu: Verpackt in messages Array
  2. Content-Feld:
    • Alt: content Array
    • Neu: content String

Streaming-Änderungen

Altes Format (Assistants API)

Neues Format (Agents API)

Verwendet das Vercel AI SDK Streaming-Format:
Die Agents API streamt im nativen Format des Vercel AI SDK, kompatibel mit dem 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 dem useChat 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
  • assistantId durch agentId in allen Requests ersetzen
  • Nachrichten-content-Strings zu parts-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
  • Besitzer informieren oder Systeme migrieren, die API-Keys mit der Markierung Nutzt veraltete Endpoints in den Workspace-API-Einstellungen verwenden

Schrittweise Migrationsstrategie

Du kannst Endpoints schrittweise migrieren:
  1. Mit nicht-breaking Endpoints starten: Zuerst Create, Get, Update und Models migrieren (nur Parameternamen ändern sich)
  2. Gründlich testen: Sicherstellen, dass diese korrekt funktionieren
  3. Chat Completions zuletzt migrieren: Dieser Endpoint erfordert die meisten Code-Änderungen
  4. 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-IDs
Lösung: Generiere eindeutige IDs für jede Nachricht

Problem 2: Anhangsformat

Problem: Altes Anhangsformat wird nicht erkannt
Lösung: Verwende metadata.attachments

Problem 3: Response-Parsing

Problem: Suche nach result Array
Lösung: Verwende messages Array mit content String

Support

Falls du während der Migration auf Probleme stößt:
  1. Schau dir die Agents API Dokumentation für detaillierte Beispiele an
  2. Lies die Vercel AI SDK Dokumentation für SDK-spezifische Hilfe
  3. Kontaktiere den Support unter support@langdock.com

Zeitplan

  • Aktuell: Beide APIs sind verfügbar
  • Zukünftig: Die Assistants API wird am 16. August eingestellt
  • Empfehlung: Migriere neue Systeme jetzt zur Agents API
Bei Fragen oder für Unterstützung bei der Migration kontaktiere unser Support-Team unter support@langdock.com.