Skip to main content
PATCH
Updates an existing agent
⚠️ Du nutzt unsere API in einem Dedicated Deployment? Ersetze einfach api.langdock.com durch die Base URL deines Deployments: <deployment-url>/api/public
Dies ist die neue Agents API mit nativer Vercel AI SDK Kompatibilität. Wenn du die veraltete Assistants API verwendest, siehe den Migrations-Guide.
Aktualisiert einen vorhandenen Agenten in deinem Workspace. Nur die von dir angegebenen Felder werden aktualisiert, was partielle Updates ermöglicht, ohne andere Konfigurationen zu beeinflussen.
Ä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, conversationStarters, attachments und knowledgeFolderIds ersetzen bei Angabe vollständig die vorhandenen Werte
  • Leere Arrays - Sende [] um alle Actions/Felder/Anhänge zu entfernen
  • Null-Behandlung - Sende null für emoji um es zu löschen. Für description und instruction sende 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. Nur agentId ist erforderlich.
Der Parameter dataAnalyst ist veraltet und hat keine Wirkung. Anfragen mit diesem Parameter sind aus Gründen der Abwärtskompatibilität weiterhin erfolgreich, aber Langdock ignoriert den Wert und aktiviert weder Dateiarbeit noch Codeausführung. Lass diesen Parameter in neuen Integrationen weg.
Array-Felder (actions, inputFields, conversationStarters, attachments, knowledgeFolderIds) werden vollständig ersetzt, nicht zusammengeführt. Gib immer das vollständige gewünschte Array an, einschließlich aller vorhandenen Elemente, die du behalten möchtest.

Actions-Konfiguration

Jede Action im actions Array sollte enthalten:
  • actionId (erforderlich) - UUID der Action aus einer aktivierten Integration
  • requiresConfirmation (optional) - Ob vor der Ausführung eine Benutzerbestätigung erforderlich ist (Standard: true)

Eingabefelder-Konfiguration

Für die inputFields 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
  • Ordner - 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 800 Zeichen
  • Instruktion - Falls angegeben, maximal 50000 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.
  1. Vor dem Update abrufen - Wenn du vorhandene Array-Werte beibehalten musst, rufe zuerst die aktuelle Agent-Konfiguration ab
  2. Inkrementelle Updates - Aktualisiere nur die Felder, die geändert werden müssen
  3. Anhänge validieren - Stelle sicher, dass Anhang-UUIDs gültig sind, bevor du sie einfügst
  4. Actions testen - Überprüfe, dass Actions zu aktivierten Integrationen gehören, bevor du aktualisierst
  5. 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

Authorization
string
header
erforderlich

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Body

application/json
agentId
string<uuid>
erforderlich
name
string

Name of the agent or assistant

Required string length: 1 - 80
description
string

Description of what the agent or assistant does. Send an empty string to clear it during an update.

Maximum string length: 800
instruction
string

System prompt or instructions. Send an empty string to clear it during an update.

Maximum string length: 50000
inputType
enum<string>

Input type

Verfügbare Optionen:
PROMPT,
STRUCTURED,
INTEGRATION,
SCHEDULED,
WEBHOOK
emoji
string | null

Emoji icon

Maximum string length: 16
model
string

Model deployment name

creativity
number

Temperature for response generation

Erforderlicher Bereich: 0 <= x <= 1
conversationStarters
string[]

Suggested prompts

Maximum array length: 20
Required string length: 1 - 255
actions
object[]

Actions that the agent or assistant can use

inputFields
object[]

Form fields for STRUCTURED input

Enable web search

imageGeneration
boolean

Enable image generation

dataAnalyst
boolean
veraltet

Deprecated. Accepted for compatibility and ignored.

extendedThinking
boolean

Enable extended thinking

attachments
string<uuid>[]

Attachment UUIDs

Maximum array length: 50
knowledgeFolderIds
string<uuid>[]

Folder UUIDs

Antwort

200 - application/json

Agent updated successfully

status
enum<string>
erforderlich
Verfügbare Optionen:
success
message
string
erforderlich
Beispiel:

"Agent updated successfully"

agent
object
erforderlich