Updates an existing agent
Agents API
Agent Update API
Einen vorhandenen Agenten programmatisch aktualisieren
PATCH
Updates an existing agent
Documentation Index
Fetch the complete documentation index at: https://docs.langdock.com/llms.txt
Use this file to discover all available pages before exploring further.
⚠️ Du nutzt unsere API in einem Dedicated Deployment? Ersetze einfach
api.langdock.com durch die Base URL deines Deployments: <deployment-url>/api/publicDies ist die neue Agents API mit nativer Vercel AI SDK Kompatibilität. Wenn du die veraltete Assistants API verwendest, siehe den Migrations-Guide.
Änderungen werden nur auf den Entwurf des Agenten angewendet. Die aktive (veröffentlichte) Version bleibt unverändert, bis der Agent in der Langdock-Oberfläche veröffentlicht wird. Die Antwort dieses Endpoints gibt den Entwurf zurück.
Erfordert einen API-Schlüssel mit dem
AGENT_API Scope und Zugriff auf den Agenten, den du aktualisieren möchtest.Aktualisierungsverhalten
Der Update-Endpunkt verwendet partielle Update-Semantik mit spezifischem Verhalten für verschiedene Feldtypen:- Partielle Updates - Nur in der Anfrage enthaltene Felder werden aktualisiert; ausgelassene Felder bleiben unverändert
- Array-Felder ersetzen -
actions,inputFields,conversationStartersundattachmentsersetzen bei Angabe vollständig die vorhandenen Werte - Leere Arrays - Sende
[]um alle Actions/Felder/Anhänge zu entfernen - Null-Behandlung - Sende
nullfüremojium es zu löschen. Fürdescriptionundinstructionsende einen leeren String""zum Löschen - Unveränderte Felder - Felder, die nicht in der Anfrage enthalten sind, behalten ihre aktuellen Werte
Anfrageparameter
Setze einen der folgenden Parameter, um die aktuellen Einstellungen des Agenten zu überschreiben. Felder, die du weglässt, bleiben unverändert. NuragentId ist erforderlich.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
agentId | string | Ja | UUID des zu aktualisierenden Agenten |
name | string | Nein | Name des Agenten (1-80 Zeichen) |
description | string | Nein | Beschreibung (max. 500 Zeichen, "" zum Löschen) |
emoji | string | Nein | Emoji-Icon (max. 16 Zeichen, null zum Löschen) |
instruction | string | Nein | Systemanweisung (max. 40000 Zeichen, "" zum Löschen) |
model | string | Nein | Modell-ID (Deployment-Name aus der Models API) |
creativity | number | Nein | Temperatur zwischen 0 und 1 |
conversationStarters | string[] | Nein | Vorgeschlagene Prompts, max. 20, je 1-255 Zeichen (ersetzt vorhandene) |
actions | array | Nein | Actions (ersetzt vorhandene) |
inputFields | array | Nein | Formularfelder (ersetzt vorhandene) |
attachments | string[] | Nein | Anhang-UUIDs (ersetzt vorhandene) |
webSearch | boolean | Nein | Websuche aktivieren |
imageGeneration | boolean | Nein | Bildgenerierung aktivieren |
dataAnalyst | boolean | Nein | Code-Interpreter aktivieren |
inputType | string | Nein | Eingabetyp: “PROMPT” oder “STRUCTURED” |
canvas | boolean | Nein | Canvas aktivieren |
extendedThinking | boolean | Nein | Extended Thinking aktivieren |
Actions-Konfiguration
Jede Action imactions Array sollte enthalten:
actionId(erforderlich) - UUID der Action aus einer aktivierten IntegrationrequiresConfirmation(optional) - Ob vor der Ausführung eine Benutzerbestätigung erforderlich ist
Eingabefelder-Konfiguration
Für dieinputFields Array-Struktur, siehe die Agent Create API Dokumentation.
Beispiele
Grundlegende Eigenschaften aktualisieren
Validierungsregeln
Die API wendet mehrere Validierungsregeln an:- Agent-Zugriff - Dein API-Schlüssel muss Zugriff auf den Agenten haben
- Workspace-Übereinstimmung - Der Agent muss zum selben Workspace wie dein API-Schlüssel gehören
- Modell - Falls angegeben, muss es in der Liste der aktiven Modelle deines Workspaces sein
- Actions - Falls angegeben, müssen sie zu in deinem Workspace aktivierten Integrationen gehören
- Anhänge - Falls angegeben, müssen sie in deinem Workspace existieren und nicht gelöscht sein
- Name - Falls angegeben, muss zwischen 1-80 Zeichen sein
- Beschreibung - Falls angegeben, maximal 500 Zeichen
- Instruktion - Falls angegeben, maximal 40000 Zeichen
- Creativity - Falls angegeben, muss zwischen 0 und 1 liegen
Antwortformat
Erfolgreiche Antwort (200 OK)
Fehlerbehandlung
Best Practices
Vorhandene Werte beibehalten: Wenn du Array-Felder wie
actions oder attachments aktualisierst, füge immer vorhandene Elemente ein, die du behalten möchtest, da das gesamte Array ersetzt wird.- Vor dem Update abrufen - Wenn du vorhandene Array-Werte beibehalten musst, rufe zuerst die aktuelle Agent-Konfiguration ab
- Inkrementelle Updates - Aktualisiere nur die Felder, die geändert werden müssen
- Anhänge validieren - Stelle sicher, dass Anhang-UUIDs gültig sind, bevor du sie einfügst
- Actions testen - Überprüfe, dass Actions zu aktivierten Integrationen gehören, bevor du aktualisierst
- Fehler elegant behandeln - Implementiere eine ordnungsgemäße Fehlerbehandlung für Validierungsfehler
Langdock blockiert bewusst Browser-basierte Anfragen, um deinen API-Schlüssel zu schützen und die Sicherheit deiner Anwendungen zu gewährleisten. Weitere Informationen findest du in unserem Guide zu Best Practices für API-Schlüssel.
Autorisierungen
API key as Bearer token. Format "Bearer YOUR_API_KEY"
Body
application/json
Maximum string length:
64Maximum string length:
16384Maximum string length:
256Erforderlicher Bereich:
0 <= x <= 1Maximum string length:
64Array of UUID strings identifying attachments for this message
Antwort
200
Agent updated successfully