Get Image Status

Description

This API provides the status of uploaded and processed images. It returns details for each image, including picID, picName, and processing status indicators to show whether the image has been successfully processed or failed.

This API is rate-limited to 100 requests per minute per user.

API Request & Response Guidelines

🟢 200 OK

Batch Status Retrieved Successfully

{
  "status": true,
  "message": "",
  "data": [
    {
      "picID": 101,
      "picName": "image1.jpg",
      "isProcessed": true,
      "isFailed": false
    }
  ]
}

🟢 200 OK (Business Validation Errors)

Missing Batch ID
Returned when batchID is not provided.

{
  "status": false,
  "message": "batchID parameter is required",
  "data": []
}

Invalid Batch ID Format
Returned when batchID is sent as an array.

{
  "status": false,
  "message": "Only one batchID parameter is allowed",
  "data": []
}

Unauthorized Batch Access
This API returns HTTP 200 for business validation failures.

Returned when the specified batch does not belong to the authenticated account or it's relevant account.

{
  "status": false,
  "message": "Authentication Error: Batch Not Found",
  "data": []
}

No Images Found
Returned when the batch exists but has no images.

{
  "status": false,
  "message": "No Pics Found",
  "data": []
}

Processing Not Completed
QA/QC Under Process
Returned when images are still being processed.

{
  "status": false,
  "message": "QA/QC under process",
  "data": []
}

🟠 401 Unauthorized

Missing or Invalid Authorization

Returned when:

Authorization header is missing

API key is invalid

API key is not associated with a user

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

🟠 429 Too Many Requests

Returned when the request limit is exceeded.

Limit:

100 requests per minute per user/API key

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

🔴 500 Internal Server Error

Unexpected Server Error

Returned when an unexpected error occurs outside normal validation flow.

{
  "status": false,
  "message": "Service unavailable"
}

Generic format:

{
  "status": false,
  "message": "<error message>"
}

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.

Get Image Status

Description#

API Request & Response Guidelines#

🟢 200 OK#

Batch Status Retrieved Successfully#

🟢 200 OK (Business Validation Errors)#

🟠 401 Unauthorized#

Missing or Invalid Authorization#

🟠 429 Too Many Requests#

🔴 500 Internal Server Error#

Unexpected Server Error#

Important Note#

Request

Responses