You need to enable JavaScript to run this app.
云手机

云手机

复制全文
Mobile Use OpenAPI
Mobile Use OpenAPI 概览
复制全文
Mobile Use OpenAPI 概览

Mobile Use OpenAPI 提供了移动端使用的智能代理任务管理接口,包括配置管理、任务执行和回调处理等功能。

API 列表

配置管理接口

API

描述

创建代理运行配置 CreateAgentRunConfig

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

更新代理运行配置 UpdateAgentRunConfig

更新已存在的代理运行配置。

查询代理运行配置列表 ListAgentRunConfig

查询代理运行配置列表。支持设置条件筛选、支持分页查询。

删除代理运行配置 DeleteAgentRunConfig

删除指定的代理运行配置。

任务管理接口

API

描述

一键运行代理任务 RunAgentTaskOneStep

启动一个新的代理任务执行。该接口无需创建代理运行配置,传入请求参数后可直接运行代理任务。

运行代理任务 RunAgentTask

运行指定的代理任务。

取消代理任务 CancelTask

取消指定的正在运行的代理任务。

查询代理任务列表 ListAgentRunTask

查询代理任务列表。支持设置条件筛选、支持分页查询。

查询任务当前步骤 ListAgentRunCurrentStep

查询指定任务当前所执行到的步骤信息。

获取任务运行结果 GetAgentResult

获取指定任务的最终运行结果。

通用数据结构

本章节提供 Mobile Use OpenAPI 的通用数据结构。

OutputSchema

参数名称

类型

是否必须

描述

Type

string

返回数据结构的类型,目前仅支持取值 dict

Fields

[]FieldSchema

定义具体返回结构。详情参见下表 FieldSchema

FieldSchema

参数名称

类型

是否必须

描述

Name

string

字段名称。

Type

string

字段类型。

Description

string

字段描述。

Required

boolean

字段是否必须。

使用示例

OutputSchema 示例代码如下:

# 任务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,代理任务执行期间产生的回调会发送到该地址。回调包括:

CallbackRetryLimit

int

回调重试次数,例如取值为 3 表示最多回调 3 次。

  • 取值范围:1 ~ 5
  • 默认值:3

说明

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

CallbackErrorCode

list[string]

自定义错误码,用于服务判断错误情况并决定是否重试。如 CallbackErrorCode 取值为 ["2xx"],表示服务接收到回调返回在 200~299 间错误码时,会进行重试。

  • 重试次数由 CallbackRetryLimit 参数定义。
  • 默认值为 ["3xx", "4xx", "5xx"]
  • 可填内容:
    • 2xx:表示错误码 200~299
    • 200:表示错误码 200
    • 200~250:表示错误码 200~250

CallbackTimeout

int

回调超时时间,单位:秒。

  • 取值范围:1 ~ 300
  • 默认值:5

说明

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

CallbackHeaders

dict[string]string

自定义回调请求头,默认为 {},示例值:{"a": "b"}

最近更新时间:2025.12.30 16:30:41
这个页面对您有帮助吗?
有用
有用
无用
无用