Skill erstellen

Ermöglicht das Erstellen eines organisationsweiten Skill oder eines privaten Skill für einen bestimmten Agent innerhalb einer Organisation.

Über diese Schnittstelle können Sie innerhalb einer bestimmten Organisation einen organisationsweiten Skill erstellen oder einen privaten Skill für einen bestimmten Agent anlegen.

Anfragemethode

POST

Anfrage-URL

https://api.${endpoint}/v1/org/skill/create

Authentifizierung der Anfrage

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

Anfrage

Beispielanfrage

curl -X POST 'https://api.${endpoint}/v1/org/skill/create' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -H 'Content-Type: application/json' \ -d '{ "org_id": "p-xxxx", "name": "refund-policy", "display_name": "退款政策", "description": { "en_US": "Handling customer refund requests", "zh_CN": "处理客户退款请求" }, "owner_agent_id": "bot-xxxx" }'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/skill/create' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "org_id": "p-xxxx",
    "name": "refund-policy",
    "display_name": "退款政策",
    "description": {
      "en_US": "Handling customer refund requests",
      "zh_CN": "处理客户退款请求"
    },
    "owner_agent_id": "bot-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	application/json	Format des Anfrage-Body.

Anfrageparameter (Body Parameters)

Parameter	Typ	Beschreibung	required
org_id	String	Organisations-ID.	true
name	String	Skill-Name, maximal 50 Zeichen.	true
display_name	String	Anzeigename des Skill, maximal 50 Zeichen.	false
description	Object	Mehrsprachige Beschreibung des Skill, muss `en_US` enthalten.	true
owner_agent_id	String	Agent-ID, zu der der private Skill gehört. Bei fehlender Angabe wird ein organisationsweiter Skill erstellt.	false

Antwort

Beispielantwort

{ "code": 0, "message": "OK", "data": { "skill_id": "skill-xxxx", "name": "refund-policy", "owner_type": "ORGANIZATION" } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "skill_id": "skill-xxxx",
    "name": "refund-policy",
    "owner_type": "ORGANIZATION"
  }
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
skill_id	String	ID des neu erstellten Skill.
name	String	Skill-Name.
owner_type	String	Zugehörigkeitstyp des Skill.

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