POST

Generate Retouch Data

Creates a retouch analysis prediction job using the provided appId. The response returns a Prediction ID (_id) used to poll the final retouch result.

Note

This endpoint does not return final retouch output immediately. It returns a Prediction ID (_id) and polling URL. Use GET Retouch Result to retrieve the final output.

Parameters

appIdstring

ID of the Skin Analysis app configuration used to process this retouch request.

Request body

input.imagestring

Facial image used to generate retouch analysis data. Upload as multipart/form-data.

Response Body

inputobject

Echo of the accepted input metadata.

statusstring

Current job state (e.g., ACCEPTED, PROCESSING, SUCCESS, FAILED).

urlsobject

Links associated with this prediction job.

orgIdinteger

Organization identifier under which this prediction job was created.

retentionstring

Duration for which retouch data and results are retained.

createdAtstring

Timestamp when the prediction job was created.

_idstring

Prediction ID, unique identifier for this retouch job. Required for polling results.

Tip

The _id field is the Prediction ID. You must pass this value as predictionId when polling the retouch result endpoint.

POST/sa-predictions/apps/{appId}/plugins/retouchInt/generate

cURLJavaScriptKotlinSwiftJavaPythonDart

curl -X POST "https://api.pixelbin.io/service/private/misc/v2.0/sa-predictions/apps/{appId}/plugins/retouchInt/generate" \
  -H "Authorization: Bearer {accesskey}" \
  -F "input.image=@<path/to/file>"

Response

201

No example available.