POST
Generate Skin Analysis
Submits a facial image for skin analysis and returns a Prediction ID to retrieve results. Use GET Skin Analysis Result to poll for completion using the returned scanId and predictionId (_id).
Tip
scanId and predictionId are generated by this endpoint. Use the returned scanId and _id (Prediction ID) when calling the Skin Analysis Result, Retouch Result, or Generate Scan PDF APIs.Parameters
appIdstring
The Skin Analysis App identifier that tells the API which app configuration (SDK/algo/report settings) to use for this analysis request.
Request body
input.imagestring
Face image to analyze. Upload as multipart/form-data (JPG/PNG). Use a clear, front-facing, well-lit image for best results.
Response Body
inputobject
Echo of the submitted input metadata for this job.
statusstring
Current job state for this request (example: ACCEPTED, then later transitions when you poll results).
urlsobject
URLs for polling the result of this prediction.
orgIdinteger
Organization identifier under which the job was created.
retentionstring
How long the job data/results are retained.
createdAtstring
Timestamp when this prediction job was created (ISO 8601).
_idstring
Prediction ID, the unique identifier for this processing job. Use this to poll/fetch the final analysis output.
subjectIdstring
Identifier for the “subject” (the person/session entity) associated with the analysis job.
scanIdstring
Identifier for the scan created under this subject; used to group/poll analysis artifacts tied to the same scan.
POST/sa-predictions/apps/{appId}/plugins/skinAnalysisInt/generate
curl -X POST "https://api.pixelbin.io/service/private/misc/v2.0/sa-predictions/apps/{appId}/plugins/skinAnalysisInt/generate" \
-H "Authorization: Bearer {accesskey}" \
-F "input.image=@<path/to/file>"
Response
201
No example available.