replaceNumPlate-v3

Description

This feature allows users to upload an image without associating it with a predefined template. Users can submit images independently, and the system will process them without template constraints, offering flexibility in number plate processing.

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.

Limits

Max Upload Limit: 20 images per request

API Request & Response Guidelines

🟢 200 OK

Images Processed Successfully (Number Plate Replacement v3 with Instant AI Result)

Returned when images are processed with instant AI output (CDN-based response).

Response Example:

{
  "status": true,
  "message": "Data Processed",
  "data": {
    "batchID": 10000294314,
    "images": [
      {
        "status": true,
        "picID": 679125,
        "s3": "https://cdn-url.com/image.jpg"
      }
    ]
  }
}

Images Processed Successfully (Number Plate Replacement v3 with Collab, manual QA/QC)

Returned when images are processed under collaboration / manual QA-QC workflow.

Response Example:

{
  "status": true,
  "message": "Data Processed",
  "data": {
    "batchID": 10000296956,
    "images": [
      {
        "fileName": "Front-baleno.jpg",
        "error": false,
        "errorMsg": ""
      }
    ]
  }
}

Response Field Details

batchID: Unique batch identifier used for tracking processing

images: Array of uploaded images

status: Boolean indicating success/failure at batch creation level

AI Mode Fields

status: Image's AI processing status

picID: Unique identifier for image

s3: URL of AI processed image output (example: https://cdn-url.com/image.jpg)

Collab Mode Fields

fileName: Original uploaded file name

error: Boolean indicating uploading failure

errorMsg: Error message if uploading failed

🟢 200 OK (Business Validation Errors)

Mandatory Fields

Missing numberPlate

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

Missing numPlateProcessor/ Invalid numPlateProcessor

{
  "status": false,
  "message": "numPlateProcessor field`s accepted values: [1, 2]"
}

Missing processType

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

Missing Number Plate Image (Processor = 2)

{
  "status": false,
  "message": "Provide an image file to replace number plate"
}

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."
}

🔴 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.

replaceNumPlate-v3

Description#

API Request & Response Guidelines#

🟢 200 OK#

Images Processed Successfully (Number Plate Replacement v3 with Instant AI Result)#

Images Processed Successfully (Number Plate Replacement v3 with Collab, manual QA/QC)#

Response Field Details#

🟢 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#

🔴 500 Internal Server Error#

Important Note#

Request

Responses