Errors

The Abyssale Generation API (synchronous or asynchronous) can return the following error codes:

Code	Description
400	Bad Request — your request is invalid. Either a parameter is wrong or the generation failed. A JSON payload is returned explaining the error.
401	Unauthorized — no API key provided or the key is invalid.
403	Forbidden — the API key is valid but lacks permission (wrong workspace, plan limit reached).
404	Not Found — the route or the given design cannot be found.
405	Method Not Allowed — you tried to access Abyssale with an invalid HTTP method.
429	API Limits Reached — all of your image generation API calls are consumed. Upgrade to a higher plan.
500	Internal Server Error — try again later. Contact [email protected] if the error persists.

400 error examples

If a given parameter is invalid (e.g. an invalid color):

{
  "message": "body_validation_errors: {'media': {'text_role': [\"The following property is invalid: ({'color': ['Must be an hexadecimal color. i.e. #EAEAEA']}).\"]}}",
  "errors": {
    "media": {
      "text_role": ["The following property is invalid: ({'color': ['Must be an hexadecimal color. i.e. #EAEAEA']})."]
    }
  }
}

If a text cannot fit:

{
  "id": "cannot_build_banner",
  "message": "Element text_name error: The text 'Welcome to the Abyssale Developer Hub' cannot fit within the defined space."
}

HTTP 400 Error Details

Error	Description
Invalid Image	The given image cannot be identified. Only jpeg, png, webp, gif, tiff, and svg files are allowed.
SVG security error	The SVG contains security issues. Ensure version ≥ 1.1 or optimize via SVGOMG.
Large SVG error	The SVG is too large or heavy. Use another SVG or a rasterized image.
QR code not supported extension	The QR code icon filetype is not supported (supported: png, jpeg, webp, tiff, gif).
Text too long	The text cannot fit within the defined space.
InvalidFont	The font doesn't exist.
Button text too long	The button text cannot fit within the defined space.
InvalidIllustration	The illustration doesn't exist.

Related

• Generate Single Image — endpoint that returns these errors
• Asynchronous Generation — async endpoints that return these errors
• Authentication — for 401 and 403 errors