查詢 Skill 列表
查詢 Skill 列表
支援查詢指定組織下的 Skill 列表。
可以透過該 API,查詢指定組織下的 Skill 列表。
請求方式
GET
調用地址
https://api.${endpoint}/v1/org/skill/list
調用驗證
使用帳號級 DevKey / DevSecret 的 Basic 驗證。
請求
請求範例
curl -X GET 'https://api.${endpoint}/v1/org/skill/list?org_id=p-xxxx&keyword=refund&owner_type=ORGANIZATION&enable=true' \
-H 'Authorization: Basic ${BASIC_TOKEN}'
curl -X GET 'https://api.${endpoint}/v1/org/skill/list?org_id=p-xxxx&keyword=refund&owner_type=ORGANIZATION&enable=true' \
-H 'Authorization: Basic ${BASIC_TOKEN}'
此代碼塊在浮窗中顯示
請求標頭
| 欄位 | 類型 | 說明 |
|---|---|---|
| Authorization | Basic ${BASIC_TOKEN} | 使用 DevKey:DevSecret Base64 後的 Basic Token。 |
| Locale | String | 可選。回應文案語言,預設 en_US。 |
請求參數(Query Parameters)
| 參數 | 類型 | 說明 | required |
|---|---|---|---|
| org_id | String | 組織 ID。 | true |
| keyword | String | 關鍵字。 | false |
| category_id | String | Skill 分類 ID。 | false |
| owner_type | String | Skill 歸屬類型,如 ORGANIZATION。 |
false |
| owner_agent_id | String | 私有 Skill 歸屬 Agent ID。 | false |
| enable | Boolean | 是否只回傳啟用或停用的 Skill。 | false |
回應
回應範例
{
"code": 0,
"message": "OK",
"data": [
{
"id": "skill-xxxx",
"name": "refund-policy",
"display_name": "退款政策",
"owner_type": "ORGANIZATION",
"enable": true
}
]
}
{
"code": 0,
"message": "OK",
"data": [
{
"id": "skill-xxxx",
"name": "refund-policy",
"display_name": "退款政策",
"owner_type": "ORGANIZATION",
"enable": true
}
]
}
此代碼塊在浮窗中顯示
成功回應
回應項目沿用控制台 Skill 列表欄位,包含 Skill ID、名稱、描述、歸屬方、分類、版本、啟用狀態等資訊。
失敗回應
| 欄位 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤碼。 |
| message | String | 錯誤詳情。 |
狀態碼
| 狀態碼 | 說明 |
|---|---|
| 200 | 成功 |
| 400 | 參數錯誤 |
| 401 | 未授權 |
| 403 | 權限不足 |
| 429 | 請求過於頻繁 |
| 500 | 伺服器錯誤 |
