Error Documentation

This section provides an in-depth explanation of errors encountered while interacting with Imagine’s system. Errors are categorized to help you pinpoint issues and apply effective solutions.

Error Schema

In case of any error, the API will return a response in the following JSON format:

{
    "status": "error",           // Status of the response
    "code": 1208,                // Internal error code for debugging
    "error": "Unauthorized",     // Error name
    "message": "The provided API key is invalid." // Detailed description of the error
}

This structure ensures consistency in error handling and provides clear information for debugging and resolution.

Error Categories

Errors in the Imagine system are grouped into four main categories:

• Authorization Errors

• Validation Errors

• Service Errors

• VAG Errors

Each category is explored in detail below.

Authorization Errors

Authorization errors relate to user authentication and access privileges. Common errors include:

Code	Status	Message	Description
1000	BadRequest (400)	The bearer token is missing from the header.	Ensure you provide a valid bearer token.
1001	Unauthorized (401)	The bearer token passed is invalid.	Verify your token and try again.
1002	NotAcceptable (406)	The bearer token has expired.	Refresh your token or obtain a new one.
1003	BadRequest (400)	Error validating the captcha.	Check the captcha input.
1004	BadRequest (400)	The captcha is required.	Provide a captcha value.
1005	Unauthorized (401)	Application could not be validated.	Verify application credentials.
1006	Unauthorized (401)	Device validation failed.	Check device settings and permissions.
1007	Unauthorized (401)	Account could not be validated.	Ensure account credentials are correct.

Validation Errors

Validation errors occur when submitted data does not meet criteria. Example:

Code	Status	Message	Description
1100	BadRequest (400)	The request is invalid.	May involve missing, incorrect, or non-existent style IDs.
1101	PaymentRequired (402)	Not enough tokens.	Purchase a subscription or top-up tokens.

Service Errors

Service errors can arise due to server or connectivity issues:

Code	Status	Message	Description
1200	ServiceUnavailable (503)	Service not available.	Linked to SVI or reverse proxy failures.
1201	ServiceUnavailable (503)	Unable to connect to Redis.	Check Redis service status.
1202	TooManyRequests (429)	Excessive requests.	Consider rate-limiting strategies.
1203	ServiceUnavailable (503)	Database connection failed.	Occurs during database querying issues.
1204	GatewayTimeout (504)	Request timed out.	Retry the request.
1205	InternalServiceError (500)	Unexpected service response.	May arise during response unmarshaling.
1206	NotImplemented (503)	Unsupported service.	Service is unavailable.

VAG Errors

VAG (Vague and General) errors are broad error categories covering multiple issues:

Code	Status	Message	Description
1300	InternalServerError (500)	Internal server error.	Causes vary. Inspect response details for clues.

If you face Service Error or VAG Errors, please reach out to Imagine Support as soon as possible.