Upload/Process S3 Urls without Template.

Description

This API processes images provided as accessible S3 URLs to generate transparent outputs, including background removal and enhancement for low-resolution images.

Users can submit up to 45 urls per request, and the system will process them accordingly.

Processing Types :

1. AI Processing
Use the following process type to receive AI-generated results:

"processType": "ai"

2. QA / Collaboration Processing
Use the following process type for QA or collaboration-based workflows:

"processType": "collab"

For real-time completion updates, refer to the AI/Collab Processing Webhook Notification Doc.

Rate Limits

API Rate Limit: 10 requests per minute per user

Image Processing Limit: 10 images per minute per user

Max Upload Limit: 45 image urls per request

API Request & Response Guidelines

🟢 200 OK

Images Processed Successfully

Returned when all validations pass and image processing completes successfully.

{
    "status": true,
    "message": "Data Processed",
    "data": {
        "batchID": 1474,
        "images": [
            {
                "fileName": "AHL64S_01.jpg",
                "error": false,
                "errorMsg": ""
            }
        ]
    }
}

🟢 200 OK (Business Validation Errors)

Mandatory Fields

Missing numberPlate

{
  "status": false,
  "message": "Number Plate is Required"
}

Missing processType

{
  "status": false,
  "message": "processType field`s accepted values: [`ai`, `collab`]"
}

File Validation Errors

File Not Allowed

{
  "status": false,
  "message": "File Not Allowed, Replace [image.jpg] with valid image file"
}

File Size Exceeded

{
  "status": false,
  "message": "File Max Size Exceeded! Allowed [image.jpg] Size: 15 MB"
}

File Not Uploaded

{
  "status": false,
  "message": "File Not Uploaded, [image.jpg]"
}

Invalid File Name

{
  "status": false,
  "message": "File Not Allowed, [image.jpg] should only contain English Character Set. Please rename the file and try again."
}

No Active Plan

No Active Plan History

{
  "status": false,
  "message": "No Active Plan History",
  "data": {}
}

User plan data Missing

{
  "status": false,
  "message": "Insufficient Credits to Process Images.",
  "data": {}
}

🟠 401 Unauthorized

Missing or Invalid Authorization

Returned when authentication fails.

Possible reasons:

Authorization header missing

API key invalid

User not found or inactive

{
  "status": false,
  "message": "You are not Authorized"
}

🟠 429 Too Many Requests

API Request Rate Limit Exceeded

Returned when the user exceeds the allowed number of API requests within the configured time window.

{
  "status": false,
  "message": "Rate limit exceeded."
}

Image Processing Limit Exceeded

Returned when the total number of submitted images exceeds the user's image-processing quota for the current 1-minute window.

{
  "status": false,
  "message": "Image creation limit reached (10 images per minute) for this endpoint. Please retry after 1 minute."
}

🔴 500 Internal Server Error

Returned when an unexpected error occurs during processing.

{
  "status": false,
  "message": "Internal server error"
}

Generic format:

{
  "status": false,
  "message": "<error message>",
  "data": []
}

Important Note

Consumers of this API should not rely solely on the HTTP status code. Some validation and business-rule failures may return HTTP 200 OK with "status": false in the response body. Always inspect the status field to determine whether the operation succeeded.

Upload/Process S3 Urls without Template.

Description#

API Request & Response Guidelines#

🟢 200 OK#

Images Processed Successfully#

🟢 200 OK (Business Validation Errors)#

Mandatory Fields#

File Validation Errors#

No Active Plan#

🟠 401 Unauthorized#

Missing or Invalid Authorization#

🟠 429 Too Many Requests#

API Request Rate Limit Exceeded#

Image Processing Limit Exceeded#

🔴 500 Internal Server Error#

Important Note#

Request

Responses