Faceswap 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

~36.73s
PlaygroundAPI
Pricing
POST /v2/sd2.1-faceswapper · 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    "sd2.1-faceswapper",
 9    input_face_image="https://www.segmind.com/elon.jpg",
10    target_face_image="https://www.segmind.com/burn.gif",
11    file_type="gif",
12    face_restore=True,
13)
14print(result["status"])                      # COMPLETED
15print(result.get("output"))                  # model output (e.g. media URL)
16print(result["metrics"]["inference_time"])   # server compute seconds
17
18# --- Or submit + poll manually (track request_id, control the cadence) ---
19from segmind import SegmindClient, InferenceFailed, InferenceTimeout
20
21client = SegmindClient()                      # reads SEGMIND_API_KEY
22payload = {
23    "input_face_image": "https://www.segmind.com/elon.jpg",
24    "target_face_image": "https://www.segmind.com/burn.gif",
25    "file_type": "gif",
26    "face_restore": True,
27}
28job = client.submit_async("sd2.1-faceswapper", **payload)
29print(job.request_id)                         # available immediately
30try:
31    result = job.wait(timeout=600, interval=1.0)
32except InferenceTimeout as e:
33    print("still running:", e.request_id)
34except InferenceFailed as e:
35    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/sd2.1-faceswapper

Parameters

input_face_imagerequired
string (uri)

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

target_face_imagerequired
string (uri)

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

face_restoreoptional
boolean

Run result frames through codeformer face restoration

Default: true
file_typeoptional
string

File type of the face you want to swap with.

Default: "png"

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. 1
    POST /v2/sd2.1-faceswapper

    Submit — returns request_id, status_url, response_url

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

    Poll — until COMPLETED or FAILED

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

    Result — final response body

Status states

QUEUED— Accepted, waiting for a worker
PROCESSING— Running on a worker
COMPLETED— Done — result body is ready
FAILED— Errored (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