登录coze→资源库→插件→创建插件,填名称、描述、选云侧插件,url只填根路径(如https://api.company.com/v2/employee/);添加工具时用url解析法或手动配置,参数名大小写敏感且禁用点号/中划线;绑定变量、设content-type、自动解析响应并补全字段描述;调试通过后发布,再在bot中添加并映射参数即可调用。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你想把自有API服务快速接入扣子平台,让智能体能直接调用查天气、读数据库或发通知,但卡在插件创建、URL填错、参数映射失败或调试一直“未通过”上——这篇文章只讲从登录到调试成功的完整路径,不绕弯,不讲概念堆砌,每一步都对应真实界面操作和易错点。
创建插件容器并配置服务根地址
登录Coze工作空间→点击左侧导航栏【资源库】→切换至【插件】标签页→点击【创建插件】按钮。
在弹出表单中填写:插件名称(如“内部用户查询服务”)、插件描述(如“调用公司HR系统获取员工基础信息”)、插件类型必须选【云侧插件】→【基于已有服务创建】。
【插件URL必须填服务的根路径,不是完整接口地址】。例如你的API完整地址是 https://api.company.com/v2/employee/detail?id=123,则此处只填 https://api.company.com/v2/employee/ ——多一个斜杠或少一个斜杠都会导致后续所有工具请求404。
授权方式按实际选:若API无需Token或密钥,选“不需要授权”;若需固定密钥,选“Service”,并在下方密钥字段填入Header名(如X-API-Key)和值(如abc123def);OAuth暂不推荐新手使用。
为插件添加第一个工具(对应一个API端点)
插件创建成功后,页面自动跳转至该插件详情页→点击【添加工具】。
方法一:手动配置法
工具名称填接口路径末段,如 /detail → Coze会自动拼接为 https://api.company.com/v2/employee/detail;
工具描述写清用途,如“根据员工ID查询详细档案”;
请求方法选GET/POST(务必与你后端一致,POST却填GET会导致空body);
点击【下一步:配置输入参数】。
方法二:URL解析法(适合GET接口)
直接在“请求URL”框中粘贴完整测试地址,如 https://api.company.com/v2/employee/detail?id=123;
Coze会自动识别路径和查询参数,生成id字段并标记为“用户可输入”;
注意:此法仅解析URL中显式出现的参数,header或body参数仍需手动补全。
配置输入参数并绑定变量
第一步:点击【新增参数】→参数名称填id(必须与API文档要求的字段名完全一致,大小写敏感)→参数类型选“字符串”或“数字”→勾选【用户可输入】。
第二步:在【变量绑定】下拉菜单中,选择Bot内已定义的变量(如#user_id)或留空让最终用户手动输入;
若选“用户可输入”但未绑定变量,Bot运行时会弹出输入框,影响自动化流程。
第三步:对POST接口,还需在【请求体】区域点击【添加字段】,设置JSON key(如employee_id)和对应变量(如#user_id),并确保Content-Type Header已设为application/json。
提示:参数名里带点号(如user.profile.name)或中划线(如api-key)极易引发解析失败,建议统一用下划线。
配置输出参数并调试验证
保存输入参数后,进入【响应处理】页→在“成功状态码”填200(或你API实际返回的正确码,如201)→点击【自动解析】按钮。
Coze会向你填写的URL发起一次真实GET请求(带当前配置的所有参数),并尝试解析返回的JSON结构;
若返回非JSON(如HTML错误页)、证书不可信(HTTP而非HTTPS)、或域名未备案,将直接显示“调试未通过”,且不提示具体原因。
自动解析成功后,列表中会出现如code、data、message等字段;
为每个关键字段填写【参数描述】,例如data字段描述写“员工信息对象,含name、dept、phone等子字段”;
这一步不是可选项——缺少描述会导致Bot无法在自然语言回复中引用该字段。
点击【运行调试】:输入测试值(如id填1001)→观察右侧返回结果是否符合预期;
若返回空白或报错,立即检查网络连通性、HTTPS证书有效性、以及插件URL末尾是否有冗余斜杠。
发布插件并绑定到Bot
调试通过后,点击右上角【发布】按钮→插件状态变为“已发布”,此时仅自己工作空间可用。
打开目标Bot编辑页→点击左侧【工具】→点击【添加工具】→在搜索框输入你刚发布的插件名称→勾选对应工具→点击【确认添加】。
在Bot工作流中拖入【调用工具】节点→选择该工具→在参数映射区,将#user_id等变量拖入id输入框;
保存并启用Bot,即可实测调用效果。
大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!











