Faceswap V2 Serverless API
Take a picture/gif and replace the face in it with a face of your choice. You only need one image of the desired face. No dataset, no training
POST /v2/faceswap-v2 · submit + poll 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3import segmind
4
5# Async (v2): submit to the queue and block until COMPLETED.
6# run() returns the final result dict (600s deadline, 1.0s poll by default).
7result = segmind.run(
8 "faceswap-v2",
9 source_img="https://segmind-sd-models.s3.us-east-1.amazonaws.com/elon.jpg",
10 target_img="https://segmind-sd-models.s3.amazonaws.com/display_images/faceswapv2_target.jpg",
11 input_faces_index="0",
12 source_faces_index="0",
13 face_restore="codeformer-v0.1.0.pth",
14 base64=False,
15)
16print(result["status"]) # COMPLETED
17print(result.get("output")) # model output (e.g. media URL)
18print(result["metrics"]["inference_time"]) # server compute seconds
19
20# --- Or submit + poll manually (track request_id, control the cadence) ---
21from segmind import SegmindClient, InferenceFailed, InferenceTimeout
22
23client = SegmindClient() # reads SEGMIND_API_KEY
24payload = {
25 "source_img": "https://segmind-sd-models.s3.us-east-1.amazonaws.com/elon.jpg",
26 "target_img": "https://segmind-sd-models.s3.amazonaws.com/display_images/faceswapv2_target.jpg",
27 "input_faces_index": "0",
28 "source_faces_index": "0",
29 "face_restore": "codeformer-v0.1.0.pth",
30 "base64": False,
31}
32job = client.submit_async("faceswap-v2", **payload)
33print(job.request_id) # available immediately
34try:
35 result = job.wait(timeout=600, interval=1.0)
36except InferenceTimeout as e:
37 print("still running:", e.request_id)
38except InferenceFailed as e:
39 print("failed:", e.detail) 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3import segmind
4
5# Async (v2): submit to the queue and block until COMPLETED.
6# run() returns the final result dict (600s deadline, 1.0s poll by default).
7result = segmind.run(
8 "faceswap-v2",
9 source_img="https://segmind-sd-models.s3.us-east-1.amazonaws.com/elon.jpg",
10 target_img="https://segmind-sd-models.s3.amazonaws.com/display_images/faceswapv2_target.jpg",
11 input_faces_index="0",
12 source_faces_index="0",
13 face_restore="codeformer-v0.1.0.pth",
14 base64=False,
15)
16print(result["status"]) # COMPLETED
17print(result.get("output")) # model output (e.g. media URL)
18print(result["metrics"]["inference_time"]) # server compute seconds
19
20# --- Or submit + poll manually (track request_id, control the cadence) ---
21from segmind import SegmindClient, InferenceFailed, InferenceTimeout
22
23client = SegmindClient() # reads SEGMIND_API_KEY
24payload = {
25 "source_img": "https://segmind-sd-models.s3.us-east-1.amazonaws.com/elon.jpg",
26 "target_img": "https://segmind-sd-models.s3.amazonaws.com/display_images/faceswapv2_target.jpg",
27 "input_faces_index": "0",
28 "source_faces_index": "0",
29 "face_restore": "codeformer-v0.1.0.pth",
30 "base64": False,
31}
32job = client.submit_async("faceswap-v2", **payload)
33print(job.request_id) # available immediately
34try:
35 result = job.wait(timeout=600, interval=1.0)
36except InferenceTimeout as e:
37 print("still running:", e.request_id)
38except InferenceFailed as e:
39 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/faceswap-v2Parameters
source_imgrequiredstring (uri)Your face goes here. A closeup shot would be ideal.(image url/base64)
target_imgrequiredstring (uri)The face you want to swap with.(image url/base64)
base64optionalbooleanBase64 encoding of the output image.
falseface_restoreoptionalstringwhich face restore model to use
"codeformer-v0.1.0.pth""codeformer-v0.1.0.pth""GFPGANv1.4.pth""GFPGANv1.3.pth"input_faces_indexoptionalstringIndex of the input faces: By default the model detects faces in images from 'large' to 'small'.Index of the first detected face is 0. Multiple faces can be selected using a comma (,)
"0"source_faces_indexoptionalstringIndex of the source faces: By default the model detects faces in images from 'large' to 'small'.Index of the first detected face is 0. Multiple faces can be selected using a comma (,)
"0"Response Type
Returns: Image
Asynchronous requests (v2)
Use Async for video, long-running (>~60s), or high-concurrency workloads; Sync is simplest for fast image & LLM calls. Async submits a request and you poll it to completion.
- 1
POST /v2/faceswap-v2Submit — returns request_id, status_url, response_url
- 2
GET /v2/requests/{id}/statusPoll — until COMPLETED or FAILED
- 3
GET /v2/requests/{id}Result — final response body
Status states
- A FAILED request is served as HTTP 422 — the body still carries the error detail.
- An unknown or expired request_id returns HTTP 404.
- Results are retained for 1 hour, then expire.
- Content / RAI blocks surface as FAILED, not a separate state.
- Track completion by polling the status endpoint.
Common Error Codes
The API returns standard HTTP status codes. Detailed error messages are provided in the response body.
Bad Request
Invalid parameters or request format
Unauthorized
Missing or invalid API key
Forbidden
Insufficient permissions
Not Found
Model or endpoint not found
Insufficient Credits
Not enough credits to process request
Rate Limited
Too many requests
Server Error
Internal server error
Bad Gateway
Service temporarily unavailable
Timeout
Request timed out