Skill 一覧の照会

指定した組織配下の Skill 一覧を照会できます。

本インターフェースを使用して、指定した組織配下の Skill 一覧を照会できます。

リクエストメソッド

GET

リクエストURL

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	サーバーエラー