Skip to main content
POST
Generate Trinity Face

Authorizations

x-simli-api-key
string
header
required

Headers

target-ratio
number<float>

The TARGET-RATIO header returned by POST /faces/trinity/preprocess, passed back together with the image that call returned. Its presence means the image is already framed, so it is used as-is. Omit it when posting an image that has not been through preprocess: the image is then framed here first, which adds roughly 25 seconds, and the ratio is measured rather than taken from you. Preprocess with the same gsVersion as this call: the two frame the image differently.

Query Parameters

gsVersion
enum<string>
default:GSA_1.0

The avatar generation to make. GSA_1.0 (the default) makes a Trinity-1 face and takes one of your plan's face slots. GSA_2.0 makes a Trinity-2 face and runs on your Trinity-2 generations: one is used when the face is built (a failed build uses none), and each generation still queued or building holds one meanwhile. One account's GSA_2.0 generations start at least 10 minutes apart; a request inside that window is accepted at once and held in the queue, and the response's dispatch_after says until when. 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
face_name
string
default:untitled_avatar

Body

multipart/form-data
image
file
required

Response

Successful Response

message
string
required

The generation's place in the queue, and how long it is held, if it is.

face_id
string
required

The new face's ID. Poll GET /faces/trinity/generation_status with it.

warnings
string[]
required
dispatch_after
integer

GSA_2.0 only, when the generation is held by the 10 minutes between one account's GSA_2.0 generations: the Unix time (seconds) it may start. Absent otherwise.