POST https://ark.cn-beijing.volces.com/api/v3/dreams/{dream_id}/cancel
请求取消处于 pending 或 running 状态的 Dream。已经处于 canceled 状态的任务会直接返回当前任务；其他终态任务不能取消。
接口先记录取消意图，再由后台任务确认执行停止。响应中的 status 可能仍为 pending 或 running，需要继续查询任务，直到进入终态。
鉴权#
本接口支持鉴权方式如下，详情请参见 Base URL 及鉴权。
- API Key 鉴权，请在 API Key 管理 页面，获取长效 API Key。
请求参数#
Path 参数#
dream_id string 必选 | Dream ID
要取消的 Dream 任务 ID，格式为 drm- 开头的字符串。
响应参数#
created_at string | 创建时间
任务创建时间，RFC 3339 格式。
id string | Dream ID
Dream 任务的唯一标识符，格式为 drm- 开头的字符串。
inputs object[] | 任务输入
创建任务时保存的输入快照。
源记忆库输入 object
创建任务时保存的源 Memory Store 输入。
memory_store_id string | 源记忆库 ID
inputs.memory_store_id
源 Memory Store ID。
type string | 输入类型
inputs.type
输入类型，固定为 memory_store。
历史会话输入 object
创建任务时保存的历史 Session 输入。
session_ids string[] | 历史会话 ID
inputs.session_ids
创建任务时保存的历史 Session ID 列表。
type string | 输入类型
inputs.type
输入类型，固定为 sessions。
model object | 模型信息
执行记忆整理任务的模型信息。
id string | 模型 ID
model.id
执行记忆整理任务的模型 ID。
outputs object[] | 任务输出
Dream 创建的输出 Memory Store。访问时机和内容完整性由 status 表示。
memory_store_id string | 输出记忆库 ID
outputs.memory_store_id
Dream 创建的输出 Memory Store ID。
type string | 输出类型
outputs.type
输出类型，固定为 memory_store。
status string | 任务状态
Dream 任务的当前状态。取消请求被记录后，响应仍可能为 pending 或 running。
pending：任务已受理，正在等待执行，输出 Memory Store 尚不可访问。running：任务正在执行，输出 Memory Store 尚不可访问。completed：任务已完成，输出 Memory Store 可以使用。failed：任务执行失败，输出 Memory Store 可以访问，但内容可能为空或不完整；可通过error查看原因。canceled：任务已取消，输出 Memory Store 可以访问，但内容可能为空或不完整。
type string | 对象类型
对象类型，固定为 dream。
ended_at string | 结束时间
任务进入终态的时间，RFC 3339 格式。任务未结束时为 null。
error object | 失败信息
任务异步执行失败的信息。任务未失败时为 null。
message string | 错误信息
error.message
Dream 执行失败的原因，用于定位任务失败问题。
type string | 错误类型
error.type
错误类型。timeout 表示任务超时；internal_error 表示任务执行期间发生内部错误。
instructions string | 整理指令
创建任务时传入的记忆整理要求。未传入时为 null。
running_time number | 累计运行时长
Dream 排除空闲间隔后的累计运行时长，单位为秒。暂未获得时为 null。
usage object | 用量统计
任务的 Token 用量。值为 null 时表示用量未知，不能解释为零消耗。
cache_creation_input_tokens integer | 缓存创建 Token 数
usage.cache_creation_input_tokens
写入缓存的输入 Token 数。
cache_read_input_tokens integer | 缓存读取 Token 数
usage.cache_read_input_tokens
从缓存读取的输入 Token 数。
input_tokens integer | 输入 Token 数
usage.input_tokens
本次 Dream 执行消耗的输入 token 数。
output_tokens integer | 输出 Token 数
usage.output_tokens
本次 Dream 执行生成的输出 token 数。