Face Swap API
Put a new face on a photo: send the picture to edit and a portrait of the face to use, everything else stays.
/v1/generateworkflow: face_swap-v1One endpoint serves every workflow — this page documents face_swap-v1, the current version. Credits are debited at submission (1 cr standard, 1 cr pro); a failed generation is refunded automatically. Earlier versions of this endpoint, if any, keep being served under their own names.
| Parameter | Value for this workflow |
|---|---|
| workflow | "face_swap-v1" required |
| input_image | Your photo — one public HTTPS URL.required |
| swap_image | The face to use — one public HTTPS URL.required |
| ratio | auto |
| tier | "standard" (1 cr) or "pro" (1 cr) |
| webhook_url | Optional — we POST the outcome here when the generation settles. Without it, poll the URL returned in the response until the status settles. |
Example request
curl -X POST https://thenewblack.ai/api/v1/generate \
-H "Authorization: Bearer tnb_live_XXXXXXXXXXXX" \
-H "Content-Type: application/json" \
-d '{
"workflow": "face_swap-v1",
"input_image": "https://example.com/image.jpg",
"swap_image": "https://example.com/image.jpg",
"ratio": "auto",
"tier": "standard"
}'// 202 Accepted
{
"generation_id": "3f1c9a6e-...",
"status": "running",
"poll": "/api/v1/generations/3f1c9a6e-..."
}Example response
Poll /v1/generations/{id} (or receive the webhook) until the generation settles:
// 200 OK
{
"generation_id": "3f1c9a6e-...",
"workflow": "face_swap",
"status": "succeeded",
"result": {
"type": "image",
"url": "https://.../result.webp",
"thumbnail": "https://.../thumb.webp"
}
}Results are stored for 48 hours — copy them to your own storage. Authentication, errors and webhooks are documented in the full API reference.
Frequently asked questions
What are the two images?
First the photo to edit — the outfit, the pose, the scene are kept — then a clear portrait of the face to put on it.
What is it for?
Reusing a campaign image with a different model, or keeping one face across a lookbook shot in several sessions.
How much does it cost?
1 credit on the standard tier, 1 on pro. Credits come with plans and packs; a failed generation is always refunded.
Other endpoints: Virtual Try-On API · AI Fashion Models API · Fashion Design API · Reimagine Model API · Swap Model API · AI Stylist API · all endpoints