Organisations-Skill per API erstellen
Organisations-Skill per API erstellen
Ermöglicht das Erstellen eines organisationsweiten Skill innerhalb einer bestimmten Organisation. Über diese Schnittstelle können Sie innerhalb einer bestimmten Organisation einen organisationsweiten Skill erstellen.
- Es werden nur
.skillund.zipakzeptiert; das Archiv darf maximal 20 MiB groß sein. - Im Wurzelverzeichnis des Pakets oder im einzigen obersten Verzeichnis muss
SKILL.mdenthalten sein, dessen Frontmatternameenthalten muss. - Nach erfolgreicher Erstellung aktualisieren Sie den Skill über
POST /v1/org/skill/update, indem Sieskill_idin den Form Data übergeben.
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}' \
-F 'org_id=org-xxxx' \
-F 'file=@/path/to/refund-policy.skill'
curl -X POST 'https://api.${endpoint}/v1/org/skill/create' \
-H 'Authorization: Basic ${BASIC_TOKEN}' \
-F 'org_id=org-xxxx' \
-F 'file=@/path/to/refund-policy.skill'
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 | Erforderlich | Beschreibung |
|---|---|---|---|
org_id |
String | Ja | ID der Organisation, in der der geteilte Skill erstellt werden soll. |
file |
File | Ja | .skill- oder .zip-Skill-Paket. |
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 |
