跳转到主要内容
GET
/
workflow
/
{workflow_run_id}
/
events
流式获取工作流事件
curl --request GET \
  --url https://{api_base_url}/workflow/{workflow_run_id}/events \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://{api_base_url}/workflow/{workflow_run_id}/events"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/workflow/{workflow_run_id}/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_base_url}/workflow/{workflow_run_id}/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://{api_base_url}/workflow/{workflow_run_id}/events"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{api_base_url}/workflow/{workflow_run_id}/events")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/workflow/{workflow_run_id}/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
"<string>"
{
"status": 400,
"code": "not_workflow_app",
"message": "Please check if your app mode matches the right API route."
}
{
"status": 404,
"code": "not_found",
"message": "Workflow run not found"
}

授权

Authorization
string
header
必填

API Key 认证。对于所有 API 请求,请在 Authorization HTTP 头中包含您的 API Key,并加上 Bearer 前缀。示例:Authorization: Bearer {API_KEY}强烈建议将 API Key 存储在服务端,不要在客户端共享或存储,以避免 API Key 泄漏导致严重后果。

路径参数

workflow_run_id
string<uuid>
必填

要恢复事件流的工作流运行 ID(即原始运行响应中返回的 workflow_run_id)。

查询参数

user
string
必填

最初触发该运行的终端用户标识。必须与工作流运行的创建者一致。

include_state_snapshot
boolean
默认值:false

true 时,从持久化状态快照重放,在流式发送新事件前附带已执行节点的状态摘要。

continue_on_pause
boolean
默认值:false

设为 true 时,流会在多次 workflow_paused 事件之间保持打开(适用于工作流包含多个连续人工介入节点的场景)。默认在首次暂停时关闭流。

响应

Server-Sent Events 流。每个事件以 data: {JSON}\n\n 形式送达。事件载荷结构与原始流式响应一致。

工作流事件的 SSE 流。