สอบถามรายการ Tool / MCP

สอบถามรายการ Tool / MCP

รองรับการสอบถามรายการ Tool และ MCP ภายใต้องค์กรที่ระบุ

คุณสามารถใช้อินเทอร์เฟซนี้เพื่อสอบถามรายการ Tool และ MCP ภายใต้องค์กรที่ระบุ

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

GET

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

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

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

ใช้การยืนยันตัวตนแบบ Basic ด้วย DevKey / DevSecret ระดับบัญชี

การร้องขอ

ตัวอย่างการร้องขอ

curl -X GET 'https://api.${endpoint}/v1/org/tool/list?org_id=p-xxxx&plugin_type=TOOL&available=true&keyword=weather' \ -H 'Authorization: Basic ${BASIC_TOKEN}'
                      
                      curl -X GET 'https://api.${endpoint}/v1/org/tool/list?org_id=p-xxxx&plugin_type=TOOL&available=true&keyword=weather' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

                    
บล็อกโค้ดนี้ในหน้าต่างลอย

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

ฟิลด์ ประเภท คำอธิบาย
Authorization Basic ${BASIC_TOKEN} Basic Token ที่ได้จากการเข้ารหัส Base64 ของ DevKey:DevSecret

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

พารามิเตอร์ ประเภท คำอธิบาย required
org_id String ID ขององค์กร true
keyword String คำสำคัญ กรองตามชื่อหรือคำอธิบาย false
plugin_type String ประเภททรัพยากร รองรับ TOOL, MCP หากไม่ส่งมาจะคืนทั้ง Tool และ MCP false
available Boolean จะคืนเฉพาะทรัพยากรที่ใช้งานได้หรือไม่ได้เท่านั้นหรือไม่ false

การตอบกลับ

ตัวอย่างการตอบกลับ

{ "code": 0, "message": "OK", "data": [ { "resource_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", "plugin_type": "TOOL", "available": true, "action_count": 2, "create_time": 1785826041000, "update_time": 1785826041000 } ] }
                      
                      {
  "code": 0,
  "message": "OK",
  "data": [
    {
      "resource_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",
      "plugin_type": "TOOL",
      "available": true,
      "action_count": 2,
      "create_time": 1785826041000,
      "update_time": 1785826041000
    }
  ]
}

                    
บล็อกโค้ดนี้ในหน้าต่างลอย

การตอบกลับเมื่อสำเร็จ

ฟิลด์ ประเภท คำอธิบาย
resource_id String ID ของ Tool หรือ MCP
name String ชื่อทรัพยากร
display_name String ชื่อที่แสดง
description String คำอธิบาย
logo String URL ไอคอน
url String ที่อยู่บริการ
plugin_type String ประเภททรัพยากร TOOL หรือ MCP
available Boolean ใช้งานได้หรือไม่
action_count Integer จำนวน Action
create_time Long เวลาสร้าง เป็น timestamp หน่วยมิลลิวินาที
update_time Long เวลาอัปเดต เป็น timestamp หน่วยมิลลิวินาที

การตอบกลับเมื่อผิดพลาด

ฟิลด์ ประเภท คำอธิบาย
code Integer รหัสข้อผิดพลาด
message String รายละเอียดข้อผิดพลาด

รหัสสถานะ

รหัสสถานะ คำอธิบาย
200 สำเร็จ
400 พารามิเตอร์ไม่ถูกต้อง
401 ไม่ได้รับอนุญาต
403 สิทธิ์ไม่เพียงพอ
429 คำขอถี่เกินไป
500 ข้อผิดพลาดของเซิร์ฟเวอร์