开发工具/API 参考/插件/调用插件工具
调用插件工具
更新于: 2026-06-25 19:29:14
调用指定付费插件中的工具。
|
请求方式 |
POST |
|---|---|
|
请求地址 |
|
|
权限 |
|
|
接口说明 |
调用付费插件工具。 |
|
参数 |
取值 |
说明 |
|---|---|---|
|
Authorization |
Bearer $Access_Token |
用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌,详细信息,参考准备工作。 |
|
Content-Type |
application/json |
解释请求正文的方式。 |
|
参数 |
类型 |
是否必选 |
示例 |
说明 |
|---|---|---|---|---|
|
plugin_id |
String |
必选 |
75458732632938*** |
待执行的插件 ID。你可以调用查询插件列表 API 获取对应的插件 ID,即 |
|
参数 |
类型 |
是否必选 |
示例 |
说明 |
|---|---|---|---|---|
|
tool_name |
String |
必选 |
getToutiaoNews |
插件工具的名称。你可以通过查询插件详情 API 获取。 |
|
arguments |
Map[String, Any] |
必选 |
{ “q”: “杭州秋假” } |
请根据对应插件工具的输入参数结构,输入相应参数的键值对。 |
|
参数 |
类型 |
示例 |
说明 |
|---|---|---|---|
|
data.result |
map |
\ |
插件工具的返回结果,具体由插件的返回结构体定义。 |
|
参数 |
类型 |
示例 |
说明 |
|---|---|---|---|
|
detail |
Object of ResponseDetail |
{“logid”:“20241210152726467C48D89D6DB2****”} |
包含请求的详细信息的对象,主要用于记录请求的日志 ID 以便于排查问题。 |
|
code |
Long |
0 |
调用状态码。0 表示调用成功,其他值表示调用失败,你可以通过 msg 字段判断详细的错误原因。 |
|
msg |
String |
“” |
状态信息。API 调用失败时可通过此字段查看详细错误信息。 |
|
参数 |
类型 |
示例 |
说明 |
|---|---|---|---|
|
logid |
String |
20241210152726467C48D89D6DB2**** |
本次请求的日志 ID。如果遇到异常报错场景,且反复重试仍然报错,可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持。 |
curl --location --request POST 'https://api.coze.cn/v1/plugins/7545873263293***/tools/call' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer pat_3UXDHN82MgQANqK****' \
--data-raw '{
"tool_name": "getToutiaoNews",
"arguments": {
"q": "杭州秋假"
}
}'
{
"code": 0,
"msg": "",
"data": {
"result": {
"news": [
{
"time": "2025-09-19 15:02",
"url": "https://toutiao.com/group/75516909358***/",
"summary": "2025 年秋假安排:杭州市多城区 2025 年中小学秋假时间定为 9 月 28 日 - 30 日共 3 天,9 月 27 日上课。加上国庆、中秋假期,最长可连休 11 天",
"media_name": "长江日报",
"categories": [
"news_society/news_law/statute",
"news_society/negative_energy_society",
"news_society/news_law",
"legal",
"news_society"
],
"title": "杭州中小学秋假相关信息",
"cover": ""
}
]
}
},
"detail": {
"logid": "20250926192926C176DEC5A***"
}
}
如果成功调用扣子编程的 API,返回信息中 code 字段为 0。如果状态码为其他值,则表示接口调用失败。此时 msg 字段中包含详细错误信息,你可以参考错误码文档查看对应的解决方法。