跳转到主要内容
POST
/
workflows
/
{workflow_id}
/
run
Error
A valid request URL is required to generate request examples
{
  "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "outputs": {},
    "error": "<string>",
    "elapsed_time": 123,
    "total_tokens": 123,
    "total_steps": 123,
    "created_at": 123,
    "finished_at": 123,
    "created_by": {},
    "exceptions_count": 123,
    "files": [
      {}
    ]
  }
}

授权

Authorization
string
header
必填

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

路径参数

workflow_id
string
必填

要执行的特定版本的工作流 ID。此值在 执行工作流 响应和 获取工作流运行详情workflow_id 字段中返回。

请求体

application/json
inputs
object
必填

工作流输入变量的键值对。文件类型变量的值应为文件对象数组,包含 typetransfer_method 以及 urlupload_file_id。请参阅 获取应用参数 响应中的 user_input_form 字段,以了解应用所需的变量名称和类型。

user
string
必填

用户标识符,由开发者自定义规则,在应用内必须唯一。此标识符用于限定数据访问范围——工作流运行和文件仅在使用相同的 user 值查询时可见。

response_mode
enum<string>

响应模式。使用 blocking 获取同步响应(Cloudflare 超时时间为 100 s),使用 streaming 获取服务器发送事件。未指定时默认为阻塞模式。

可用选项:
streaming,
blocking
files
object[] | null

文件列表。适用于需要将文件与文本组合输入的场景,仅在模型支持 Vision 能力时可用。要附加本地文件,请先通过 上传文件 上传,然后将返回的 id 作为 upload_file_id,并设置 transfer_method: local_file

响应

请求成功。内容类型和结构取决于请求中的 response_mode 参数。

  • 如果 response_modeblocking,返回 application/jsonWorkflowBlockingResponse 对象。
  • 如果 response_modestreaming,返回 text/event-streamChunkWorkflowEvent 对象流。
task_id
string<uuid>

进行中的执行任务 ID。配合 停止工作流任务 使用以取消运行中的工作流。仅在执行期间有效。

workflow_run_id
string<uuid>

此工作流运行记录的持久化标识符。配合 获取工作流运行详情 使用以在执行后获取结果。

data
object