工作流调用

使用API对工作流进行调用。

请求方式

POST

调用地址

https://api.gptbots.ai/v1/workflow/invoke

调用验证

详情参见【API 概述】内的鉴权方式说明。

请求

curl --location --request POST 'https://api.gptbots.ai/v1/workflow/invoke' \ --header 'Authorization: <your_api_key>' \ --header 'Content-Type: application/json' \ --data-raw '{ "userId": "<your_user_id>", "input": { <your_start> } }'

          curl --location --request POST 'https://api.gptbots.ai/v1/workflow/invoke' \
--header 'Authorization: <your_api_key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userId": "<your_user_id>",
    "input": {
        <your_start>
    }
}'

此代碼塊在浮窗中顯示

将<your_api_key>替换为创建的 API Key。

将your_start替换为工作流“开始”节点内配置的入参。

字段	类型	必填	说明
userId	string	否	用于标记本次请求的发起人。
input	object	是	即工作流的“开始”节点。该对象内需填入与工作流“开始”节点内配置的完全一致的入参结构。

响应

{ "workflowRunId": "xxxx-5b15-4cbf-999c-1b218934xxxx", "input": { "input": "失恋了怎么办？" }, "output": { "output": "失恋是一种很正常的人生经历，虽然痛苦，但它也可以成为成长和自我反思的契机。以下是一些建议，希望能帮到你：\n\n..." }, "workflowExecutionTime": 24277, "status": "SUCCEED", "totalCost": 1.3754, "totalTokens": 3464, "startTime": 1741768313025, "endTime": 1741768337310 }

          {
    "workflowRunId": "xxxx-5b15-4cbf-999c-1b218934xxxx",
    "input": {
        "input": "失恋了怎么办？"
    },
    "output": {
        "output": "失恋是一种很正常的人生经历，虽然痛苦，但它也可以成为成长和自我反思的契机。以下是一些建议，希望能帮到你：\n\n..."
    },
    "workflowExecutionTime": 24277,
    "status": "SUCCEED",
    "totalCost": 1.3754,
    "totalTokens": 3464,
    "startTime": 1741768313025,
    "endTime": 1741768337310
}

此代碼塊在浮窗中顯示

字段	类型	说明
workflowRunId	string	工作流运行 ID，用于唯一标识本次执行。
input	object	“开始”节点的输入内容，与请求中的 input 相同。
output	object	“结束”节点的输出内容，包含工作流执行的结果。
workflowExecutionTime	number	工作流执行耗时，单位为毫秒。
status	string	工作流的调用状态，可能的值包括： * SUCCED：成功 * FAILED：失败 * RUNNING：运行中
totalCost	number	总消耗费用（所有节点总和），单位为积分。
totalTokens	number	总消耗 Token 数（所有节点总和）。
startTime	number	开始时间戳，毫秒级。
endTime	number	结束时间戳，毫秒级。