GET
Retouch Analysis Result
Retrieves the current status and retouch output for a previously submitted retouch job.
Note
Use the
scanId and predictionId returned by POST Generate Retouch Data. Poll this endpoint until status updates.Parameters
appIdstring
ID of the Skin Analysis app configuration used to generate the retouch job.
scanIdstring
Identifier of the scan instance associated with the retouch job. Used to fetch results for a specific scan.
predictionIdstring
Prediction/job identifier returned by Generate Retouch Data (_id). Used to track processing status and output.
Output Errors
This API can return HTTP 200 with
status: "SUCCESS" even if something fails, in these cases output contains an error key with error message and status_code: 422.| Error message | Status code | Notes |
|---|---|---|
| No face detected | 422 | No face detected in the provided image. Ensure the image contains a clear, visible face. |
| Failed to read Image | 422 | The image file could not be read or processed. Check if the file is valid and accessible. |
| File size exceeds 5MB limit. | 422 | Image file exceeds the maximum allowed size limit. Compress or resize the image before uploading. |
| Unable to open image. Invalid or corrupted file. | 422 | The image file is corrupted or in an invalid format. Try re-saving or re-exporting the image. |
| Unsupported image format. Only PNG, JPG, or JPEG is allowed. | 422 | The image format is not supported. Convert the image to PNG, JPG, or JPEG format. |
| Image dimensions are too small. Min required resolution 1024x1024 pixels. | 422 | Image resolution is below the minimum requirement. Use an image with higher resolution. |
| Image resolution too large. Max allowed resolution 2048x2048 pixels. | 422 | Image resolution exceeds the maximum allowed limit. Resize the image to a smaller resolution. |
GET/sa-predictions/apps/{appId}/plugins/retouchInt/scans/{scanId}/{predictionId}
curl -X GET "https://api.pixelbin.io/service/platform/misc/v1.0/sa-predictions/apps/{appId}/plugins/retouchInt/scans/{scanId}/{predictionId}" \
-H "Authorization: Bearer {apitoken}"
Response
201
No example available.