Zum Hauptinhalt springen
Erstellt einen neuen Agenten in deinem Workspace programmatisch. Der erstellte Agent kann über den Chat-Completions-Endpunkt verwendet oder über die Langdock-Benutzeroberfläche aufgerufen werden.

Bevor du startest

  • API-Key-Scope: Erfordert einen API-Schlüssel mit dem Agenten API-Scope. Erstellte Agenten werden automatisch mit dem API-Schlüssel geteilt, um sie in Chat-Completions zu verwenden.
  • Veraltete Assistants API: Dies ist die neue Agents API mit nativer Vercel AI SDK Kompatibilität. Wenn du die veraltete Assistants API verwendest, siehe den Migrations-Guide.

Basis-URL

Dedicated DeploymentsErsetze api.langdock.com durch <your-deployment-url>/api/public in allen Anfragen.

Parameter

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.

Zugriffskonfiguration

Mit access teilst du den Agenten mit Benutzern, Gruppen oder deinem Workspace. Der vorhandene Agenten API-Scope reicht aus; die Freigabeberechtigungen des Schlüsselbesitzers im Workspace gelten weiterhin.
  • Rollen - "user" erlaubt die Nutzung des Agenten; "editor" erlaubt die Bearbeitung. Setze role eines Eintrags auf null, um diese direkte Freigabe zu entfernen.
  • Empfänger - Neue Benutzerfreigaben erfordern aktive Benutzer im selben Workspace. Gruppen müssen zum Workspace gehören und vom Schlüsselbesitzer verwaltet werden können, sofern die Workspace-Berechtigungen nicht das Teilen mit beliebigen Gruppen erlauben. IDs müssen innerhalb jedes Arrays eindeutig sein.
  • Besitz - Besitzer- und API-Schlüssel-Freigaben können über access nicht geändert werden.
Neue Benutzer- und Gruppenfreigaben senden nach dem Speichern In-App-Benachrichtigungen. Wiederholte Freigaben, Rollenänderungen und das Entfernen von Freigaben lösen keine Benachrichtigung aus. Es wird keine E-Mail gesendet.

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)
Nur Actions von in deinem Workspace aktivierten Integrationen können verwendet werden.

Skills

  • Übergib Skill-UUIDs aus der Skills API in skillIds.
  • Der User, dem der API-Schlüssel gehört, muss jeden Skill anhängen können. Dateivorlagen werden abgelehnt.

Sub-Agenten

  • Jedes Objekt braucht agentId. requiresConfirmation ist optional (Standard: false).
  • Lass das Feld weg oder sende [], um nichts anzuhängen. Doppelte agentId-Werte behalten das erste Objekt.

Workflows

  • Übergib Workflow-UUIDs in workflowIds.
  • Lass das Feld weg oder sende [], um nichts anzuhängen. Doppelte IDs werden entfernt.

Eingabefelder-Konfiguration

Bei Verwendung von inputType: "STRUCTURED" kannst du Formularfelder im inputFields Array definieren: Unterstützte Feldtypen:
  • TEXT - Einzeilige Texteingabe
  • MULTI_LINE_TEXT - Mehrzeiliger Textbereich
  • NUMBER - Numerische Eingabe
  • CHECKBOX - Boolean-Checkbox
  • FILE - Datei-Upload
  • SELECT - Dropdown-Auswahl
  • MULTI_SELECT - Mehrfachauswahl
  • DATE - Datumsauswahl
  • EMAIL - E-Mail-Adresse

Anhangs-IDs abrufen

Um Anhänge in deinen Agenten einzubinden, lade zuerst Dateien mit der Upload Attachment API hoch. Dies gibt Anhang-UUIDs zurück, die du im attachments Array verwenden kannst.

Beispiele

Einen einfachen Agenten erstellen

Validierungsregeln

Die API wendet mehrere Validierungsregeln an:
  • Modell - Muss in der Liste der aktiven Modelle deines Workspaces sein
  • Actions - Müssen zu in deinem Workspace aktivierten Integrationen gehören
  • Anhänge - Müssen in deinem Workspace existieren und nicht gelöscht sein
  • Ordner - Müssen in deinem Workspace existieren und nicht gelöscht sein
  • Skills - Jede ID muss ein Skill sein, den der User, dem der API-Schlüssel gehört, anhängen kann. Dateivorlagen werden abgelehnt
  • Sub-Agenten - Jede agentId muss ein Agent in deinem Workspace sein, den der User, dem der API-Schlüssel gehört, nutzen kann. Agenten mit Nur direkt werden abgelehnt
  • Workflows - Jede ID muss ein aktiver Workflow in deinem Workspace sein, den der User, dem der API-Schlüssel gehört, nutzen kann. Vorlagen werden abgelehnt. Ist die Liste nicht leer, muss Workflows für diesen User aktiviert sein
  • Berechtigungen - Dein API-Schlüssel muss die createAgents Berechtigung haben
  • Freigaben - Freigabeberechtigungen und Empfänger werden geprüft, bevor Änderungen gespeichert werden
  • Icon - fileName ist optional und 1 bis 255 Zeichen lang. Der Typ wird aus dem Dateiinhalt gelesen. Ein Präfix data:<type>;base64, wird entfernt und zählt zur Zeichengrenze. Inhalt, der sich nicht als Bild lesen lässt, gibt 400 zurück
  • Name - Muss zwischen 1-80 Zeichen sein
  • Beschreibung - Maximal 800 Zeichen
  • Instruktion - Maximal 50000 Zeichen
  • Creativity - Muss zwischen 0 und 1 liegen

Wichtige Hinweise

Vorausgewählte OAuth-Verbindungen werden über die API nicht unterstützt. Benutzer müssen OAuth-Verbindungen über die Langdock-Benutzeroberfläche konfigurieren.
  • Erstellte Agenten werden automatisch mit deinem API-Schlüssel für die Verwendung in Chat-Completions geteilt
  • Der User, dem der API-Schlüssel gehört, wird zum Eigentümer und kann den Agenten in der Benutzeroberfläche verwalten
  • Anhänge sind bidirektional mit dem Agenten verknüpft
  • createdBy und workspaceId werden automatisch aus deinem API-Schlüssel übernommen

Antwortformat

agent.access ist nur enthalten, wenn der API-Schlüssel eine direkte Editor- oder Besitzerfreigabe für den Agenten hat. Es listet direkte Benutzer-, Gruppen- und Workspace-Freigaben auf, ohne Besitzer- und API-Schlüssel-Freigaben. sharingManagedByAdmin ist schreibgeschützt; bei true können Freigaben über diese API nicht geändert werden.

Erfolgreiche Antwort (201 Created)

Fehlerbehandlung

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.