AI快速参考使用指南

什么是 AI 快速参考？

AI 快速参考是专门为大语言模型（如 ChatGPT、Claude、通义千问等）优化的 API 文档格式。它将 VMOS Edge 的完整 API 规范压缩成结构化的纯文本，可以直接"投喂"给 AI，让 AI 根据你的需求自动生成可运行的代码。

与传统文档的区别：

传统 API 文档	AI 快速参考
适合人类阅读，包含详细说明、图表、示例	适合 AI 解析，结构化文本，去除冗余
需要开发者手动查找接口、理解参数	AI 自动查找接口、生成代码
分散在多个页面，需要来回切换	单个文本文件，包含所有必要信息
开发流程：阅读文档 → 编写代码 → 调试	开发流程：描述需求 → AI 生成代码 → 运行

适用场景：

✅ 快速原型开发：几分钟内实现完整的业务流程
✅ 自动化脚本：批量操作实例、应用管理、数据导入导出
✅ 学习 API：通过 AI 生成的示例代码快速理解接口用法
✅ 跨语言开发：即使不熟悉某种语言，也能让 AI 生成对应代码
✅ 复杂业务逻辑：描述业务需求，AI 自动组合多个接口

下载纯文本版本

适合 AI 工具直接读取

获取方式：

浏览器下载：右键另存为以下链接

命令行获取：

bash

# Container API
curl https://help.vmosedge.com/ai-reference-container.txt -o vmos-container-api.txt

# Android Control API
curl https://help.vmosedge.com/ai-reference-control.txt -o vmos-control-api.txt

# JavaScript SDK
curl https://help.vmosedge.com/ai-reference-javascript.txt -o vmos-javascript-sdk.txt

在线预览：直接在浏览器中访问上述 URL，可查看原始文本（如遇乱码请设置编码为 UTF-8）

使用方法

第一步：获取 AI 快速参考文本

选择你需要的 API 模块，下载对应的文本文件：

选择模块：
- Container API：主机管理、实例生命周期、应用安装、文件操作
- Android Control API：Android 系统控制、输入模拟、权限管理、传感器控制
- JavaScript SDK：Web/桌面应用集成、实时视频流、远程控制
获取文本：
- 浏览器中点击下载链接，或直接在线打开复制全部内容
- 使用 curl 命令下载到本地

第二步：编写提示词

一个好的提示词应包含以下要素：

text

[角色定位] + [任务描述] + [环境信息] + [约束条件] + [输出要求] + [AI快速参考文本]

要素说明：

角色定位：告诉 AI 扮演什么角色（如"资深后端工程师"、"Python 脚本专家"）
任务描述：具体要完成什么功能，步骤越详细越好
环境信息：主机 IP、端口、实例 ID、镜像版本等实际参数
约束条件：使用的编程语言、库、代码风格等要求
输出要求：只要代码、需要注释、要错误处理等
AI快速参考文本：粘贴完整的 API 文档文本

第三步：让 AI 生成代码

将提示词发送给大语言模型，AI 会根据快速参考文档生成可运行的代码。

第四步：运行和调试

直接运行 AI 生成的代码
如有问题，将错误信息反馈给 AI 进行调试
AI 会根据快速参考中的错误码说明进行诊断

实际示例

示例 1：创建并启动实例（Node.js）

提示词：

text

你是资深 Node.js 工程师。下面是 VMOS Edge Container API 的完整参考文档。

请生成一个 Node.js 脚本，完成以下任务：
1. 创建一个新实例（用户名：test_user_001）
2. 等待创建完成后，启动该实例
3. 轮询实例状态，直到状态变为 running
4. 输出实例的完整信息

环境信息：
- 主机 IP：192.168.1.100
- 端口：18182
- 使用 axios 库发送请求
- 需要完整的错误处理
- 代码要有清晰的注释

【Container API 快速参考文本】
（粘贴完整的 ai-reference-container.txt 内容）

AI 生成的代码示例：

javascript

const axios = require('axios');

const BASE_URL = 'http://192.168.1.100:18182';

// 创建实例
async function createInstance(userName) {
  try {
    const response = await axios.post(`${BASE_URL}/container_api/v1/create`, {
      user_name: userName
    });
    
    if (response.data.code === 200) {
      console.log('实例创建成功:', response.data.data);
      return response.data.data.db_id;
    } else {
      throw new Error(`创建失败: ${response.data.msg}`);
    }
  } catch (error) {
    console.error('创建实例出错:', error.message);
    throw error;
  }
}

// 启动实例
async function startInstance(dbId) {
  try {
    const response = await axios.post(`${BASE_URL}/container_api/v1/start`, {
      db_id: dbId
    });
    
    if (response.data.code === 200) {
      console.log('实例启动请求已发送');
      return true;
    } else {
      throw new Error(`启动失败: ${response.data.msg}`);
    }
  } catch (error) {
    console.error('启动实例出错:', error.message);
    throw error;
  }
}

// 查询实例状态
async function getInstanceStatus(dbId) {
  try {
    const response = await axios.get(`${BASE_URL}/container_api/v1/query`, {
      params: { db_id: dbId }
    });
    
    if (response.data.code === 200) {
      return response.data.data.status;
    } else {
      throw new Error(`查询失败: ${response.data.msg}`);
    }
  } catch (error) {
    console.error('查询状态出错:', error.message);
    throw error;
  }
}

// 轮询直到 running
async function waitForRunning(dbId, maxWaitTime = 120000) {
  const startTime = Date.now();
  
  while (Date.now() - startTime < maxWaitTime) {
    const status = await getInstanceStatus(dbId);
    console.log(`当前状态: ${status}`);
    
    if (status === 'running') {
      console.log('实例已成功运行！');
      return true;
    }
    
    // 等待 3 秒后重试
    await new Promise(resolve => setTimeout(resolve, 3000));
  }
  
  throw new Error('等待超时，实例未能启动');
}

// 主流程
async function main() {
  try {
    console.log('开始创建实例...');
    const dbId = await createInstance('test_user_001');
    console.log(`实例 ID: ${dbId}`);
    
    console.log('开始启动实例...');
    await startInstance(dbId);
    
    console.log('等待实例运行...');
    await waitForRunning(dbId);
    
    console.log('任务完成！');
  } catch (error) {
    console.error('执行失败:', error.message);
    process.exit(1);
  }
}

main();

示例 2：批量安装 APK（Python）

提示词：

text

你是 Python 自动化专家。下面是 VMOS Edge Container API 的完整参考文档。

请生成一个 Python 脚本，完成以下任务：
1. 读取指定文件夹下的所有 APK 文件
2. 依次上传到指定的实例
3. 对每个 APK 安装并等待安装完成
4. 生成安装报告（成功/失败列表）

环境信息：
- 主机 IP：192.168.1.100
- 端口：18182
- 实例 ID：12345
- APK 文件夹：./apks/
- 使用 requests 库
- 需要进度条显示

【Container API 快速参考文本】
（粘贴完整的 ai-reference-container.txt 内容）

示例 3：自动化测试流程（混合使用两个 API）

提示词：

text

你是自动化测试工程师。下面是 VMOS Edge 的 Container API 和 Android Control API 完整参考文档。

请生成一个完整的测试脚本（语言不限），完成以下自动化测试流程：

测试场景：应用安装和启动测试
1. 创建一个新的测试实例
2. 启动实例并等待就绪
3. 上传并安装测试 APK（com.example.testapp）
4. 使用 Android Control API 启动该应用
5. 模拟点击屏幕中心位置
6. 输入文本 "Hello World"
7. 截图保存
8. 停止应用
9. 卸载应用
10. 删除测试实例

环境信息：
- 主机 IP：192.168.1.100
- 端口：18182
- APK 路径：./test.apk

要求：
- 每个步骤都要有日志输出
- 完整的错误处理和清理逻辑
- 如果任何步骤失败，要清理已创建的资源

【Container API 快速参考文本】
（粘贴 ai-reference-container.txt）

【Android Control API 快速参考文本】
（粘贴 ai-reference-control.txt）

示例 4：Web 控制面板（JavaScript SDK）

提示词：

text

你是前端开发专家。下面是 VMOS Edge JavaScript SDK 的完整参考文档。

请生成一个简单的 React 组件，实现远程控制 Android 设备的功能：

功能要求：
1. 显示实时视频流
2. 支持鼠标点击控制
3. 添加虚拟按键：返回、Home、最近任务
4. 显示连接状态
5. 错误提示

环境信息：
- 主机 IP：192.168.1.100
- 端口：18182
- 实例 ID：12345
- 使用 React Hooks
- 简洁的 CSS 样式

【JavaScript SDK 快速参考文本】
（粘贴 ai-reference-javascript.txt）

最佳实践

1. 提示词编写技巧

✅ 好的提示词：

text

你是资深 Python 开发者。下面是 Container API 文档。
请生成一个脚本，完成：
1. 创建实例（用户名：test001）
2. 启动实例
3. 轮询状态直到 running（最多等待 2 分钟）
约束：使用 requests 库，主机 192.168.1.100:18182，需要完整错误处理
【文档内容】...

❌ 不好的提示词：

text

帮我写个创建实例的代码

→ 太简略，AI 不知道用什么语言、什么库、什么环境

✅ 改进方法：

明确角色和技术栈
详细列出步骤
提供完整的环境参数
说明代码风格要求

2. 分步骤开发

对于复杂任务，建议分多次对话完成：

第一步：让 AI 生成基础功能

text

先生成创建实例并等待启动的代码

第二步：在第一步的基础上扩展

text

在上面的代码基础上，增加安装 APK 的功能

第三步：添加错误处理和优化

text

添加完整的错误处理、日志输出、超时控制

3. 利用 AI 的迭代能力

如果生成的代码有问题：

text

代码运行时报错：[错误信息]
请根据快速参考文档中的错误码说明，修复这个问题

AI 会根据文档中的错误码说明，自动诊断并修复问题。

4. 多语言转换

已经有 Python 版本，想要 Node.js 版本：

text

将上面的 Python 代码转换为 Node.js 版本
使用 axios 库，保持相同的逻辑和错误处理

5. 代码优化

text

优化上面的代码：
1. 添加重试机制（失败重试 3 次）
2. 添加详细的日志
3. 使用 async/await 简化代码
4. 添加类型注解（TypeScript）

常见问题

问题 1：AI 生成的参数不正确

原因：提示词中没有提供具体的环境参数

解决：在提示词中明确指定：

text

环境信息：
- 主机 IP：192.168.1.100（必须使用这个 IP）
- 端口：18182
- 实例 ID：12345（如果已经有实例）
- 用户名：test_user_001（创建新实例时使用）

问题 2：生成的代码没有错误处理

原因：没有在提示词中明确要求

解决：加上错误处理要求：

text

要求：
- 每个 API 调用都要有 try-catch
- 检查返回的 code 是否为 200
- 根据快速参考中的错误码说明，给出友好的错误提示

问题 3：忽略了异步操作

原因：没有强调需要等待异步任务完成

解决：明确说明异步流程：

text

注意：创建/启动/删除都是异步操作，必须：
1. 调用接口后，立即轮询状态
2. 每隔 2-3 秒查询一次
3. 设置最大等待时间（如 2 分钟）
4. 超时后抛出异常

问题 4：混淆了两个 API

原因：没有区分 Container API 和 Android Control API 的使用场景

解决：在提示词中说明：

text

使用 Container API 的场景：
- 创建、启动、停止、删除实例
- 上传文件、安装 APK
- 查询主机和实例信息

使用 Android Control API 的场景：
- 启动、停止应用
- 模拟点击、滑动、输入
- 管理权限、联系人、短信
- 控制 GPS、传感器、电池

问题 5：文件上传接口报错

原因：文件上传必须使用 multipart/form-data 格式

解决：在提示词中强调：

text

注意：
- 文件上传接口（如上传 APK、图片）必须使用 multipart/form-data
- 不能使用 JSON 格式
- 参考快速参考文档中的文件上传示例

问题 6：生成的代码太简单

原因：没有提出详细的功能需求

解决：详细描述需要的功能：

text

生成一个生产级别的代码，包含：
- 命令行参数解析
- 配置文件读取
- 日志输出（info、warn、error）
- 进度条显示
- 断点续传
- 并发控制
- 优雅退出

使用技巧

技巧 1：使用工具链调用

对于支持工具调用的 AI（如 ChatGPT、Claude）：

text

你是 API 专家。我提供 VMOS Edge API 文档。
当我说"创建实例"时，你直接调用对应的 API 接口，并返回结果。

【快速参考文档】...

现在执行：创建一个名为 test001 的实例

AI 会直接生成 API 调用并执行。

技巧 2：生成测试用例

text

根据 Container API 文档，生成完整的测试用例（pytest）：
1. 测试创建实例（正常/异常情况）
2. 测试启动实例（正常/异常情况）
3. 测试查询状态
4. 测试删除实例
包含 mock 和断言

技巧 3：生成 API 客户端封装

text

根据 Container API 文档，生成一个完整的 Python SDK：
- 类名：VMOSEdgeClient
- 包含所有 API 方法的封装
- 自动处理异步轮询
- 统一的错误处理
- 支持链式调用
- 完整的类型注解和文档字符串

技巧 4：生成配置文件和脚本

text

生成一个完整的项目结构：
1. config.yaml（配置文件模板）
2. main.py（主程序）
3. utils.py（工具函数）
4. requirements.txt（依赖列表）
5. README.md（使用说明）

功能：批量管理 VMOS Edge 实例的自动化工具

技巧 5：跨平台兼容

text

生成一个跨平台的实例管理工具（Python）：
- 支持 Windows、Linux、macOS
- 配置文件统一管理
- 路径处理兼容各系统
- 使用 pathlib 和 os.path

进阶玩法

1. 支持 URL 读取的 AI（推荐）

对于支持网络访问的 AI（如 Kimi、ChatGPT Plus、Claude Pro），可以直接读取 URL，无需下载：

提示词模板：

text

请访问并读取以下文档：
https://help.vmosedge.com/ai-reference-container.txt

然后根据文档生成一个 Python 脚本，实现以下功能：
1. 创建名为 test001 的实例
2. 启动实例并等待运行
3. 安装 APK 文件

环境：IP=192.168.1.100, Port=18182

优势：

✅ 无需手动复制粘贴大量文本
✅ AI 直接获取最新版本的文档
✅ 节省时间和 token 消耗

2. 结合 Cursor/Continue

如果你使用 Cursor 或 Continue（AI 编程助手）：

将 AI 快速参考文本保存到项目目录
在 Cursor 中使用 @filename 引用文档
直接在代码中请求 AI 生成功能

示例：

text

@ai-reference-container.txt 
生成一个 ContainerManager 类，封装所有实例管理功能

完整文档参考

如需查看详细的 API 说明、完整示例和最佳实践，请参考：

Container API 完整文档 - 详细的接口说明和业务流程
Android Control API 完整文档 - Android 控制 API 详细说明
JavaScript SDK 完整文档 - Web SDK 完整教程和 API 参考

总结

AI 快速参考的优势：

✅ 开发效率提升 10 倍：从查文档、写代码、调试 → 描述需求、运行代码
✅ 降低学习成本：无需深入了解 API 细节，AI 自动处理
✅ 跨语言开发：一份文档，生成任何语言的代码
✅ 智能错误处理：AI 根据错误码自动诊断和修复
✅ 快速迭代：需求变更时，只需修改提示词，重新生成代码

什么时候应该查看完整文档？

需要深入了解 API 的业务逻辑和最佳实践
AI 生成的代码出现问题，需要手动调试
需要了解 API 的限制和注意事项
学习完整的使用示例和高级特性

开始使用：

📥 下载对应的 AI 快速参考文本
📝 编写清晰的提示词（参考本文示例）
🤖 让 AI 生成代码
▶️ 运行并享受自动化的乐趣！

提示：如果您在使用过程中遇到问题或有改进建议，欢迎反馈！

AI快速参考使用指南 ​

什么是 AI 快速参考？ ​

下载纯文本版本 ​

使用方法 ​

第一步：获取 AI 快速参考文本 ​

第二步：编写提示词 ​

第三步：让 AI 生成代码 ​

第四步：运行和调试 ​

实际示例 ​

示例 1：创建并启动实例（Node.js） ​

示例 2：批量安装 APK（Python） ​

示例 3：自动化测试流程（混合使用两个 API） ​

示例 4：Web 控制面板（JavaScript SDK） ​

最佳实践 ​

1. 提示词编写技巧 ​

2. 分步骤开发 ​

3. 利用 AI 的迭代能力 ​

4. 多语言转换 ​

5. 代码优化 ​

常见问题 ​

问题 1：AI 生成的参数不正确 ​

问题 2：生成的代码没有错误处理 ​

问题 3：忽略了异步操作 ​

问题 4：混淆了两个 API ​

问题 5：文件上传接口报错 ​

问题 6：生成的代码太简单 ​

使用技巧 ​

技巧 1：使用工具链调用 ​

技巧 2：生成测试用例 ​

技巧 3：生成 API 客户端封装 ​

技巧 4：生成配置文件和脚本 ​

技巧 5：跨平台兼容 ​

进阶玩法 ​

1. 支持 URL 读取的 AI（推荐） ​

2. 结合 Cursor/Continue ​

完整文档参考 ​

总结 ​

AI快速参考使用指南

什么是 AI 快速参考？

下载纯文本版本

使用方法

第一步：获取 AI 快速参考文本

第二步：编写提示词

第三步：让 AI 生成代码

第四步：运行和调试

实际示例

示例 1：创建并启动实例（Node.js）

示例 2：批量安装 APK（Python）

示例 3：自动化测试流程（混合使用两个 API）

示例 4：Web 控制面板（JavaScript SDK）

最佳实践

1. 提示词编写技巧

2. 分步骤开发

3. 利用 AI 的迭代能力

4. 多语言转换

5. 代码优化

常见问题

问题 1：AI 生成的参数不正确

问题 2：生成的代码没有错误处理

问题 3：忽略了异步操作

问题 4：混淆了两个 API

问题 5：文件上传接口报错

问题 6：生成的代码太简单

使用技巧

技巧 1：使用工具链调用

技巧 2：生成测试用例

技巧 3：生成 API 客户端封装

技巧 4：生成配置文件和脚本

技巧 5：跨平台兼容

进阶玩法

1. 支持 URL 读取的 AI（推荐）

2. 结合 Cursor/Continue

完整文档参考

总结