Erstellt eine Modellantwort für einen bestimmten Agenten im Vercel AI SDK kompatiblen Format.
api.langdock.com durch die Base URL deines Deployments: <deployment-url>/api/publicuseChat Hook und anderen Vercel AI SDK Features.| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
agentId | string | Eines von agentId/agent erforderlich | ID eines vorhandenen Agenten |
agent | object | Eines von agentId/agent erforderlich | Konfiguration für einen temporären Agenten |
messages | array | Ja | Array von UIMessage-Objekten (Vercel AI SDK Format) |
stream | boolean | Nein | Streaming-Antworten aktivieren (Standard: false) |
output | object | Nein | Spezifikation für strukturiertes Ausgabeformat |
maxSteps | integer | Nein | Maximale Anzahl von Tool-Schritten (1-20) |
imageResponseFormat | string | Nein | Antwortformat für vom Agenten generierte Bilder. "url" gibt eine signierte URL zurück, "b64_json" gibt base64-kodierte Bilddaten zurück. |
messages Array sollte enthalten:
| Typ | Felder | Beschreibung |
|---|---|---|
text | type: "text", text: string | Klartext-Inhalt |
file | type: "file", mediaType: string, url: string, filename?: string | Inline-Dateireferenz |
| Typ | Wichtige Felder | Beschreibung |
|---|---|---|
text | type: "text", text: string | Textantwort |
reasoning | type: "reasoning", text: string | Modell-Reasoning / Chain-of-Thought |
tool-{name} | type: "tool-{name}", toolCallId: string, state: "input-streaming" | "input-available" | "output-available" | "output-error", input?: any, output?: any, errorText?: string | Tool-Aufruf und Ergebnis |
source-url | type: "source-url", sourceId: string, url: string, title?: string | Web-Quellenreferenz |
source-document | type: "source-document", sourceId: string, mediaType: string, title: string, filename?: string | Dokumenten-Quellenreferenz |
metadata.attachments Array der Nachricht. Verwende keine type: "file" Parts für hochgeladene Attachments — dieses Format ist für Inline-Dateireferenzen reserviert (z.B. Data URIs).agent Parameter kannst du Folgendes angeben:
name - Name des Agenten (max. 64 Zeichen)instructions - Systemanweisungen (max. 16384 Zeichen)description - Optionale Beschreibung (max. 256 Zeichen)temperature - Temperatur zwischen 0-1model - Zu verwendende Modell-ID (siehe Verfügbare Modelle für Optionen)capabilities - Aktivieren von Funktionen wie Websuche, Datenanalyse, Bilderzeugung, CanvasknowledgeFolderIds - IDs von zu verwendenden WissensordnernattachmentIds - Array von UUID-Strings zur Identifizierung zu verwendender Anhänge
output Parameter angeben:
| Feld | Typ | Beschreibung |
|---|---|---|
type | ”object” | “array” | “enum” | Der Typ der strukturierten Ausgabe |
schema | object | JSON-Schema-Definition für die Ausgabe (für object/array-Typen) |
enum | string[] | Array erlaubter Werte (für enum-Typ) |
output Parameters hängt vom angegebenen Typ ab:
type: "object" ohne Schema: Erzwingt, dass die Antwort ein einzelnes JSON-Objekt ist (keine spezifische Struktur)type: "object" mit Schema: Erzwingt, dass die Antwort dem bereitgestellten JSON-Schema entsprichttype: "array" mit Schema: Erzwingt, dass die Antwort ein Array von Objekten ist, die dem bereitgestellten Schema entsprechentype: "enum": Erzwingt, dass die Antwort einer der im enum Array angegebenen Werte iststream auf true gesetzt ist, gibt die API einen Stream im Vercel AI SDK Streaming-Format zurück, kompatibel mit dem useChat Hook und anderen Vercel AI SDK Features.
attachmentId (UUID) für jede Datei zurück. Du kannst Attachments dann auf zwei Arten verwenden:
metadata.attachments Array der Nachricht ein. So kannst du verschiedene Dateien in verschiedenen Nachrichten innerhalb desselben Gesprächs referenzieren.attachments Array ein, wenn du einen persistenten Agenten erstellst oder aktualisierst. Alle Nachrichten an diesen Agenten haben dann Zugriff auf diese Dateien.messages Array zurück, das die Antwort des Agenten enthält:
messages Array. Jede Nachricht hat:
id - Eindeutige Kennung für die Nachrichtrole - Immer "assistant" für Completion-Antwortencontent - Die Textantwort des Agenten als einfacher Stringoutput Parameter enthält, wird die Antwort automatisch ein output Feld mit den formatierten strukturierten Daten enthalten. Der Typ dieses Feldes hängt vom angeforderten Ausgabeformat ab:
output.type “object” war: Gibt ein JSON-Objekt zurück (mit Schema-Validierung, falls ein Schema bereitgestellt wurde)output.type “array” war: Gibt ein Array von Objekten zurück, die dem bereitgestellten Schema entsprechenoutput.type “enum” war: Gibt einen String zurück, der einem der bereitgestellten Enum-Werte entspricht429 Too Many Requests Antwort.
Bitte beachte, dass die Rate Limits Änderungen unterliegen. Beziehe dich auf diese Dokumentation für die aktuellsten Informationen. Falls du eine höhere Rate Limit benötigst, kontaktiere uns bitte unter support@langdock.com.
400 - Ungültige Anfrageparameter, fehlerhaftes Nachrichtenformat, Agent nicht gefunden oder Agent nicht mit API-Schlüssel geteilt401 - Ungültiger oder fehlender API-Schlüssel429 - Rate Limit überschritten500 - ServerfehlerAPI key as Bearer token. Format "Bearer YOUR_API_KEY"
ID of an existing agent to use
Array of UIMessage objects (Vercel AI SDK format)
Specification for structured output format. When type is object/array and no schema is provided, the response will be JSON but can have any structure. When the type is enum, you must provide an enum parameter with an array of strings as options.
Response format for images generated by the agent. "url" returns a signed URL, "b64_json" returns base64-encoded image data.
url, b64_json