Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, and mostly they will be yours, not ours. Let's look at some status codes and error types you might encounter.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong and do some rudimentary debugging (before contacting support).

Before reaching out to support with an error, please be aware that 99% of all reported errors are, in fact, user errors. Therefore, please carefully check your code before contacting Lux support.

Status codes

Here is a list of the different categories of status codes returned by the Lux API. Use these to understand if a request was successful.

Name
2xx
Description
A 2xx status code indicates a successful response.
Name
4xx
Description
A 4xx status code indicates a client error — this means it's a you problem.
Name
5xx
Description
A 5xx status code indicates a server error — you won't be seeing these.

Error types

Whenever a request is unsuccessful, the Lux API will return an error response with an error type and message. You can use this information to better understand what went wrong and how to resolve it. Our error messages are designed to be helpful and actionable, guiding you toward successful implementation of multiplayer experiences.

Here is a list of the error types supported by the Lux API — use these to troubleshoot issues in your integration:

Name
api_error
Description
This means that we made an error, which is highly speculative and unlikely.
Name
invalid_request
Description
This means that you made an error, which is much more likely.
Name
rate_limit_error
Description
You've exceeded the number of requests allowed in a specific time period. Implement backoff strategies and optimize your API usage.

Error response

{
  "status_code": 500,
  "type": "api_error",
  "message": "No way this is happening!?",
  "documentation_url": "https://dev.lux.gg/docs/errors"
}