Skip to main content
POST
Preprocess Trinity Face Image

Authorizations

x-simli-api-key
string
header
required

Query Parameters

gsVersion
enum<string>
default:GSA_1.0

The avatar generation the image is for. Pass the same one to POST /faces/trinity. Checks that the account has a face slot (GSA_1.0) or a Trinity-2 generation (GSA_2.0) left, as that call does. The avatar generation: GSA_1.0 makes a Trinity-1 face, GSA_2.0 a Trinity-2 face.

Available options:
GSA_1.0,
GSA_2.0
retry
boolean
default:false

Render at higher quality. Substantially slower - roughly 160 seconds against 25 - so use it to re-run an image whose first result was unsatisfactory rather than as the default.

Body

multipart/form-data
image
file
required

JPEG, PNG or WEBP, under 5MB, at least 512x512. It must contain a person facing the camera whose head is at least 15% of the image height - a head smaller than that carries too few pixels to keep the likeness, and is rejected. Where several people are present, the largest camera-facing head is treated as the subject.

Response

The reframed image. Pass TARGET-RATIO back to POST /faces/trinity as the target-ratio header, along with this image, to generate from it.

The response is of type file.