Skip to main content
CadreenResearch Preview
DocumentationAPI ReferenceGuides & Cookbooks
Back to Hardware
API Reference

Hardware API reference

43 endpoints across 9 categories. All endpoints require authentication via the standard Cadreen API key.

POST/api/v1/cadreen/devices

Register a new device.

Response
{
  "id": "robot-1",
  "status": "connected",
  "message": "Device added"
}

Example

Example
curl -X POST http://localhost:8080/api/v1/cadreen/devices \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id": "robot-1", "pose": {"position": {"x": 0, "y": 0, "z": 0}}}'
GET/api/v1/cadreen/devices

List all registered devices.

Response
{
  "devices": [{"id": "robot-1", "pose": {...}, "battery": {...}}],
  "total": 1
}

Example

Example
curl http://localhost:8080/api/v1/cadreen/devices \
  -H "Authorization: Bearer YOUR_API_KEY"
GET/api/v1/cadreen/devices/{deviceID}

Get details for a specific device.

Response
{
  "id": "robot-1",
  "pose": {...},
  "twist": {...},
  "battery": {...},
  "last_update": "2026-07-18T10:30:00Z"
}

Example

Example
curl http://localhost:8080/api/v1/cadreen/devices/robot-1 \
  -H "Authorization: Bearer YOUR_API_KEY"
DELETE/api/v1/cadreen/devices/{deviceID}

Remove a device from Cadreen.

Response
{
  "id": "robot-1",
  "status": "removed",
  "message": "Device removed"
}

Example

Example
curl -X DELETE http://localhost:8080/api/v1/cadreen/devices/robot-1 \
  -H "Authorization: Bearer YOUR_API_KEY"
GET/api/v1/cadreen/devices/{deviceID}/status

Get a device's status and battery level.

Response
{
  "id": "robot-1",
  "status": "working",
  "battery": {"percentage": 0.85, "voltage": 12.1},
  "pose": {...}
}

Example

Example
curl http://localhost:8080/api/v1/cadreen/devices/robot-1/status \
  -H "Authorization: Bearer YOUR_API_KEY"
POST/api/v1/cadreen/devices/{deviceID}/state

Update a device's position, velocity, or sensor data.

Response
{
  "id": "robot-1",
  "status": "updated",
  "message": "Device state updated"
}

Example

Example
curl -X POST http://localhost:8080/api/v1/cadreen/devices/robot-1/state \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"pose": {"position": {"x": 2.0, "y": 3.0, "z": 0.0}}}'
GET/api/v1/cadreen/devices/{deviceID}/health

Get device health: resource state (battery, temperature, CPU, memory) and unsafe flag.

Response
{
  "device_id": "robot-1",
  "resource_state": {
    "battery": 0.85,
    "temperature": 42.5,
    "cpu_load": 0.3,
    "memory_usage": 0.45,
    "network_latency_ms": 12.0
  },
  "is_unsafe": false
}

Example

Example
curl http://localhost:8080/api/v1/cadreen/devices/robot-1/health \
  -H "Authorization: Bearer YOUR_API_KEY"