🔌 Reachy Mini API Reference

⚠️ Backend Activation Required

Movement APIs will return {"detail":"Backend not running"} until you activate the backend via the red switch in the dashboard at http://reachy-mini.local:8000/

POST/health-check

Check if Reachy dashboard is responding

Example Request:

curl -X POST http://reachy-mini.local:8000/health-check

Example Response:

{"status":"ok"}

📊 Common Response Codes

Code	Meaning	Common Cause
200	Success	Movement started successfully
404	Not Found	Invalid endpoint or movement name
422	Backend not running	Red switch not activated in dashboard
500	Server Error	Backend crashed or hardware issue

🐍 Python Examples

import requests
import time

REACHY_URL = "http://reachy-mini.local:8000"

# Check health
def check_health():
    response = requests.post(f"{REACHY_URL}/health-check")
    return response.json()

# Play emotion
def play_emotion(emotion_name):
    url = f"{REACHY_URL}/api/move/play/recorded-move-dataset/"
    url += f"pollen-robotics/reachy-mini-emotions-library/{emotion_name}"
    response = requests.post(url)
    return response.json()

# Play sequence
def greeting_sequence():
    play_emotion("curious1")
    time.sleep(4)
    play_emotion("amazed1")
    time.sleep(4)
    play_emotion("welcoming1")

# List all emotions
def list_emotions():
    url = f"{REACHY_URL}/api/move/recorded-move-datasets/list/"
    url += "pollen-robotics/reachy-mini-emotions-library"
    response = requests.get(url)
    return response.json()

if __name__ == "__main__":
    print("Health:", check_health())
    print("Emotions:", list_emotions()[:5], "...")
    print("Playing curious...")
    play_emotion("curious1")