Segmind Faceswap v4 Serverless API

Segmind FaceSwap v4 enables fast and precise face or head swapping between images with customizable options for style, output format, and image quality. Designed for creators and designers, it ensures natural-looking results with reproducibility through seed control for consistent outputs.

~32.91s
PlaygroundAPI
Pricing
POST /v2/faceswap-v4 · 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-v4",
 9    source_image="https://segmind-resources.s3.amazonaws.com/input/b872c581-a20a-4fda-98aa-b78d2e221ccb-v4-source-img.jpg",
10    target_image="https://segmind-resources.s3.amazonaws.com/output/7401f2ea-5652-4f2a-93d9-a587f1ccb62f-fs-v4-target.png",
11    model_type="speed",
12    swap_type="head",
13    style_type="normal",
14    seed=4208875,
15    image_format="png",
16    image_quality=90,
17    hardware="fast",
18    base64=False,
19)
20print(result["status"])                      # COMPLETED
21print(result.get("output"))                  # model output (e.g. media URL)
22print(result["metrics"]["inference_time"])   # server compute seconds
23
24# --- Or submit + poll manually (track request_id, control the cadence) ---
25from segmind import SegmindClient, InferenceFailed, InferenceTimeout
26
27client = SegmindClient()                      # reads SEGMIND_API_KEY
28payload = {
29    "source_image": "https://segmind-resources.s3.amazonaws.com/input/b872c581-a20a-4fda-98aa-b78d2e221ccb-v4-source-img.jpg",
30    "target_image": "https://segmind-resources.s3.amazonaws.com/output/7401f2ea-5652-4f2a-93d9-a587f1ccb62f-fs-v4-target.png",
31    "model_type": "speed",
32    "swap_type": "head",
33    "style_type": "normal",
34    "seed": 4208875,
35    "image_format": "png",
36    "image_quality": 90,
37    "hardware": "fast",
38    "base64": False,
39}
40job = client.submit_async("faceswap-v4", **payload)
41print(job.request_id)                         # available immediately
42try:
43    result = job.wait(timeout=600, interval=1.0)
44except InferenceTimeout as e:
45    print("still running:", e.request_id)
46except InferenceFailed as e:
47    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/faceswap-v4

Parameters

source_imagerequired
string (uri)

The image URL of the source image

target_imagerequired
string (uri)

The image on which the face swap will be applied, url

base64optional
boolean

Output as base64

Default: false
hardwareoptional
string

The hardware to use. Does not affect quality, only latency and cost

Default: "fast"
Allowed values :
"fast""cost"
image_formatoptional
string

The output image format

Default: "png"
Allowed values :
"jpeg""png""webp"
image_qualityoptional
integer

The quality of the output image

Default: 90Range: 10 - 100
model_typeoptional
string

The inference steps to use for face swapping. Speed = 8 steps, quality = 30 steps

Default: "speed"
Allowed values :
"speed""quality"
seedoptional
integer

Random seed for reproducibility

Default: 42
style_typeoptional
string

The style to apply during face swapping. normal: source style, style: match style of target image

Default: "normal"
Allowed values :
"normal""style"
swap_typeoptional
string

Determines whether to swap the entire head or just the face

Default: "head"
Allowed values :
"head""face"

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/faceswap-v4

    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