Computer Use Agent OpenAPI 提供了 PC 端使用的智能代理任务管理接口，包括配置管理、任务执行、可观测和回调处理等功能。 ## API 列表 ### 配置管理接口 |**API** |**描述** | |---|---| |[创建代理运行配置 CreateAgentRunConfig](https://www.volcengine.com/docs/6394/2553737) |用于创建一个新的代理运行配置。创建成功后，CUA 可以基于该配置管理运行过程中产生的截图、任务产物或技能相关文件。 | |[删除代理运行配置 DeleteAgentRunConfig](https://www.volcengine.com/docs/6394/2553740) |删除指定的代理运行配置。 | |[更新代理运行配置 UpdateAgentRunConfig](https://www.volcengine.com/docs/6394/2553738) |更新已存在的代理运行配置。 | |[查询代理运行配置列表 ListAgentRunConfig](https://www.volcengine.com/docs/6394/2553739) |查询代理运行配置列表。支持设置条件筛选、支持分页查询。 | ### 任务管理接口 |**API** |**描述** | |---|---| |[一键运行代理任务 RunAgentTaskOneStep](https://www.volcengine.com/docs/6394/2556367) |启动一个新的代理任务执行。该接口无需创建代理运行配置，传入请求参数后可直接运行代理任务。 | |[运行代理任务 RunAgentTask](https://www.volcengine.com/docs/6394/2556368) |运行指定的代理任务。 | |[取消代理任务 CancelTask](https://www.volcengine.com/docs/6394/2557342) |取消指定的正在运行的代理任务。 | |[查询代理任务列表 ListAgentRunTask](https://www.volcengine.com/docs/6394/2557343) |查询代理任务列表，支持按条件筛选及分页查询。 | |[查询任务当前步骤 ListAgentRunCurrentStep](https://www.volcengine.com/docs/6394/2557345) |查询指定任务当前所执行到的步骤信息。 | |[获取任务运行结果 GetAgentResult](https://www.volcengine.com/docs/6394/2557346) |获取指定任务的最终运行结果。 | ### 可观测接口 |**API** |**描述** | |---|---| |[创建 noVNC 拉流会话 CreateCuaNodeNoVNCSession](https://www.volcengine.com/docs/6394/2550025) |获取指定节点的 noVNC 会话链接，用于在浏览器中查看设备画面。 | ## 通用数据结构本章节提供 Computer Use Agent OpenAPI 的通用数据结构。 ### OutputSchema |**参数名称** |**类型** |**是否必须** |**描述** | |---|---|---|---| |Type |String |是 |返回数据结构的类型，目前仅支持取值 `dict`。 | |Fields |[]FieldSchema |否 |定义具体返回结构。详情参见下表 **FieldSchema**。 | #### FieldSchema |**参数名称** |**类型** |**是否必须** |**描述** | |---|---|---|---| |Name |String |是 |字段名称。 | |Type |String |是 |字段的数据类型。 | |Description |String |否 |字段的描述信息。 | |Required |Boolean |是 |字段是否为必填项。

* true ：该字段为必填项。

* false：该字段为可选项。 | |Fields |[]FieldSchema |否 |子字段列表，用于定义嵌套的返回结构。 | #### 使用示例 OutputSchema 示例代码如下： ```Python # 任务UserPrompt test_prompt = "帮我打开**应用,切换到搜索,拿到热搜榜前五的标题、热度的值、热度值的单位和标签，注意：如果你发现键盘挡住了热榜界面，你应该在屏幕上半段向下滑动，以关闭键盘后看到更多信息" # 输入的JSON内容需注意：生成的list中必须为同一类型的元素，不支持如[1, "2"]之类混用类型的生成 # 目前仅支持以dict形式返回，即Type参数只支持设置为dict OutputShcema = json.dumps({ "Type": "dict", "Fields": [ { "Name": "hot_searches", "Type": "list", "Description": "热搜榜前五列表", "Required": False, "Fields": [ { "Type": "dict", "Fields": [ { "Name": "rank", "Type": "integer", "Description": "排名", "Required": True }, { "Name": "title", "Type": "string", "Description": "热搜标题", "Required": True }, { "Name": "heat_value", "Type": "dict", "Description": "热搜榜前五列表", "Required": True, "Fields": [{ "Name": "value", "Type": "string", "Description": "热度值数量", "Required": True }, { "Name": "unit", "Type": "string", "Description": "热度值单位如万等", "Required": True } ] }, { "Name": "tag", "Type": "string", "Description": "标签，如\"热\"、\"新\"、\"爆\"等", "Required": False } ] } ] }, { "Name": "summary", "Type": "string", "Description": "执行总结", "Required": False } ] }) # 结果输出 {'hot_searches': [{'rank': 1, 'title': '**新品开箱', 'heat_value': {'value': '1110.0', 'unit': '万'}, 'tag': '无'}, {'rank': 2, 'title': '**系列怎么选', 'heat_value': {'value': '1098.1', 'unit': '万'}, 'tag': '新'}, {'rank': 3, 'title': '首个光量子计算机制造工厂...', 'heat_value': {'value': '1091.2', 'unit': '万'}, 'tag': '无'}, {'rank': 4, 'title': '**发文悼念', 'heat_value': {'value': '1089.4', 'unit': '万'}, 'tag': '无'}, {'rank': 5, 'title': '在艺术展现场共...', 'heat_value': {'value': '1028.1', 'unit': '万'}, 'tag': '新'}], 'summary': '已成功打开**应用并切换到搜索页面，获取到热搜榜前五的标题、热度值、单位及标签信息'} ``` ### CallbackInfo |**参数名称** |**类型** |**是否必须** |**描述** | |---|---|---|---| |CallbackUrl |String |否 |回调 URL 地址，支持 HTTP/HTTPS，代理任务执行期间产生的回调会发送到该地址。回调包括：

* [任务状态更新回调](https://www.volcengine.com/docs/6394/2557348)

* [任务执行失败回调](https://www.volcengine.com/docs/6394/2557349)

* [任务中断回调](https://www.volcengine.com/docs/6394/2557350) | |CallbackRetryLimit |Int |否 |回调重试次数，例如取值为 3 表示最多回调 3 次。

* 取值范围：1 ~ 5

* 默认值：3

说明

超出取值范围的参数值系统会按默认值处理。

说明

超出取值范围的参数值系统会按默认值处理。

| |CallbackHeaders |dict[string]string |否 |自定义回调请求头，默认为 `{}`，示例值：`{"a": "b"}`。 |

云手机