API REST
O daemon do Reachy Mini expõe uma API HTTP e WebSocket em http://<daemon-ip>:8000/api.
- Lite — o daemon é executado na sua máquina:
http://localhost:8000 - Wireless — o daemon é executado no robô:
http://reachy-mini.local:8000
Quando o daemon está em execução, você pode acessar a Swagger UI interativa em
- http://localhost:8000/docs (Lite — daemon na sua máquina)
- http://reachy-mini.local:8000/docs (Wireless — daemon no robô)
A referência abaixo é gerada a partir da mesma especificação OpenAPI e pode ser consultada sem que o daemon esteja em execução.
Visão geral dos endpoints
| Categoria | Prefixo | Descrição |
|---|---|---|
| Apps | /api/apps | Listar, instalar, iniciar e parar apps |
| Daemon | /api/daemon | Iniciar, parar e reiniciar o daemon |
| State | /api/state | Ler pose da cabeça, yaw do corpo, antenas, DoA |
| Move | /api/move | Ir para, definir alvo, reproduzir movimentos gravados |
| Motors | /api/motors | Obter status do motor, definir modo de controle |
| Kinematics | /api/kinematics | Informações de IK, arquivos de malha URDF e STL |
| Volume | /api/volume | Controle de volume do alto-falante e do microfone |
| HF Auth | /api/hf-auth | Gerenciamento de token do Hugging Face |
Referência completa
Abrir em página inteira · Baixar especificação OpenAPI (JSON)
Apps mais complexos
Consulte a página JavaScript SDK & Web Apps para exemplos de apps mais complexos usando o JavaScript SDK, que aproveita o transporte WebRTC e fornece abstrações de nível mais alto para vídeo, áudio e controle do robô.