Appearance
工具列表
接口说明
按 service slug 列出该服务下的全部工具,包括每个工具的入参 schema。调用 invoke 接口前,应先通过本接口确认入参字段。
- 接口路径:
GET /v1/openapi/third-party-service/:service/tools
请求头
| 参数名 | 必填 | 说明 |
|---|---|---|
| Authorization | 是 | 鉴权凭证,格式 Bearer sk_xxx |
请求参数
路径参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
service | string | 是 | 服务 slug,如 tavily_search,可通过服务列表接口获取 |
请求体
本接口为 GET 请求,无请求体,仅需鉴权头。
成功响应示例(节选 tavily_search 服务)
json
{
"code": 200,
"data": {
"service": {
"name": "tavily_search",
"display_name": "Tavily搜索",
"description": "专为 AI 设计的搜索引擎,支持多种搜索:网页搜索、提取网站内容、爬取站点和图像,可返回结构化结果或上下文。",
"category": "基础工具",
"need_credentials": true,
"is_configured": true,
"tool_count": 5
},
"tools": [
{
"name": "tavily_search",
"label": "Tavily 搜索",
"description": "使用 Tavily 搜索引擎执行智能搜索,返回与查询最相关的网页结果和摘要。专为 AI 优化,支持多种搜索深度和主题分类。",
"parameters": [
{
"name": "query",
"label": "搜索关键词",
"type": "string",
"required": true,
"description": "搜索关键词"
},
{
"name": "max_results",
"label": "最大结果数",
"type": "number",
"required": false,
"description": "返回结果数量(1-20)",
"default": 5
},
{
"name": "search_depth",
"label": "搜索深度",
"type": "string",
"required": false,
"description": "basic(标准) / advanced(深度,2 倍积分) / fast(快速)",
"default": "basic",
"enum": ["basic", "advanced", "fast"]
}
]
}
]
},
"message": "success",
"trace_id": "b4971d788772da3da8358ecb4e77b87d"
}data 字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
service | object | 服务概要,字段同服务列表单条数据 |
tools | array | 工具列表 |
tools[].name | string | 工具 slug,用于拼接 URL 中的 :tool |
tools[].label | string | 工具展示名称 |
tools[].description | string | 工具用途说明 |
tools[].parameters | array | 工具入参字段定义 |
tools[].parameters[].name | string | 入参字段名(即 inputs 中的 key) |
tools[].parameters[].label | string | 字段展示名称 |
tools[].parameters[].type | string | 字段类型;常见值 string / number / boolean;与平台插件管理规范一致 |
tools[].parameters[].required | bool | 是否必填 |
tools[].parameters[].description | string | 字段说明 |
tools[].parameters[].enum | array | 枚举可选值(可选) |
tools[].parameters[].default | any | 默认值(可选) |
失败响应示例
json
{
"code": 0,
"data": null,
"message": "服务不存在",
"trace_id": "e3302bb5788035dec7160e58d2261824"
}调用示例
bash
curl -X GET 'https://runtime-api.invalid/v1/openapi/third-party-service/tavily_search/tools' \
-H 'Authorization: Bearer sk_your_api_key'