Skip to main content
POST
Creates a new 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.
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.
Erfordert einen API-Schlüssel mit dem AGENT_API Scope. Erstellte Agenten werden automatisch mit dem API-Schlüssel geteilt, um sie in Chat-Completions zu verwenden.

Anfrageparameter

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.

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.

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
  • Berechtigungen - Dein API-Schlüssel muss die createAgents Berechtigung haben
  • 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 Ersteller des API-Schlüssels 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

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.

Autorisierungen

Authorization
string
header
erforderlich

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Body

application/json
name
string
erforderlich

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>
Standard:PROMPT

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
Standard:0.3

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
Standard:false

Enable image generation

dataAnalyst
boolean
Standard:false
veraltet

Deprecated. Accepted for compatibility and ignored.

extendedThinking
boolean
Standard:false

Enable extended thinking

attachments
string<uuid>[]

Attachment UUIDs

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

Folder UUIDs

Antwort

201 - application/json

Agent created successfully

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