Agent importieren und erstellen

Ermöglicht das Hochladen einer .bot-Datei und deren Import als Agent innerhalb einer Organisation.

Über diese Schnittstelle können Sie eine .bot-Datei hochladen und als Agent innerhalb einer Organisation importieren. Nach erfolgreichem Import wird automatisch ein API Key erstellt, für diesen Key ist die Versionsverwaltung jedoch standardmäßig deaktiviert.

Anfragemethode

POST

Anfrage-URL

https://api.${endpoint}/v1/org/agent/import

Authentifizierung der Anfrage

Basic-Authentifizierung mit DevKey / DevSecret auf Kontoebene; das aufrufende Konto muss über die Berechtigung zum Erstellen von Agent der Organisation verfügen.

Anfrage

Beispielanfrage

curl -X POST 'https://api.${endpoint}/v1/org/agent/import' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -F 'file=@/path/to/agent.bot' \ -F 'org_id=p-xxxx' \ -F 'custom_name=Imported Agent' \ -F 'enable_api=true' \ -F 'group_id=group-xxxx'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/agent/import' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -F 'file=@/path/to/agent.bot' \
  -F 'org_id=p-xxxx' \
  -F 'custom_name=Imported Agent' \
  -F 'enable_api=true' \
  -F 'group_id=group-xxxx'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Basic ${BASIC_TOKEN}	Basic Token als Base64-Kodierung von `DevKey:DevSecret`.
Content-Type	multipart/form-data	Formular für den Datei-Upload.

Anfrageparameter (Form Data)

Parameter	Typ	Beschreibung	required
file	File	`.bot`-Datei. MultiAgent-Dateien werden nicht unterstützt.	true
org_id	String	Organisations-ID.	true
custom_name	String	Benutzerdefinierter Agent-Name nach dem Import.	false
enable_api	Boolean	Ob versucht wird, die API zu aktivieren; Standard `true`. Unterstützt der Tarif keine API, ist der Import dennoch erfolgreich und gibt `api_enabled=false` zurück.	false
group_id	String	Nach erfolgreichem Import Beitritt zur angegebenen Agent-Gruppe.	false

Antwort

Beispielantwort

{ "code": 0, "message": "OK", "data": { "agent_id": "bot-xxxx", "name": "Imported Agent", "bot_type": "AGENT", "api_key": "app-xxxx", "api_enabled": true, "version_manage_enabled": false, "warning": null } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "agent_id": "bot-xxxx",
    "name": "Imported Agent",
    "bot_type": "AGENT",
    "api_key": "app-xxxx",
    "api_enabled": true,
    "version_manage_enabled": false,
    "warning": null
  }
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
agent_id	String	ID des importierten Agent.
name	String	Agent-Name.
bot_type	String	Agent-Typ: `Agent`, `FlowAgent`, `LoopAgent`, `Audio`.
api_key	String	Automatisch erstellter API Key, wird nur einmal zurückgegeben. Dieser Key besitzt keine Veröffentlichungsberechtigung; für Veröffentlichungen muss ein Key manuell erstellt werden.
api_enabled	Boolean	Ob die API aktiviert ist.
version_manage_enabled	Boolean	Ob die Versionsverwaltung zulässig ist; beim Import standardmäßig deaktiviert.
warning	String	Warnhinweis beim Import.

Fehlerantwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlerdetails.

Statuscodes

Statuscode	Beschreibung
200	Erfolgreich
400	Ungültige Parameter
401	Nicht autorisiert
403	Unzureichende Berechtigungen
429	Zu viele Anfragen
500	Serverfehler