Error Model

API errors use a consistent JSON envelope.

JSON
{
  "error": {
    "code": "device_not_connected",
    "message": "No connected client is available for the requested operation.",
    "requestId": "2fab0d0e-bcab-4990-bf6c-9506d2845e05",
    "details": {
      "deviceId": "71c60489-f9a3-41d7-a83c-8290ec8ba711"
    }
  }
}

Common categories

  • invalid payload
  • missing or invalid API key
  • requested device not found
  • no connected client available
  • execution timeout
  • unsupported operation
  • capacity or throttling condition

Status codes

Expect standard status codes such as 400, 401, 404, 409, 429, and 504.