Tool の更新

指定した組織配下の Tool の基本情報、インターフェース定義、認証情報を更新できます。

本インターフェースを使用して、指定した組織配下の Tool の基本情報、インターフェース定義、認証情報を更新できます。

リクエストメソッド

PUT

リクエストURL

https://api.${endpoint}/v1/org/tool/update

リクエスト認証

アカウントレベルの DevKey / DevSecret による Basic 認証を使用します。呼び出しアカウントに組織 Tool の管理権限が必要です。

リクエスト

リクエスト例

curl -X PUT 'https://api.${endpoint}/v1/org/tool/update' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -H 'Content-Type: application/json' \ -d '{ "org_id": "p-xxxx", "tool_id": "tool-xxxx", "name": "weather", "display_name": "Weather Lookup", "description": "Query current weather", "logo": "https://cdn.example.com/weather.png", "url": "https://api.example.com", "show_request": true, "api_schema": "{\"openapi\":\"3.0.0\",\"paths\":{}}", "auth_provider": "Creator", "auth_type": "Bearer", "auth_key": "token" }'

                      
                      curl -X PUT 'https://api.${endpoint}/v1/org/tool/update' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "org_id": "p-xxxx",
    "tool_id": "tool-xxxx",
    "name": "weather",
    "display_name": "Weather Lookup",
    "description": "Query current weather",
    "logo": "https://cdn.example.com/weather.png",
    "url": "https://api.example.com",
    "show_request": true,
    "api_schema": "{\"openapi\":\"3.0.0\",\"paths\":{}}",
    "auth_provider": "Creator",
    "auth_type": "Bearer",
    "auth_key": "token"
  }'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Basic ${BASIC_TOKEN}	`DevKey:DevSecret` を Base64 エンコードした Basic Token を使用します。
Content-Type	application/json	リクエストボディの形式。

リクエストパラメータ（Body Parameters）

パラメータ	タイプ	説明	required
org_id	String	組織 ID。	true
tool_id	String	Tool ID。	true
name	String	Tool 名称、最大 20 文字。	true
display_name	String	Tool 表示名称、最大 50 文字。	false
description	String	Tool 説明、最大 100 文字。	true
logo	String	Tool アイコン URL。	true
url	String	Tool のベース URL。公開された `http/https` アドレスである必要があります。	true
show_request	Boolean	呼び出し過程でリクエスト内容を表示するかどうか。	true
api_schema	String	OpenAPI JSON Schema。指定しない場合はインターフェース定義を更新しません。	false
auth_provider	String	認証提供元。指定しない場合は認証設定を更新しません。	false
auth_type	String	認証タイプ。	false
auth_key	String	認証 key または token。	false
auth_key_name	String	認証 key の表示名称。	false
auth_key_tip	String	認証 key のヒント。	false
auth_secret	String	認証 secret。	false
auth_secret_name	String	認証 secret の表示名称。	false
auth_secret_tip	String	認証 secret のヒント。	false

レスポンス

レスポンス例

{ "code": 0, "message": "OK", "affect_count": 1 }

                      
                      {
  "code": 0,
  "message": "OK",
  "affect_count": 1
}

このコードブロックをポップアップで表示

成功時のレスポンス

フィールド	タイプ	説明
affect_count	Integer	影響を受けたレコード数。

エラー時のレスポンス

フィールド	タイプ	説明
code	Integer	エラーコード。
message	String	エラー詳細。

ステータスコード

ステータスコード	説明
200	成功
400	パラメータエラー
401	未認証
403	権限不足
429	リクエストが頻繁すぎます
500	サーバーエラー