# Error responses

These are some error codes that can be returned in our responses.

```
{
    "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", 
    "payload": {
        "errorCode": "notSupported"
    }
}
```

| Error code      | Details                                                                                                                           |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| authFailure     | General failure to authenticate.                                                                                                  |
| deviceOffline   | The target is unreachable.                                                                                                        |
| timeout         | Internal timeout.                                                                                                                 |
| deviceNotFound  | The device doesn't exist on the partner's side. This normally indicates a failure in data synchronization or a race condition.    |
| valueOutOfRange | The range in parameters is out of bounds.                                                                                         |
| notSupported    | The command or its parameters are unsupported (this should generally not happen, as traits and business logic should prevent it). |
| protocolError   | Failure in processing the request.                                                                                                |
| unknownError    | Everything else, although anything that throws this should be replaced with a real error code.                                    |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://cupnoodles.gitbook.io/open-api/error-responses.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
