REST API
Reachy Mini守护进程在http://<daemon-ip>:8000/api公开HTTP和WebSocket API。
- Lite — 守护进程在您的机器上运行:
http://localhost:8000 - 无线 — 守护进程在机器人上运行:
http://reachy-mini.local:8000
当守护进程运行时,您可以在以下位置浏览交互式Swagger UI
- http://localhost:8000/docs(Lite — 守护进程在您的机器上)
- http://reachy-mini.local:8000/docs(无线 — 守护进程在机器人上)
下面的参考从相同的OpenAPI规范生成,可以在没有运行守护进程的情况下查阅。
端点概览
| 类别 | 前缀 | 描述 |
|---|---|---|
| 应用 | /api/apps | 列出、安装、启动和停止应用 |
| 守护进程 | /api/daemon | 启动、停止和重启守护进程 |
| 状态 | /api/state | 读取头部姿态、身体偏航、天线、DoA |
| 移动 | /api/move | Goto、设置目标、播放录制移动 |
| 电机 | /api/motors | 获取电机状态、设置控制模式 |
| 运动学 | /api/kinematics | IK信息、URDF和STL网格文件 |
| 音量 | /api/volume | 扬声器和麦克风音量控制 |
| HF认证 | /api/hf-auth | Hugging Face令牌管理 |
完整参考
更复杂的应用
请参阅JavaScript SDK和Web应用页面,了解使用JavaScript SDK的更复杂应用的示例,该SDK利用WebRTC传输并为视频、音频和机器人控制提供更高级别的抽象。