Skip to main content
Version: V2

Face swap

POST 
/v2/artworks/face-swap

Swap a face from a source image onto a target image. The source face is mapped onto the matching face in the target while keeping the target's lighting and pose.

Request​

Body

required

    sourceImage urirequired

    URL of the source image containing the face to swap from.

    targetImage urirequired

    URL of the target image containing the face to be replaced.

    denoising integer

    Possible values: >= 1 and <= 5

    Default value: 3

    Denoising strength level from 1 (very subtle) to 5 (extreme). Controls blending intensity.

    seed integer

    Possible values: >= 1 and <= 2147483647

    Optional random seed for deterministic generation. The Tengrai pipeline applies a deterministic transform (floor(seed * 1.2) + 17) before submitting to the workflow engine. Range: 1-2147483647. Omit to let the server pick a random seed.

    webhook uri

    Optional webhook URL. When provided, the server will POST the final artwork result to this URL upon completion. Must be HTTPS and a publicly routable host — loopback, link-local, private, and cloud-metadata addresses are rejected.

    outputFormat string

    Possible values: [auto, png, webp]

    Default value: auto

    Output image format. auto (the default) uses the server default (webp with high-quality settings); png is lossless; webp is equivalent to auto.

Responses​

Response indicating that the artwork was successfully created.

Schema

    id uuidrequired
    artworkType stringrequired

    Possible values: [face_swap]

    parameters

    object

    required

    sourceImage uri

    URL of the source image containing the face to swap from.

    targetImage uri

    URL of the target image containing the face to be replaced.

    denoising integer

    Possible values: >= 1 and <= 5

    Default value: 3

    Denoising strength level from 1 (very subtle) to 5 (extreme). Controls blending intensity.

    seed integer

    Possible values: >= 1 and <= 2147483647

    Optional random seed for deterministic generation. The Tengrai pipeline applies a deterministic transform (floor(seed * 1.2) + 17) before submitting to the workflow engine. Range: 1-2147483647. Omit to let the server pick a random seed.

    webhook uri

    Optional webhook URL. When provided, the server will POST the final artwork result to this URL upon completion. Must be HTTPS and a publicly routable host — loopback, link-local, private, and cloud-metadata addresses are rejected.

    outputFormat string

    Possible values: [auto, png, webp]

    Default value: auto

    Output image format. auto (the default) uses the server default (webp with high-quality settings); png is lossless; webp is equivalent to auto.

    duration numberrequired
    results string[]required
    status stringrequired

    Possible values: [starting, processing, succeeded, failed, canceled]

    createdAt date-timerequired
Loading...