Video Faceswap Serverless API
Video Faceswap is a powerful tool for creators, filmmakers, and meme enthusiasts. With this innovative technology, you can effortlessly replace faces in videos
POST /v2/videofaceswap · submit + poll 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3from segmind import SegmindClient, InferenceFailed, InferenceTimeout
4
5# Async (v2) — recommended for long-running / video models.
6# run() blocks up to 600s; submit_async + job.wait(timeout=...) sets a longer
7# deadline and keeps the request_id so you can re-poll later.
8client = SegmindClient() # reads SEGMIND_API_KEY
9payload = {
10 "source_img": "https://segmind-sd-models.s3.amazonaws.com/display_images/videoFaceSwap/faceswap-image.jpg",
11 "video_input": "https://segmind-sd-models.s3.amazonaws.com/display_images/videoFaceSwap/faceswap-input.mp4",
12 "face_restore": True,
13 "input_faces_index": "0",
14 "source_faces_index": "0",
15 "face_restore_visibility": 1,
16 "codeformer_weight": 0.95,
17 "detect_gender_input": "no",
18 "detect_gender_source": "no",
19 "frame_load_cap": 0,
20 "base_64": False,
21}
22job = client.submit_async("videofaceswap", **payload)
23print(job.request_id) # available immediately
24try:
25 result = job.wait(timeout=900, interval=2.0)
26 print(result["status"]) # COMPLETED
27 print(result.get("output")) # model output (e.g. video URL)
28except InferenceTimeout as e:
29 print("still running:", e.request_id) # re-poll later with this id
30except InferenceFailed as e:
31 print("failed:", e.detail)
32
33# Fast models (<=600s) can use the one-liner instead:
34# result = segmind.run("videofaceswap", **payload) 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3from segmind import SegmindClient, InferenceFailed, InferenceTimeout
4
5# Async (v2) — recommended for long-running / video models.
6# run() blocks up to 600s; submit_async + job.wait(timeout=...) sets a longer
7# deadline and keeps the request_id so you can re-poll later.
8client = SegmindClient() # reads SEGMIND_API_KEY
9payload = {
10 "source_img": "https://segmind-sd-models.s3.amazonaws.com/display_images/videoFaceSwap/faceswap-image.jpg",
11 "video_input": "https://segmind-sd-models.s3.amazonaws.com/display_images/videoFaceSwap/faceswap-input.mp4",
12 "face_restore": True,
13 "input_faces_index": "0",
14 "source_faces_index": "0",
15 "face_restore_visibility": 1,
16 "codeformer_weight": 0.95,
17 "detect_gender_input": "no",
18 "detect_gender_source": "no",
19 "frame_load_cap": 0,
20 "base_64": False,
21}
22job = client.submit_async("videofaceswap", **payload)
23print(job.request_id) # available immediately
24try:
25 result = job.wait(timeout=900, interval=2.0)
26 print(result["status"]) # COMPLETED
27 print(result.get("output")) # model output (e.g. video URL)
28except InferenceTimeout as e:
29 print("still running:", e.request_id) # re-poll later with this id
30except InferenceFailed as e:
31 print("failed:", e.detail)
32
33# Fast models (<=600s) can use the one-liner instead:
34# result = segmind.run("videofaceswap", **payload)API Endpoint
https://api.segmind.com/v1/videofaceswapParameters
frame_load_caprequiredintegerTotal frames to process, Set '0' to process Full video
0Range: 0 - 500input_faces_indexrequiredstringIndex of the input faces: the leftmost face index is 0. Multiple faces can be selected using a comma (,)
"0"source_faces_indexrequiredstringIndex of the source faces: the leftmost face index is 0. Multiple faces can be selected using a comma (,)
"0"source_imgrequiredstring (uri)Your face goes here. A closeup shot would be ideal.
"https://segmind-sd-models.s3.amazonaws.com/display_images/videoFaceSwap/faceswap-image.jpg"video_inputrequiredstring (uri)The face you want to swap with. Can be a gif too.
"https://segmind-sd-models.s3.amazonaws.com/display_images/videoFaceSwap/faceswap-input.mp4"base_64optionalbooleanBase64 encoding of the output
falsecodeformer_weightoptionalnumberWeight of codeformer
0.95Range: 0 - 1detect_gender_inputoptionalstringDetect gender from input
"no""no""male""female"detect_gender_sourceoptionalstringDetect gender from source
"no""no""male""female"face_restoreoptionalbooleanEnable face restoration
trueface_restore_visibilityoptionalnumberVisibility of face restoration
1Range: 0.1 - 1Response Type
Returns: Video
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/videofaceswapSubmit — 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