Download Processed Images

Description

This API retrieves processed images based on the selected processType. The response structure and overall status behavior differ between AI processing mode and Collaboration (QA/QC) mode.

Processing Behavior

1. Collaboration Mode (`processType = "collab"`)

The overall batch status remains false while QA/QC is in progress.

Once the batch is fully reviewed and delivered, the status is updated to true.

In this mode, the batch-level status reflects human review completion, not per-image AI processing.

2. AI Mode (`processType = "ai"`)

The overall batch status is always true.

Each image is evaluated independently.

Image-Level States

State	Meaning
`"isProcessed": true`	🟢 Image successfully processed by AI
`"isProcessed": false, "isFailed": false`	🟡 Image is currently in progress
`"isProcessed": false, "isFailed": true`	🔴 Image processing failed
`"isProcessed": false, "isFailed": true, "picStatus":"VALIDATION_FAILED", "errorMessage": "File Not Allowed, Replace [image] with valid image file"`	⚠️ Image failed request validation before processing

Possible `picStatus` Values

`PENDING`

{
  "picID": null,
  "picName": "733909149.jpg",
  "s3Url": null,
  "isProcessed": false,
  "isFailed": false,
  "picStatus": "PENDING",
  "errorMessage": null
}

`UPLOADING`

{
  "picID": null,
  "picName": "733909149.jpg",
  "s3Url": null,
  "isProcessed": false,
  "isFailed": false,
  "picStatus": "UPLOADING",
  "errorMessage": null
}

`VALIDATED`

{
  "picID": null,
  "picName": "1716686825.jpg",
  "s3Url": null,
  "isProcessed": false,
  "isFailed": false,
  "picStatus": "VALIDATED",
  "errorMessage": null
}

`COMPLETED`

{
  "picID": 82,
  "picName": "1716686825.jpg",
  "s3Url": "https://example-bucket.s3.amazonaws.com/images/1716686825.jpg",
  "isProcessed": true,
  "isFailed": false
}

`FAILED`

{
  "picID": null,
  "picName": "1716686825.jpg",
  "s3Url": null,
  "isProcessed": false,
  "isFailed": true,
  "picStatus": "FAILED",
  "errorMessage": "AI processing failed."
}

`VALIDATION_FAILED`

{
  "picID": null,
  "picName": "1716686825.jpg",
  "s3Url": null,
  "isProcessed": false,
  "isFailed": true,
  "picStatus": "VALIDATION_FAILED",
  "errorMessage": "Image validation failed."
}

`UPLOAD_FAILED`

{
  "picID": null,
  "picName": "1716686825.jpg",
  "s3Url": null,
  "isProcessed": false,
  "isFailed": true,
  "picStatus": "UPLOAD_FAILED",
  "errorMessage": "Failed to upload image to storage."
}

Status Summary

`picStatus`	`isProcessed`	`isFailed`	Description
`PENDING`	`false`	`false`	Image is queued for processing.
`UPLOADING`	`false`	`false`	Image is currently being uploaded.
`VALIDATED`	`false`	`false`	Image validation completed successfully and is awaiting processing.
`COMPLETED`	`true`	`false`	Image processed successfully.
`FAILED`	`false`	`true`	Image processing failed.
`VALIDATION_FAILED`	`false`	`true`	Image validation failed.
`UPLOAD_FAILED`	`false`	`true`	Image upload failed.

Failure Handling (AI Mode)

Processing failures and validation failures are returned at the individual image level. A single batch may contain a mix of successfully processed images, images still in progress, processing failures, and validation failures.

Processing Failure

Returned when AI processing fails after the image has been accepted.

{
  "picID": 102,
  "picName": "image2.jpg",
  "s3Url": null,
  "isProcessed": false,
  "isFailed": true
}

Validation Failure

Returned when an uploaded file cannot be accepted for processing (for example, an unsupported file type or invalid image).

Additional fields are included:

Field	Description
`picStatus`	Machine-readable validation status
`errorMessage`	Human-readable validation error

Example:

{
  "picID": null,
  "picName": "image",
  "s3Url": null,
  "isProcessed": false,
  "isFailed": true,
  "picStatus": "VALIDATION_FAILED",
  "errorMessage": "File Not Allowed, Replace [image] with valid image file"
}

Validation failures do not cause the overall API request to fail and are reported alongside successfully processed images in the same response.
Validation failures and AI processing failures do not result in credit deduction.

Summary

Collab mode → Batch-level status depends on QA/QC completion.

AI mode → Batch status is always true; image-level fields determine the status of each image.

A single response may contain:

Successfully processed images

Images still in progress

AI processing failures

Validation failures

Validation failures include picStatus and errorMessage for the affected image.

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",
      "s3Url": "https://cdn-url.com/image.jpg",
      "isProcessed": true,
      "isFailed": false
    }
  ]
}

🟢 200 OK (Partial Success with Validation Errors)

Returned when one or more images are successfully processed while others fail validation.

{
  "status": true,
  "message": "",
  "data": [
    {
      "picID": 82,
      "picName": "Foto01.09.25_131703.jpg",
      "s3Url": "https://s3.ap-south-1.amazonaws.com/autobgv1.1/processed/userId/10000287021/Foto01.09.25_131703.jpg",
      "isProcessed": true,
      "isFailed": false
    },
    {
      "picID": 83,
      "picName": "Foto01.09.25_131640_2.jpg",
      "s3Url": "https://s3.ap-south-1.amazonaws.com/autobgv1.1/processed/userId/10000287021/Foto01.09.25_131640_2.jpg",
      "isProcessed": true,
      "isFailed": false
    },
    {
      "picID": null,
      "picName": "image",
      "s3Url": null,
      "isProcessed": false,
      "isFailed": true,
      "picStatus": "VALIDATION_FAILED",
      "errorMessage": "File Not Allowed, Replace [image] with valid image file"
    }
  ]
}

The API returns HTTP 200 OK with "status": true because the batch request itself was processed successfully. Individual image validation failures are reported per image using picStatus and errorMessage.

🟢 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 its 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.

HTTP 200 OK with "status": true may still contain per-image validation or processing failures.

Always inspect the overall status field as well as each image's isProcessed, isFailed, picStatus, and errorMessage fields to determine the final outcome for every image.

Download Processed Images

Description#

Processing Behavior#

1. Collaboration Mode (processType = "collab")#

2. AI Mode (processType = "ai")#

Image-Level States#

Possible picStatus Values#

PENDING#

UPLOADING#

VALIDATED#

COMPLETED#

FAILED#

VALIDATION_FAILED#

UPLOAD_FAILED#

Status Summary#

Failure Handling (AI Mode)#

Processing Failure#

Validation Failure#

Summary#

API Request & Response Guidelines#

🟢 200 OK#

Batch Status Retrieved Successfully#

🟢 200 OK (Partial Success with Validation Errors)#

🟢 200 OK (Business Validation Errors)#

Missing Batch ID#

Invalid Batch ID Format#

Unauthorized Batch Access#

No Images Found#

Processing Not Completed#

🟠 401 Unauthorized#

Missing or Invalid Authorization#

🟠 429 Too Many Requests#

🔴 500 Internal Server Error#

Unexpected Server Error#

Important Note#

Request

Responses