Assistant Create API
Einen neuen Assistenten programmatisch erstellen
Erstellt einen neuen Assistenten in deinem Workspace programmatisch. Der erstellte Assistent kann über den Chat-Completions-Endpunkt verwendet oder über die Langdock-Benutzeroberfläche aufgerufen werden.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.
AGENT_API Scope. Erstellte Assistenten werden automatisch mit dem API-Schlüssel geteilt, um sie in Chat-Completions zu verwenden.Anfrageparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | Ja | Name des Assistenten (1-80 Zeichen) |
description | string | Nein | Beschreibung der Assistentenfunktion (max. 500 Zeichen) |
emoji | string | Nein | Emoji-Icon für den Assistenten (z.B. ”🤖“) |
instruction | string | Nein | Systemanweisung/Instruktionen für den Assistenten (max. 40000 Zeichen) |
inputType | string | Nein | Eingabetyp: “PROMPT” oder “STRUCTURED” (Standard: “PROMPT”) |
model | string | Nein | Zu verwendende Modell-UUID (verwendet Workspace-Standard wenn nicht angegeben) |
creativity | number | Nein | Temperatur zwischen 0-1 (Standard: 0.3) |
conversationStarters | string[] | Nein | Array von vorgeschlagenen Prompts zum Einstieg |
actions | array | Nein | Array von Action-Objekten für benutzerdefinierte Integrationen |
inputFields | array | Nein | Array von Formularfeld-Definitionen (für STRUCTURED Eingabetyp) |
attachments | string[] | Nein | Array von Anhang-UUIDs für den Assistenten |
webSearch | boolean | Nein | Websuche-Fähigkeit aktivieren (Standard: false) |
imageGeneration | boolean | Nein | Bildgenerierungs-Fähigkeit aktivieren (Standard: false) |
dataAnalyst | boolean | Nein | Code-Interpreter-Fähigkeit aktivieren (Standard: false) |
canvas | boolean | Nein | Canvas-Fähigkeit aktivieren (Standard: false) |
extendedThinking | boolean | Nein | Extended-Thinking-Modus aktivieren (Standard: false) |
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 (Standard: true)
Eingabefelder-Konfiguration
Bei Verwendung voninputType: "STRUCTURED" kannst du Formularfelder im inputFields Array definieren:
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
slug | string | Ja | Eindeutiger Bezeichner für das Feld |
type | string | Ja | Feldtyp (siehe unterstützte Typen unten) |
label | string | Ja | Anzeigebezeichnung für das Feld |
description | string | Nein | Hilfetext für das Feld |
required | boolean | Nein | Ob das Feld erforderlich ist (Standard: false) |
order | number | Ja | Anzeigereihenfolge (0-indiziert) |
options | string[] | Nein | Optionen für SELECT-Feldtypen |
fileTypes | string[] | Nein | Erlaubte Dateitypen für FILE-Feldtypen |
emailDomain | string | Nein | Erlaubte E-Mail-Domain für EMAIL-Feldtypen |
TEXT- Einzeilige TexteingabeMULTI_LINE_TEXT- Mehrzeiliger TextbereichNUMBER- Numerische EingabeCHECKBOX- Boolean-CheckboxFILE- Datei-UploadSELECT- Dropdown-AuswahlDATE- DatumsauswahlEMAIL- E-Mail-Adresse
Anhangs-IDs abrufen
Um Anhänge in deinen Assistenten einzubinden, lade zuerst Dateien mit der Upload Attachment API hoch. Dies gibt Anhang-UUIDs zurück, die du imattachments Array verwenden kannst.
Beispiele
Einen einfachen Assistenten 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
- Berechtigungen - Dein API-Schlüssel muss die
createAssistantsBerechtigung haben - Name - Muss zwischen 1-80 Zeichen sein
- Beschreibung - Maximal 500 Zeichen
- Instruktion - Maximal 40000 Zeichen
- Creativity - Muss zwischen 0 und 1 liegen
Wichtige Hinweise
- Erstellte Assistenten 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 Assistenten in der Benutzeroberfläche verwalten
- Anhänge sind bidirektional mit dem Assistenten verknüpft
- Der Assistenten-Typ wird auf
AGENTgesetzt (nichtWORKFLOWoderPROJECT) createdByundworkspaceIdwerden automatisch aus deinem API-Schlüssel übernommen
Antwortformat
Erfolgreiche Antwort (201 Created)
Fehlerbehandlung
Migration zur Agents API
Die neue Agents API bietet verbesserte Kompatibilität mit modernen AI SDKs. Der Create-Endpunkt hat ähnliche Funktionalität mit aktualisierten Parameternamen. Siehe den entsprechenden Endpunkt in der Agents API:- Agent Create API - Verwendet
agentIdstattassistantId
Autorisierungen
API key as Bearer token. Format "Bearer YOUR_API_KEY"
Body
Name of the agent
1 - 255Description of what the agent does
256Emoji icon for the agent (e.g., "🤖")
System prompt/instructions for the agent
16384Input type for the agent
PROMPT, STRUCTURED Model ID to use (see Models for Agent API)
Temperature for response generation
0 <= x <= 1Array of suggested prompts to help users get started
Array of action objects for custom integrations
Array of form field definitions (for STRUCTURED input type)
Array of attachment UUIDs to include with the agent
Enable web search capability
Enable image generation capability
Enable code interpreter capability
Enable canvas capability