flow 接口 API

flow 调用接口，用于流程编排，流程编排是指将多个接口调用组合成一个流程，实现复杂的业务逻辑。

1. 获取 flow token

接口说明

• 用于获取 flow token，flow token 用于调用 flow 服务。

请求方式

• GET

请求地址

• https://aics.vanke.com/aics-flow/api/v1/token

请求头

• Content-Type: application/json
• x-api-key: xxxx x-api-key 为认证密钥，请联系管理员获取。

请求样例

curl --location 'https://t-aics.vanke.com/aics-flow/api/v1/token' \
--header 'x-api-key: sk-QHqhclJdZZYwM21OqBO_Xzdj-YyRh1ltHGuZUQT51'

返回结果

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIwY2VkYjRiNC0xOWU2LTQ1NWYtODhlMC1jYmFhMzFlOGE4ZjYiLCJleHAiOjE3MTY4ODY3OTR9.3dTKUuqG0p8uQuKunoj9ZLcdkqd54wVO9HrabqkYfZM",
  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIwY2VkYjRiNC0xOWU2LTQ1NWYtODhlMC1jYmFhMzFlOGE4ZjYiLCJ0eXBlIjoicmYiLCJleHAiOjE3MTc0ODQzOTR9.lIiQN7yE5eGCn4Kis3gy4k6vQPcj5bUKO9-wI4jisWU",
  "token_type": "bearer"
}

2. flow 消息发送接口

接口说明

• 用于发送消息到 flow 服务，flow 服务会根据消息内容进行流程编排，返回编排结果。

请求方式

• POST

请求地址

• https://aics.vanke.com/aics-flow/api/v1/chat/send

请求头

• Content-Type: application/json
• Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MmRlMTAxOC0yZTc0LTRiMmEtOWEzZi00OTk3YjMxZDUzOWIiLCJleHAiOjE3NDQyNjM1OTd9.lrvG14cP74Rvp1treAGNpfiJpRi_ZgLlJp2E9mK7fGk Authorization 为认证密钥，获取方式请参考token 接口调用。

请求参数

• inputs: 输入参数
• chatKey: 输入参数的 key
• flowId: 流程 ID
• recordId: 记录 ID
• chatHistory: 聊天历史

请求样例

curl --location 'https://aics.vanke.com/aics-flow/api/v1/chat/send' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MmRlMTAxOC0yZTc0LTRiMmEtOWEzZi00OTk3YjMxZDUzOWIiLCJleHAiOjE3NDQyNjM1OTd9.lrvG14cP74Rvp1treAGNpfiJpRi_ZgLlJp2E9mK7fGk' \
--data '{
    "inputs": {
        "input": "今天天气" 
    },
    "chatKey": "input", 
    "flowId": "c670d21b-f054-47b4-9de0-95d783dd1754", 
    "recordId": "111", 
    "chatHistory": []
},'

返回结果

{
  "is_bot": true,
  "message": "今天天气是晴天",
  "chatKey": null,
  "type": "end",
  "intermediate_steps": "",
  "files": [],
  "recordId": "111"
}

返回参数说明：

1. is_bot: 是否是机器人
2. message: 返回消息
3. chatKey: 聊天 key
4. type: 消息类型 end 为最终消息
5. intermediate_steps: 中间步骤
6. files: 文件
7. recordId: 消息记录 ID