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
Parameter
Zugriffskonfiguration
Mitaccess 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. Setzeroleeines Eintrags aufnull, 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
accessnicht geändert werden.
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)
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.requiresConfirmationist optional (Standard: false). - Lass das Feld weg oder sende
[], um nichts anzuhängen. DoppelteagentId-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 voninputType: "STRUCTURED" kannst du Formularfelder im inputFields Array definieren:
Unterstützte Feldtypen:
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 Agenten 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 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
agentIdmuss 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
createAgentsBerechtigung haben - Freigaben - Freigabeberechtigungen und Empfänger werden geprüft, bevor Änderungen gespeichert werden
- Icon -
fileNameist optional und 1 bis 255 Zeichen lang. Der Typ wird aus dem Dateiinhalt gelesen. Ein Präfixdata:<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
- 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
createdByundworkspaceIdwerden 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.