Introduction

Errors are an inevitable part of working with any API. They can arise from a variety of sources, such as incorrect input data, server issues, or exceeded usage limits. Understanding these errors is crucial for efficient troubleshooting and maintaining a smooth interaction with our services.

Tips for Handling Errors

When you encounter an error while using the Sortium API, here are some practical steps to help you resolve it:

Check the Error Code and Message

Each error response includes a specific error code and a detailed message. Use these to understand the nature of the error and the potential cause.

Review the Documentation

Refer back to this error documentation section. It provides explanations for each error code and guidance on how to address them.

Use the x-request-id Header

For every API request, our system generates a unique x-request-id header. This ID is crucial for tracing and debugging issues. If you're unable to resolve the issue on your own or need further assistance, include this x-request-id when contacting our support team. It allows us to quickly locate your specific request in our logs and understand the context of the error.

Contact Support

If the error persists or if you're unsure how to proceed, don't hesitate to contact our support team. Provide them with the error code, message, and the x-request-id for a faster and more effective resolution.

Monitor for Recurring Errors

Keep track of any recurring errors and the scenarios in which they occur. This can help in identifying patterns and potential areas for improvement in your usage of the API.

Stay Informed About Updates

Regularly check our documentation for any updates or changes. We continuously work on improving our API, and understanding the latest changes can help prevent errors.

Error List

400 - Bad Request

ERR-2001

{
    "status_code": 400,
    "detail": "Invalid export format selected. Please choose from the available valid formats. Refer to our documentation for a list of supported formats."
}

ERR-2002

{
    "status_code": 400,
    "detail": "The provided reference image is invalid. Please ensure you upload a valid image file. Consult our documentation for supported formats and guidelines."
}

ERR-2003

{
    "status_code": 400,
    "detail": "The provided reference image URL is invalid. Please ensure you are using a valid URL. Refer to our documentation for URL format guidelines."
}

ERR-2004

{
    "status_code": 400,
    "detail": "Reference image must be in PNG or JPG format. Please upload a valid image file. Consult our documentation for more information on supported file types."
}

ERR-2005

{
    "status_code": 400,
    "detail": "Validation of the GLTF file failed. Please recheck the file format and try again later. If the issue continues, consult our documentation or contact support for help."
}

ERR-2005: GLTF File Validation Failure Due to Exceeding Limits

{
    "status_code": 400,
    "detail": "Validation of the GLTF file failed. Please recheck the file format and try again later. If the issue continues, consult our documentation or contact support for help.",
  	"model_summary": {
        "cameras": 3,
        "materials": 5,
        "meshes": 10,
        "nodes": 8,
        "scenes": 2,
        "textures": 15,
        "file_size": 256.5
		},
  	"limits": {
        "cameras": 20,
        "materials": 40,
        "meshes": 40,
        "nodes": 80,
        "scenes": 2,
        "textures": 20,
        "file_size": 128
		}
}

The specified limits do not accurately reflect the current actual values on our services. Please ensure the provided limits align with the current rules and constraints enforced by our services.

ERR-3002

{
    "status_code": 400,
    "detail": "Invalid texture size specified. Please select a valid size within the accepted range. Refer to our documentation for allowable dimensions."
}

ERR-3003

{
    "status_code": 400,
    "detail": "Invalid texture configuration. Please select a valid configuration. For guidance on acceptable configurations, refer to our documentation."
}

ERR-3004

{
    "status_code": 400,
    "detail": "Invalid texture configuration. When 'select_all' is enabled, you must send an object. Please review your settings and consult our documentation for further instructions."
}

ERR-3005

{
    "status_code": 400,
    "detail": "Texture configuration is invalid; kindly select a valid configuration."
}

ERR-3006

{
    "status_code": 400,
    "detail": "Invalid texture configuration. If select_all is enabled, ensure you send an object as part of the configuration."
}

ERR-5003

{
    "status_code": 400,
    "detail": "Original interaction not found. The parent object does not exist in the database and cannot be referenced. Please verify the reference or consult our documentation for guidance."
}

ERR-5004

{
    "status_code": 400,
    "detail": "Please upload a file or provide a valid original_interaction_id. Ensure one of these inputs is correctly specified for processing."
}

401 - Unauthorized

ERR-1001

{
    "status_code": 400,
    "detail": "The provided API key is invalid. Please check your key and try again. If the issue persists, please contact support."
}

ERR-1002

{
    "status_code": 400,
    "detail": "Issues detected while decoding the specified JWT. Ensure your token is valid and formatted correctly. For persistent issues, please contact our support team for assistance."
}

403 - Forbidden

ERR-6001

{
    "status_code": 400,
    "detail": "Maximum credit limit reached. Please review your usage or upgrade your plan for additional credits. For more information, visit our billing section or contact support for assistance."
}

429 - Too Many Requests

ERR-4004

{
    "status_code": 400,
    "detail": "Queue limit reached. Please try again later or consider upgrading your plan for higher capacity. Visit our billing section for plan details, or contact support for assistance."
}

500 - Internal Server Error

ERR-2007

{
    "status_code": 400,
    "detail": "Internal error encountered while validating GLTF file."
}

ERR-4001

{
    "status_code": 400,
    "detail": "Internal server error. We're working to resolve the issue. Please try your request again later or contact support for assistance."
}

ERR-5002

{
    "status_code": 400,
    "detail": "We encountered an issue while creating the interaction in the database. Please ensure your request is correctly formatted. If this issue continues, contact our support team for assistance, providing any relevant details about your request."
}

ERR-5005

{
    "status_code": 400,
    "detail": "Queue ID not received from Texture Generation queue. Please ensure your request is properly formatted and try again. Contact support if the issue persists."
}

ERR-6003

{
    "status_code": 400,
    "detail": "Failed to generate the asset. This could be due to a temporary server issue or a problem with the generated asset. Please verify your request and try again. If the issue persists, contact our support team for further assistance."
}

ERR-6005

{
    "status_code": 400,
    "detail": "Failed to send metrics. Check your network connection and ensure the metrics format is correct. For assistance, contact support."
}

502 - Bad Gateway

ERR-2006

{
    "status_code": 400,
    "detail": "GLTF file validation failed. Unable to connect to the file storage host."
}

ERR-4002

{
    "status_code": 400,
    "detail": "Unable to connect to the Texture Generation server. This may be due to a temporary server issue or network problem. Please try your request again later. If the problem persists, contact our support team for further assistance."
}

ERR-4003

{
    "status_code": 400,
    "detail": "Unable to connect to the billing service. This may be due to a temporary server issue or network problem. Please try your request again later. If the problem persists, contact our support team for further assistance."
}

ERR-6004

{
    "status_code": 400,
    "detail": "Failed to generate the preview image. This could be due to a temporary server issue or a problem with the generated asset. Please verify your request and try again. If the issue persists, contact our support team for further assistance."
}

503 - Service Unavailable

ERR-7001

{
    "status_code": 503,
    "detail": "Maintenance mode is active."
}