目录

一、接口说明

该接口未来将弃用，新用户请参考： workflow2.0

workflow 对外接口：

• 非流式响应：非流式响应只会给结束节点返回
• 流式响应：支持message节点信息返回，结束节点信息，以及两个节点流式输出

二、接口信息

2.1 请求头

2.2 请求体

2.3 响应体

2.3.1 流式响应

2.3.2 非流式输出

三、请求示例

3.1 http非流式输出

request示例：

curl -i -k -X POST --location "https://agent.xf-yun.com/workflow/v1/run" \
    -H "Authorization: Bearer xxxxxxxxxx" \
    -H "Content-Type: application/json" \
    -d "{
          \"flow_id\":\"7245085474437238786\",
          \"uid\":\"123\",
          \"parameters\":{
            \"AGENT_USER_INPUT\":\"你好\"
          },
          \"ext\": {
            \"bot_id\":\"adjfidjf\",
            \"caller\":\"workflow\"
          },
          \"stream\":false
        }"

response示例

{
  "code": 0,
  "message": "success",
  "id": "spf00081de8@dx192324980b7a4f3782",
  "created": 1727420533,
  "time_cost": 20.0,
  "data": "{\"output\": \"你好\"}",
  "usage": {
      "question_tokens": 0,
      "prompt_tokens": 0,
      "completion_tokens": 0,
      "total_tokens": 0
  }
}

3.2 http流式输出

request示例：

curl -i -k -X POST --location "https://agent.xf-yun.com/workflow/v1/run" \
-H "Authorization: Bearer xxxxxxxxxx" \
-H "Content-Type: application/json" \
-d "{
      \"flow_id\":\"7245085474437238786\",
      \"uid\":\"123\",
      \"parameters\":{
        \"AGENT_USER_INPUT\":\"你好\"
      },
      \"ext\": {
        \"bot_id\":\"adjfidjf\",
        \"caller\":\"workflow\"
      },
      \"stream\":true
    }"

response示例:

data: {"code":0,"message":"success","id":"spf00081de8@dx192324980b7a4f3782","data":{"node_id":"node-end::b0b997db-4504-44fa-bbb3-34407db5ce23","node_seq":0,"node_is_finish":false,"content":"开始\noutput3:\noutput1:\noutput2:您好"},"created":1727420533,"time_cost":2.42,"progress":0.4,"event":"Message"}
data: {"code":0,"message":"success","id":"spf00081de8@dx192324980b7a4f3782","data":{"node_id":"node-end::b0b997db-4504-44fa-bbb3-34407db5ce23","node_seq":1,"node_is_finish":false,"content":"开始\noutput3:\noutput1:\noutput2:您好！有什么"},"created":1727420533,"time_cost":2.502,"progress":0.4,"event":"Message"}
data: {"code":0,"message":"success","id":"spf00081de8@dx192324980b7a4f3782","data":{"node_id":"node-end::b0b997db-4504-44fa-bbb3-34407db5ce23","node_seq":2,"node_is_finish":false,"content":"开始\noutput3:\noutput1:\noutput2:您好！有什么我可以帮助您的"},"created":1727420533,"time_cost":2.614,"progress":0.4,"event":"Message"}
data: {"code":0,"message":"success","id":"spf00081de8@dx192324980b7a4f3782","data":{"node_id":"node-end::b0b997db-4504-44fa-bbb3-34407db5ce23","node_seq":3,"node_is_finish":false,"content":"开始\noutput3:\noutput1:\noutput2:您好！有什么我可以帮助您的吗？"},"created":1727420533,"time_cost":2.83,"progress":0.4,"event":"Message"}
data: {"code":0,"message":"success","id":"spf00081de8@dx192324980b7a4f3782","data":{"node_id":"node-end::b0b997db-4504-44fa-bbb3-34407db5ce23","node_seq":4,"node_is_finish":false,"content":"开始\noutput3:\noutput1:\noutput2:您好！有什么我可以帮助您的吗？\n结束"},"created":1727420533,"time_cost":2.83,"progress":0.4,"event":"Message"}
data: {"code":0,"message":"success","id":"spf00081de8@dx192324980b7a4f3782","data":{"node_id":"node-end::b0b997db-4504-44fa-bbb3-34407db5ce23","node_seq":5,"node_is_finish":false,"content":"开始\noutput3:\noutput1:\noutput2:您好！有什么我可以帮助您的吗？\n结束"},"created":1727420533,"time_cost":3.035,"progress":0.4,"event":"Message"}
data: {"code":0,"message":"success","id":"spf00081de8@dx192324980b7a4f3782","data":{"node_id":"node-end::b0b997db-4504-44fa-bbb3-34407db5ce23","node_seq":6,"node_is_finish":true,"content":"开始\noutput3:\noutput1:\noutput2:您好！有什么我可以帮助您的吗？\n结束"},"created":1727420533,"time_cost":3.038,"progress":0.8,"event":"Message"}
data: {"code":0,"message":"success","id":"spf00081de8@dx192324980b7a4f3782","data":{},"created":1727420533,"usage":{"completion_tokens":36,"prompt_tokens":214,"total_tokens":250,"question_tokens":0},"time_cost":3.046,"progress":1.0,"event":"Done"}

四、代码示例

4.1 python 代码示例

import http.client
import json

headers = {
    "Content-Type": "application/json",
    "Accept": "text/event-stream",
    "Authorization": "Bearer $APIKEY:APISECRET",
}

data = {
    "flow_id": "7245245222671409153",
    "uid": "123",
    "parameters": {"AGENT_USER_INPUT": "你好"},
    "ext": {"bot_id": "adjfidjf", "caller": "workflow"},
    "stream": False,
}
payload = json.dumps(data)

conn = http.client.HTTPSConnection("agent.xf-yun.com")
conn.request("POST", "/workflow/v1/run", payload, headers, encode_chunked=True)
res = conn.getresponse()

if data.get("stream"):
    while chunk := res.readline():
        print(chunk.decode("utf-8"))
else:
    data = res.readline()
    print(data.decode("utf-8"))

五、错误码