POST
Generate Retouch Data
Creates a retouch analysis job from an input image. Use the returned ID to retrieve retouch output.
Note
This endpoint creates a retouch prediction job. The response returns a Prediction ID (
_id) and a poll URL. Use the poll endpoint to fetch final results.Parameters
appIdstring
ID of the Skin Analysis app configuration created via POST Create App. Determines algorithm/settings used for retouch processing.
Request body
input.imagestring
Face image file used to generate retouch data. Upload as multipart/form-data (JPG/PNG); use a clear, front-facing, well-lit image for best results.
Response Body
inputobject
Echo of the request input that was accepted for processing.
statusstring
Current state of the prediction job (e.g., ACCEPTED, PROCESSING, SUCCESS, FAILED). Poll the result endpoint until completion.
urlsobject
URLs related to this prediction job (primarily for polling results).
orgIdinteger
Organization identifier under which the prediction job was created.
retentionstring
Data retention duration for this prediction job and its outputs.
createdAtstring
Timestamp for when the prediction job was created.
_idstring
Prediction ID for this job. Use it to retrieve the retouch result (directly or via the poll endpoint).
POST/sa-predictions/apps/{appId}/plugins/retouchInt/generate
curl -X POST "https://api.pixelbin.io/service/platform/misc/v1.0/sa-predictions/apps/{appId}/plugins/retouchInt/generate" \
-H "Authorization: Bearer {apitoken}" \
-F "input.image=@<path/to/file>"
Response
201
No example available.