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

~184.81s
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)

API Endpoint

POSThttps://api.segmind.com/v1/videofaceswap

Parameters

frame_load_caprequired
integer

Total frames to process, Set '0' to process Full video

Default: 0Range: 0 - 500
input_faces_indexrequired
string

Index of the input faces: the leftmost face index is 0. Multiple faces can be selected using a comma (,)

Default: "0"
source_faces_indexrequired
string

Index of the source faces: the leftmost face index is 0. Multiple faces can be selected using a comma (,)

Default: "0"
source_imgrequired
string (uri)

Your face goes here. A closeup shot would be ideal.

Default: "https://segmind-sd-models.s3.amazonaws.com/display_images/videoFaceSwap/faceswap-image.jpg"
video_inputrequired
string (uri)

The face you want to swap with. Can be a gif too.

Default: "https://segmind-sd-models.s3.amazonaws.com/display_images/videoFaceSwap/faceswap-input.mp4"
base_64optional
boolean

Base64 encoding of the output

Default: false
codeformer_weightoptional
number

Weight of codeformer

Default: 0.95Range: 0 - 1
detect_gender_inputoptional
string

Detect gender from input

Default: "no"
Allowed values :
"no""male""female"
detect_gender_sourceoptional
string

Detect gender from source

Default: "no"
Allowed values :
"no""male""female"
face_restoreoptional
boolean

Enable face restoration

Default: true
face_restore_visibilityoptional
number

Visibility of face restoration

Default: 1Range: 0.1 - 1

Response 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. 1
    POST /v2/videofaceswap

    Submitreturns request_id, status_url, response_url

  2. 2
    GET /v2/requests/{id}/status

    Polluntil COMPLETED or FAILED

  3. 3
    GET /v2/requests/{id}

    Resultfinal response body

Status states

QUEUEDAccepted, waiting for a worker
PROCESSINGRunning on a worker
COMPLETEDDone — result body is ready
FAILEDErrored (incl. content/RAI blocks)
  • 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.

400

Bad Request

Invalid parameters or request format

401

Unauthorized

Missing or invalid API key

403

Forbidden

Insufficient permissions

404

Not Found

Model or endpoint not found

406

Insufficient Credits

Not enough credits to process request

429

Rate Limited

Too many requests

500

Server Error

Internal server error

502

Bad Gateway

Service temporarily unavailable

504

Timeout

Request timed out