Tool の作成

指定した組織配下に Tool を作成し、OpenAPI Schema から actions を自動生成できます。

本インターフェースを使用して、指定した組織配下に Tool を作成できます。api_schema を渡すと同時に actions を生成し、渡さない場合は Tool の枠のみを作成します。

リクエストメソッド

POST

リクエストURL

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

リクエスト認証

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

リクエスト

リクエスト例

curl -X POST 'https://api.${endpoint}/v1/org/tool/create' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -H 'Content-Type: application/json' \ -d '{ "org_id": "p-xxxx", "name": "weather", "display_name": "Weather Lookup", "description": "Query current weather by city name", "logo": "https://cdn.example.com/weather.png", "url": "https://api.example.com", "show_request": true, "api_schema": "{\"openapi\":\"3.0.0\",\"paths\":{}}" }'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/tool/create' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "org_id": "p-xxxx",
    "name": "weather",
    "display_name": "Weather Lookup",
    "description": "Query current weather by city name",
    "logo": "https://cdn.example.com/weather.png",
    "url": "https://api.example.com",
    "show_request": true,
    "api_schema": "{\"openapi\":\"3.0.0\",\"paths\":{}}"
  }'

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

リクエストヘッダー

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

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

パラメータ	タイプ	説明	required
org_id	String	組織 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。渡すと actions を生成し、成功後 `available=true`。渡さない場合は `available=false`。	false

レスポンス

レスポンス例

{ "code": 0, "message": "OK", "data": { "tool_id": "tool-xxxx", "name": "weather", "available": true } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "tool_id": "tool-xxxx",
    "name": "weather",
    "available": true
  }
}

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

成功時のレスポンス

フィールド	タイプ	説明
tool_id	String	新規作成した Tool ID。
name	String	Tool 名称。
available	Boolean	Tool が利用可能かどうか。

エラー時のレスポンス

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

ステータスコード

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