运行代理任务 RunAgentTask--云手机-火山引擎

文档中心

立即注册

云手机

任务管理

运行代理任务 RunAgentTask

基于当前火山引擎账号下已创建的代理运行配置（创建代理运行配置 CreateAgentRunConfig 接口），运行指定的代理任务。

使用说明

调用 Mobile Use OpenAPI 前，必须先访问跨服务访问请求为您的账号授权。

注意事项

本接口整体 QPS 限制为 50 次/秒、单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=RunAgentTask&Version=2023-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必选	示例值	描述
Content-Type	String	是	application/json	请求头信息。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	RunAgentTask	接口名称。当前 API 的名称为 `RunAgentTask`。
Version	String	是	2023-08-01	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数	类型	是否必选	示例值	描述
RunName	String	是	test-run	运行名称。字符长度限制：1 ~ 127
ThreadId	String	是	thread-123	线程 ID，自定义的随机字符串，用于标识一段对话。字符长度限制：1 ~ 63
PodId	String	是	756990107154****	实例 ID。字符长度限制：1 ~ 63
ProductId	String	是	198670449019****	业务 ID。字符长度限制：1 ~ 63
UserPrompt	String	是	请帮我完成任务	用户提示词。字符长度上限 10000。
AgentRunConfigId	int	是	8510	代理运行配置 ID。传入后，任务将按照指定的配置运行。
UseBase64Screenshot	Boolean	否	true	是否使用 base64 编码传输截屏。默认为 false。
MaxStep	Integer	否	100	代理运行的最大步骤数。取值范围：1 ~ 500 默认值：100
Timeout	Integer	否	300	超时时间，单位：秒。取值范围：1 ~ 86400 默认值：120
OutputSchema	String	否	{}	输出格式。JSON 字符串形式，具体参数参考通用数据结构中的OutputSchema。
RetryLimit	Integer	否	3	AI 在调用失败场景下的重试次数限制。取值范围：1 ~ 10 默认值：3
SystemPrompt	String	否	You are a helpful assistant	系统提示词。
CallbackInfo	dict	否	{}	回调配置，用于接收代理任务执行期间产生的回调事件。具体参数参考通用数据结构中的CallbackInfo。

返回参数

公共返回参数信息请见返回结构，其中 Result 包含的参数说明如下。

参数名称	类型	示例值	描述
RunId	String	756729984938989****	运行 ID
RunName	String	test-run	运行名称
ThreadId	String	thread-123	线程 ID

请求示例

POST https://open.volcengineapi.com?Action=RunAgentTask&Version=2023-08-01
{
        "RunName": "test-run",
        "ThreadId": "thread-123",
        "PodId": "756990107154****",
        "ProductId": "198670449019****",
        "UserPrompt": "请帮我完成任务",
        "AgentRunConfigId": 8510,
        "UseBase64Screenshot": true,
        "MaxStep": 100,
        "Timeout": 300,
        "OutputSchema": "{}",
        "RetryLimit": 3,
        "SystemPrompt": "You are a helpful assistant",
        "CallbackInfo": {}
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "RunAgentTask",
        "Version": "2023-08-01",
        "Service": "ipaas",
        "Region": "cn-north-1"
    },
    "Result":{
        "RunId":"756729984938989****",
        "RunName":"test-run",
        "ThreadId":"thread-123"
    }
}

错误码

Mobile Use OpenAPI 错误码请参见错误码；更多错误码信息，可访问公共错误码。

最近更新时间：2025.12.30 15:29:06

这个页面对您有帮助吗？

有用

无用

云手机