Assistant Create API
Einen neuen Assistenten programmatisch erstellen
AGENT_API Scope. Erstellte Assistenten werden automatisch mit dem API-Schlüssel geteilt, um sie in Chat-Completions zu verwenden.Anfrageparameter
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:
TEXT- Einzeilige TexteingabeMULTI_LINE_TEXT- Mehrzeiliger TextbereichNUMBER- Numerische EingabeCHECKBOX- Boolean-CheckboxFILE- Datei-UploadSELECT- Dropdown-AuswahlMULTI_SELECT- MehrfachauswahlDATE- 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
- Ordner - 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 800 Zeichen
- Instruktion - Maximal 50000 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
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 - 80Description of what the agent does
800Emoji icon for the agent (e.g., "🤖")
16System prompt/instructions for the agent
50000Input type for the agent
PROMPT, STRUCTURED, INTEGRATION, SCHEDULED, WEBHOOK Model ID to use (see Models for Agent API)
Temperature for response generation
0 <= x <= 1Array of suggested prompts to help users get started
201 - 255Array of action objects for custom integrations
Array of form field definitions (for STRUCTURED input type)
Array of attachment UUIDs to include with the agent
50Array of Folder UUIDs to include with the agent
Enable web search capability
Enable image generation capability
Deprecated. Accepted for compatibility and ignored.
Enable extended thinking