อัปเดต Tool

รองรับการอัปเดตข้อมูลพื้นฐาน คำนิยามอินเทอร์เฟซ และข้อมูลการยืนยันตัวตนของ Tool ภายใต้องค์กรที่ระบุ

คุณสามารถใช้อินเทอร์เฟซนี้เพื่ออัปเดตข้อมูลพื้นฐาน คำนิยามอินเทอร์เฟซ และข้อมูลการยืนยันตัวตนของ Tool ภายใต้องค์กรที่ระบุ

วิธีการร้องขอ

PUT

URL สำหรับร้องขอ

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

การยืนยันตัวตนในการร้องขอ

ใช้การยืนยันตัวตนแบบ Basic ด้วย DevKey / DevSecret ระดับบัญชี และกำหนดให้บัญชีที่เรียกใช้ต้องมีสิทธิ์จัดการ 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}	Basic Token ที่ได้จากการเข้ารหัส Base64 ของ `DevKey:DevSecret`
Content-Type	application/json	รูปแบบของเนื้อหาคำขอ

พารามิเตอร์การร้องขอ (Body Parameters)

พารามิเตอร์	ประเภท	คำอธิบาย	required
org_id	String	ID ขององค์กร	true
tool_id	String	ID ของ Tool	true
name	String	ชื่อ Tool สูงสุด 20 อักขระ	true
display_name	String	ชื่อที่แสดงของ Tool สูงสุด 50 อักขระ	false
description	String	คำอธิบาย Tool สูงสุด 100 อักขระ	true
logo	String	URL ไอคอนของ Tool	true
url	String	URL พื้นฐานของ Tool ต้องเป็นที่อยู่ `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
}