当工作流中需要调用外部服务接口(如调用大模型 API 获取智能回复)、获取第三方数据(如查询天气、股票信息)、或与企业内部系统集成(如 CRM、ERP 接口对接)时,API 节点通过配置 HTTP 请求方式、请求头、参数和请求体,发起 HTTP 请求并获取响应结果,使工作流能够灵活连接各类外部服务。
在智能客服场景中,需要将用户输入的问题发送到外部大模型获取智能回复。通过配置 API 节点调用通义千问 API,实现用户问题到获取回复的完整流程。
快速接入API节点支持两种添加方式:
配置API的请求地址和请求方式。
单击添加变量可添加多个变量。
配置URL中的查询参数。查询参数位于URL中问号(?)之后,用于向API传递额外的信息。例如,在 https://api.example.com/files?limit=5 中,limit 是参数名,5 是参数值,表示限制返回 5 条数据。
单击添加变量可添加多个查询参数。
根据API要求选择请求体类型:
设置请求等待响应的最长时间。
默认开启。节点请求失败时自动重试。关闭后,请求失败将直接报错。
默认关闭。开启后可自定义异常时的处理逻辑。
将 API 响应结果存储到变量中,供后续节点引用。
将百炼应用服务IP地址(47.93.216.17 和 39.105.109.77)添加到目标服务器的安全组或防火墙入方向规则白名单中。
使用示例
在智能客服场景中,需要将用户输入的问题发送到外部大模型获取智能回复。通过配置 API 节点调用通义千问 API,实现用户问题到获取回复的完整流程。
添加节点
快速接入API节点支持两种添加方式:
- 通过加号按钮添加:点击节点末尾的加号按钮,从弹出列表中选择 API,节点自动添加并建立连线。
- 从节点库拖拽添加:从左侧节点管理面板的工具分类下,将 API 节点拖拽到画布,手动连接上下游节点。
节点配置
API地址
配置API的请求地址和请求方式。
| 参数 | 说明 |
|---|---|
| 请求方式 | 选择 HTTP 请求方法。支持 GET、POST、PUT、PATCH、DELETE,默认为 GET。 |
| URL地址 | 输入完整的API地址。支持直接输入或通过输入/插入变量引用上游节点的输出。 |
Header设置
| 列名 | 说明 |
|---|---|
| 变量名 | Header 名称,如 Authorization、Content-Type。 |
| 引用方式 | 选择引用(引用已有变量)或输入(直接输入值)。 |
| 值 | Header的值,根据引用方式选择变量或直接输入。 |
Param设置
配置URL中的查询参数。查询参数位于URL中问号(?)之后,用于向API传递额外的信息。例如,在 https://api.example.com/files?limit=5 中,limit 是参数名,5 是参数值,表示限制返回 5 条数据。
| 列名 | 说明 |
|---|---|
| 变量名 | 查询参数名称,如 limit、page、sort。 |
| 引用方式 | 选择引用(引用已有变量)或输入(直接输入值)。 |
| 值 | 查询参数的值,根据引用方式选择变量或直接输入。 |
Body设置
根据API要求选择请求体类型:
| 类型 | 说明 |
|---|---|
| none | 无请求体,适用于GET请求。 |
| form-data | 表单数据或文件上传,显示键值对配置表。 |
| raw | 默认选项。原始文本输入,如纯文本、XML。 |
| JSON | 自动格式化的JSON编辑器。 |
超时设置
设置请求等待响应的最长时间。
| 参数 | 范围 | 默认值 | 说明 |
|---|---|---|---|
| 超时时间 | 1-120 秒 | 5 | 超过此时间将触发超时错误。 |
失败时重试
默认开启。节点请求失败时自动重试。关闭后,请求失败将直接报错。
| 参数 | 范围 | 默认值 | 说明 |
|---|---|---|---|
| 最大重试次数 | 1-10 | 5 | 请求失败时的最大重试次数 |
| 重试间隔 | 300-10000 毫秒 | 300 | 每次重试之间的等待时间 |
异常处理
默认关闭。开启后可自定义异常时的处理逻辑。
| 选项 | 说明 |
|---|---|
| 默认值 | 异常时输出指定的默认内容。 |
| 异常分支 | 异常时执行异常分支流程,需为异常分支配置处理节点。 |
节点输出
将 API 响应结果存储到变量中,供后续节点引用。
| 变量名 | 类型 | 说明 |
|---|---|---|
| result | Object | API 响应结果,默认输出变量。可通过 JSON Schema 生成器快速定义输出结构,支持添加多个输出变量或为 Object 类型添加子变量。支持的变量类型:Array、Object、File、String、Number、Boolean。 |
| errorMessage | String | 错误信息。仅当开启异常处理并选择异常分支处理方式时存在。 |
常见用法
| 配合节点 | 常见用法 |
|---|---|
| 开始节点 → API节点 | 接收用户输入作为API请求参数。 |
| API节点 → 大模型节点 | 将API返回的数据作为大模型的上下文输入。 |
| API节点 → 条件判断节点 | 根据API返回结果进行分支处理。 |
| 循环节点 → API节点 | 批量调用API处理多条数据。 |