创建代理运行配置 CreateAgentRunConfig--云手机-火山引擎

文档中心

立即注册

导航

云手机

创建代理运行配置 CreateAgentRunConfig

最近更新时间：2025.11.19 16:29:45首次发布时间：2025.11.17 14:12:57

创建一个新的代理运行配置，用于定义代理任务的执行参数和回调设置。

使用说明

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

注意事项

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

请求说明

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

请求参数

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

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

Query

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

Body

参数	类型	是否必选	示例值	描述
MaxStep	Integer	否	100	代理运行的最大步骤数。取值范围：1 ~ 500 默认值：100
CallbackUrl	String	否	https://example.com/callback	回调 URL 地址，支持 HTTP/HTTPS，代理任务执行期间产生的回调会发送到该地址。回调包括：任务状态更新回调任务执行失败回调任务中断回调
OutputSchema	String	否	{}	输出格式。JSON 字符串形式，具体参数参考通用数据结构中的OutputSchema。
RetryLimit	Integer	否	3	AI 在调用失败场景下的重试次数限制。取值范围：1 ~ 10 默认值：3
SystemPrompt	String	否	You are a helpful assistant	系统提示词。
TosBucket	String	是	my-bucket	对象存储 TOS 存储桶名称。
TosEndpoint	String	是	tos-s3-cn-beijing.volces.com	对象存储 TOS 端点地址。
TosRegion	String	是	cn-beijing	对象存储 TOS 区域。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ConfigId	int	8510	配置 ID，是代理运行配置的唯一标识。

请求示例

POST https://open.volcengineapi.com?Action=CreateAgentRunConfig&Version=2023-08-01
{
        "MaxStep ": 100,
        "CallbackUrl ": "https://example.com/callback",
        "OutputSchema": "{}",
        "RetryLimit": 3,
        "SystemPrompt": "You are a helpful assistant",
        "TosBucket": "my-bucket",
        "TosEndpoint": "tos-s3-cn-beijing.volces.com",
        "TosRegion": "cn-beijing"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateAgentRunConfig",
        "Version": "2023-08-01",
        "Service": "ipaas",
        "Region": "cn-north-1"
    },
    "Result":{
        "ConfigId": 8510
    }
}

错误码

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

云手机