Errors
In this guide, we will talk about what happens when something goes wrong while you work with the API.
You can tell if your request was successful by checking the status code when receiving an API response.
Status codes
Here is a list of the different categories of status codes returned by the Video Jungle 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 Video Jungle API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages should be helpful and actionable. If they're not, you should let us know.
Here is a list of the two error types supported by the Video Jungle API — use these to understand what you have done wrong.
- Name
api_error- Description
This means that we made an error, we have monitoring and will take a look.
- Name
invalid_request- Description
Be sure to take a look at the matching API endpoint in the OpenAPI spec.
Error response
{
"type": "api_error",
"message": "No way this is happening!?",
"documentation_url": "https://docs.video-jungle.com/errors/api_error"
}