Skip to main content

端点

描述

获取指定任务的当前状态、结果和元数据。使用此端点检查任务进度或获取最终结果。

认证

必需:是 在请求头中包含 API 密钥:

请求

路径参数

请求头

响应

成功响应

状态200 OK 响应头
  • X-Workflow-ID:Temporal 工作流标识符(与任务 ID 相同)
响应体

响应字段

状态值

  • TASK_STATUS_UNSPECIFIED - 状态未知
  • TASK_STATUS_QUEUED - 等待执行
  • TASK_STATUS_RUNNING - 正在执行
  • TASK_STATUS_COMPLETED - 成功完成
  • TASK_STATUS_FAILED - 执行失败
  • TASK_STATUS_PAUSED - 用户暂停或 HITL 审查中
  • TASK_STATUS_CANCELLED - 用户已取消
  • TASK_STATUS_TIMEOUT - 超出超时限制

执行模式值

  • EXECUTION_MODE_SIMPLE - 单个 LLM 调用,无工具
  • EXECUTION_MODE_STANDARD - 多步骤执行,包含工具
  • EXECUTION_MODE_COMPLEX - 高级推理模式

示例

检查任务状态

响应(已排队)
响应(运行中)
响应(已完成)
响应(失败)

深度研究响应载荷

当任务以 force_research: true 提交时,完成的响应会包含带有结构化研究数据的额外元数据字段。

深度研究元数据字段

对于深度研究任务,metadata 对象包含:

示例:深度研究完成响应

提取的事实(可选)

当请求上下文中设置了 enable_fact_extraction: true 时:

引用对象模式

metadata.citations 数组中的位置与正文中使用的 [n] 引用编号一一对应。

验证对象模式

访问深度研究数据metadata.citations 数组和 metadata.verification 对象仅对研究工作流(force_research: true)填充。对于简单任务,这些字段将不会出现在响应中。

错误响应

401 未授权

404 未找到

500 内部服务器错误

代码示例

Python - 简单状态检查

Python - 轮询直到完成

JavaScript/Node.js

JavaScript - 使用 Async/Await 轮询

Go

Bash - 监控任务进度

用例

1. 提交并等待模式

2. 仪表板状态部件

3. 批量状态检查

最佳实践

1. 使用流式传输而不是轮询

对于长时间运行的任务,使用 SSE 流式传输而不是轮询:

2. 处理所有状态

3. 实施指数退避

4. 缓存状态响应

5. 提取元数据

相关端点

提交任务

POST /api/v1/tasks

流式事件

实时监控

Python SDK

使用 client.get_status()

注意

勿在生产环境轮询:对于长时间运行的任务,使用流式端点而不是轮询状态。轮询会增加不必要的负载并增加延迟。
会话追踪session_id 字段允许跟踪任务属于哪个会话,这对多轮对话和成本归属很有用。