GET https://ark.cn-beijing.volces.com/api/v3/sessions/{session_id}/tasks
分页查询指定会话中的后台工具任务,可按任务状态或会话线程筛选。
列表只返回任务摘要,不返回执行结果 result。如需读取任务结果、日志位置或产物路径,请使用 查询会话任务。
鉴权#
本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。
- API Key 鉴权,请在 API Key 管理 页面,获取长效 API Key。
请求参数#
Path 参数#
session_id string 必选 | 会话 ID
要查询后台工具任务的会话 ID,格式为 sesn- 开头的字符串。
Query 参数#
在 URL Query String 中传入。
cursor integer | 下一页标识
下一页标识。按以下方式翻页:
- 首次查询时省略。
- 后续查询时,将上一页响应中的
next_cursor原样传入。 - 响应不再返回
next_cursor时,停止查询。
不要解析、生成或修改该值。
最小值:0
limit integer 默认值 20 | 每页任务数
每页返回的任务数量。
最小值:0
session_thread_id string | 会话线程 ID
发起任务的会话线程 ID。传入后,只返回该线程创建的后台工具任务;省略时返回整个会话的任务。
state string | 任务状态
按任务状态筛选结果。支持使用半角逗号分隔多个状态。
响应参数#
items object[] | 任务列表
后台工具任务摘要列表,按创建顺序倒序返回。正常执行的 bash 命令只有转为后台任务后,才会出现在列表中。列表项不包含任务执行结果 result;如需读取结果,请查询单个任务。
created_at integer | 创建时间
items.created_at
任务提交时间,采用 Unix 毫秒时间戳。
session_id string | 会话 ID
items.session_id
任务所属的会话 ID。
session_thread_id string | 会话线程 ID
items.session_thread_id
发起该任务的会话线程 ID。
state string | 任务状态
items.state
任务的当前状态。
unknown 表示当前无法确认任务状态,不是稳定结束状态。保留 task_id 并稍后查询;状态可能恢复为 running 或实际结束状态,因此不要将该状态视为成功。取值:queued / running / succeeded / failed / cancelled / unknown。
task_id string | 任务 ID
items.task_id
后台工具任务的唯一标识,格式为 task- 开头的字符串。
tool object | 工具信息
items.tool
产生该任务的工具调用信息。
name string | 工具名称
items.tool.name
产生该任务的工具名称,例如 bash 或 video_generate。
description string | 工具调用说明
items.tool.description
工具调用的用途说明。没有可用说明时,不返回该字段。
tool_use_id string | 工具调用 ID
items.tool.tool_use_id
Agent 发起该次工具调用时生成的工具调用 ID。没有可用 ID 时,不返回该字段。
error_code string | 失败类型
items.error_code
任务失败、取消或状态未知,且服务端记录了失败原因时的失败类型。可选值:upstream、timeout、fetch、killed、internal。
error_message string | 失败信息
items.error_message
任务失败、取消或状态未知,且服务端记录了失败原因时的原因说明。
finished_at integer | 结束时间
items.finished_at
任务进入结束状态的时间,采用 Unix 毫秒时间戳。任务尚未结束时,不返回该字段。
started_at integer | 开始时间
items.started_at
任务开始执行的时间,采用 Unix 毫秒时间戳。任务尚未开始时,不返回该字段。
summary string | 任务摘要
items.summary
工具执行内容的摘要。服务端未生成摘要时,不返回该字段。
next_cursor integer | 下一页标识
下一页标识。返回该字段时,将其原样传入下一次请求的 cursor;未返回时表示已到最后一页。