工作流运行接口
版本要求: 标准版 及以上
介绍
该接口为用于 工作流运行 的高级接口,相较于 通用对话接口 中的工作流运行有以下额外特性:
- 支持传入开始节点中的自定义变量
- 支持图片类型和文件类型参数的输入
- 支持工作流节点中开启的上下文记忆
在线接口调试:API接口调试
接口定义
接口地址
POST https://api.link-ai.tech/v1/workflow/run
请求头
参数 | 取值 | 说明 |
---|---|---|
Authorization | Bearer YOUR_API_KEY | 参考 接口鉴权说明 创建 API Key 并填入 |
Content-Type | application/json | 表明使用JSON格式请求 |
请求体
参数 | 类型 | 是否必传 | 说明 |
---|---|---|---|
app_code | string | 是 | 工作流的唯一 code |
args | dict | 否 | 工作流输入变量,包括系统默认变量和自定义变量,在开始节点中定义 |
session_id | string | 否 | 会话ID,每个session_id有独立的上下文记忆存储,大模型、应用或意图识别节点开启记忆后即可使用。若该字段不填则系统会自动分配一个唯一标识,在响应中返回,下次请求时可传入该值 |
说明:
1.开始节点中支持的系统变量有 文字输入、图片输入、文件输入,参数名如下:
input_text # 文字输入
input_image # 图片url(需公开网络可访问)
input_file # 文件url(需公开网络可访问)
系统参数可选择是否开启,开启后在 args
参数中传入即可,关闭后可不传改参数:
2.开始节点中还支持添加 自定义变量:
新增变量时可设置变量英文名,api调用时通过args参数传入即可:
请求示例:
{
"app_code": "G7z6vKwp",
"args": {
"input_text": "", # 系统默认变量
"height": "1.8", # 自定义变量
"weight": "75" # 自定义变量
}
}
注意:
app_code
:需换成你自己创建应用的code、应用广场中公开应用的codeargs
: 填入流程中需要的系统变量或自定义变量的值
示例工作流地址:https://link-ai.tech/app/T8kjAqQw7o
响应结果
output_text
字段中为工作流的文本输出:
{
"success": true,
"code": 200,
"message": "success",
"data": {
"output_text": "您好!您的BMI值是23.15,这个结果处于正常范围(18.5-23.9之间)。恭喜您,保持在这个范围内是健康的标志!\n\n为了进一步维护您的健康,建议您继续保持均衡的饮食和适量的运动。可以考虑增加一些富含纤维的食物,比如水果、蔬菜和全谷物,同时减少高糖和高脂肪食物的摄入。此外,每周至少进行150分钟的中等强度锻炼,比如快走、游泳或骑自行车,都是非常有益的。"
}
}
错误说明
当接口异常时会返回以下结构:
{
"success": false,
"code": 408,
"message": "当前版本无该API访问权限",
"data": null
}
根据 HTTP状态码 (status code) 和错误信息 判断错误类型:
HTTP状态码 | 描述 |
---|---|
400 | 请求格式错误 |
401 | 接口鉴权失败,请检查 API Key 是否填写正确 |
402 | 应用不存在,请检查 app_code 参数是否正确 |
403 | 无访问权限,对于未公开应用,只有创建者账号才能调用 |
406 | 账号积分额度不足 |
408 | 无API访问权限,该API支持标准版及以上版本调用 |
409 | 内容审核不通过,问题、回答、检索的知识库中可能存在敏感词 |
503 | 接口调用异常,联系客服处理 |
示例代码
1.CURL请求
curl -X POST "https://api.link-ai.tech/v1/workflow/run" \
-H "Content-Type: application/json" \
-H "authorization: Bearer YOUR_API_KEY" \
-d '{
"app_code": "T8kjAqQw7o",
"args": {
"height": "1.8",
"weight": "75"
}
}'
注意:在 YOUR_API_KEY
处填入你创建的 API Key
,在 app_code
中填入你创建的工作流code。
示例工作流地址:https://link-ai.tech/app/T8kjAqQw7o
2.Python代码请求
import requests
url = "https://api.link-ai.tech/v1/workflow/run"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
}
body = {
"app_code": "T8kjAqQw7o",
"args": {
"height": "1.8",
"weight": "75"
}
}
res = requests.post(url, json=body, headers=headers)
if res.status_code == 200:
res_json = res.json()
reply_text = res_json.get("data").get("output_text")
print(f"result={reply_text}")
else:
error = res.json()
print(f"请求异常, 错误码={error.get('code')}, 错误信息={error.get('message')}")
注意:在 YOUR_API_KEY
处填入你创建的 API Key
,在 app_code
中填入你创建的工作流code,在 args
中填入系统变量或你设置的自定义变量。
3.更多语言和在线调试
其他编程语言的接入代码可以在 API调试页面 进行代码生成,同时支持在线进行接口调试。