概述
TigerAI 支持本地 Local API 功能,使用此功能可以帮助客户实现程序化的创建或编辑环境配置、启动、关闭或查询等基础产品功能,也可通过 DevTool 或其他自动化框架实现浏览器操作自动化。
接口说明
1. 如何使用 LocalAPI
a. API 接口的默认访问地址为 http://local.tigerai123.com:42222/ 或 http://127.0.0.1:42222/
b. 可通过脚本读取 local_api 文件获取接口访问地址
%USERPROFILE%\AppData\Roaming\@tigerai\client\tigerai_cwd\config
2. Api Key 和 headless 的使用 (仅支持付费用户使用)
TigerAI 支持 headless 配合 api-key 启动无界面服务操作 Local API
2.1 自动化 -> API 处获取 api-key
2.2 使用命令行命令配合api-key启动无界面服务
参数 | 是否必须 | 说明 |
---|---|---|
--headless | 是 | 指定是无界面启动服务 |
--api-key | 是 | 无界面服务操作 Local API 的身份凭证 |
--api-host | 否 | 指定 Local API 服务地址,默认 127.0.0.1 (若需要外网访问请指定0.0.0.0) |
--api-port | 否 | 指定 Local API 服务端口,默认 42222 |
命令示例:
FQA
Q:可以在同一个设备同时启动有界面和无界面服务吗?
A:不能
Q:如果更换了 api-key,用旧值启动的服务调用的api接口还能继续用吗?
A:不能。会返回 api-key 失效的信息,一个账号仅能对应一个 api-key,所以谨慎操作重置,重置后旧值失效,请安全的保存该值
Q:如何重置 api-key?
A:进入自动化 -> API,点击重置 api-key,重置后请注意保存
Q:如果更换了 api-key,是否能对已启动的服务进行 api-key 的 更新呢?
A:不能。需先关闭服务,重新用新的 api-key 启动服务
Q:如何关闭服务?
A:可通过 Ctrl + C 或关闭终端窗口将服务关闭
Q:使用有界面服务和无界面服务启动 Local API 服务有何区别呢?
A:1.有界面服务会被限制同个账号只能在一个设备登录 2.api-key 则不限制同个账号同时登录多个设备的场景,如果有一个账号想要在多个机器上跑自动化的需求,则可以使用 headless 配合 api-key 使用 Local API 接口 3.api-key 可以启动外网服务,如果是部署在服务器可以提供服务端接口 4.api-key 仅支持收费用户使用。Local API 完全免费使用
修改于 2025-04-24 08:30:09