面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/run-deployment-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

立即运行 Deployment

POST https://ark.cn-beijing.volces.com/api/v3/deployments/{deployment_id}/run

立即执行一次任务,无需等待定时计划。接口会等待 Session 创建完成、初始事件受理完成,并写入本次 Run 的最终启动结果。

成功响应只表示 Session 和初始事件已经受理,不表示模型、工具或 Agent 任务执行成功。Deployment 暂停时仍可手动运行;归档后不能运行。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • API Key 鉴权,请在 API Key 管理 页面,获取长效 API Key。

请求参数#

Path 参数#

deployment_id string 必选  |  Deployment ID

要立即运行的 Deployment ID。

响应参数#

agent object  |  Agent 引用

本次 Run 受理时固定的 Agent 和版本。

id string  |  Agent ID

agent.id

Deployment 使用的 Agent ID。

type string  |  对象类型

agent.type

Agent 引用类型,固定为 agent。

version integer  |  Agent 版本

agent.version

Deployment 固定使用的 Agent 版本号。

created_at string  |  创建时间

Run 记录创建时间,采用 RFC 3339 格式。

deployment_id string  |  Deployment ID

触发本次 Run 的 Deployment ID。

id string  |  Run ID

Deployment Run 的唯一标识符,以 drun- 开头,形如 drun-<14位时间戳>-<10位随机字符>。

trigger_context object  |  触发上下文

本次 Run 的触发来源和计划时间。

type string  |  触发类型

trigger_context.type

触发类型。manual 表示调用立即运行接口;schedule 表示定时计划触发。

scheduled_at string  |  计划时间

trigger_context.scheduled_at

定时 Run 的理论计划时间,采用 RFC 3339 格式,不包含调度抖动。手动 Run 不返回该字段。

type string  |  对象类型

对象类型,固定为 deployment_run。

error object  |  失败信息

Run 启动失败时返回的错误信息。Run 成功或尚未结束时不返回该字段。

message string  |  错误信息

error.message

用于定位失败原因的可读信息。

type string  |  错误类型

error.type

错误分类。

session_id string  |  Session ID

Session 和初始事件均受理成功时返回的 Session ID。Run 失败或尚未结束时不返回该字段。