Face Swap
POST/v2/studio/artworks/face-swap
Start a face-swap generation. Billed to your Studio credits. The result arrives by webhook or polling.
Request
- application/json
Body
required
URL of the source image containing the face to swap from.
URL of the target image containing the face to be replaced.
Possible values: >= 1 and <= 5
Default value: 3
Denoising strength level from 1 (very subtle) to 5 (extreme). Controls blending intensity.
Possible values: >= 1 and <= 2147483647
Optional random seed for deterministic generation. Range: 1-2147483647.
Possible values: [auto, png, webp]
Default value: auto
Output image format. auto lets the provider pick. Supported: auto, png, webp.
Optional HTTPS callback URL. Receives a signed delivery when the artwork finalizes.
Responses
- 202
- 400
- 401
- 402
- 403
- 429
Accepted — generation queued.
- application/json
- Schema
- Example (from schema)
Schema
Artwork id. Poll GET /studio/artworks/{id} or await the webhook.
{
"id": "string"
}
Invalid parameters.
Missing, invalid, or expired API key.
Insufficient credit.
Studio access inactive.
Rate limited.