AI Face Swap (image and video) Serverless API
AI Face Swap: Effortlessly replace faces online. Fine-tune swaps with advanced controls for age, gender, and resolution.
POST /v2/ai-face-swap · 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_image": "https://segmind-resources.s3.amazonaws.com/input/8d67068b-dc76-4069-b231-acdbb644ab54-ai-video-swap-ip2.png",
11 "target": "https://segmind-resources.s3.amazonaws.com/input/1f234efe-9867-475f-8ef2-81eef026fb50-7eb8f231-ace8-4dbe-bb6a-43ae13d1a89e.mp4",
12 "pixel_boost": "384x384",
13 "face_selector_mode": "reference",
14 "face_selector_order": "large-small",
15 "face_selector_age_start": 0,
16 "face_selector_age_end": 100,
17 "reference_face_distance": 0.6,
18 "reference_frame_number": 1,
19 "base64": False,
20}
21job = client.submit_async("ai-face-swap", **payload)
22print(job.request_id) # available immediately
23try:
24 result = job.wait(timeout=900, interval=2.0)
25 print(result["status"]) # COMPLETED
26 print(result.get("output")) # model output (e.g. video URL)
27except InferenceTimeout as e:
28 print("still running:", e.request_id) # re-poll later with this id
29except InferenceFailed as e:
30 print("failed:", e.detail)
31
32# Fast models (<=600s) can use the one-liner instead:
33# result = segmind.run("ai-face-swap", **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_image": "https://segmind-resources.s3.amazonaws.com/input/8d67068b-dc76-4069-b231-acdbb644ab54-ai-video-swap-ip2.png",
11 "target": "https://segmind-resources.s3.amazonaws.com/input/1f234efe-9867-475f-8ef2-81eef026fb50-7eb8f231-ace8-4dbe-bb6a-43ae13d1a89e.mp4",
12 "pixel_boost": "384x384",
13 "face_selector_mode": "reference",
14 "face_selector_order": "large-small",
15 "face_selector_age_start": 0,
16 "face_selector_age_end": 100,
17 "reference_face_distance": 0.6,
18 "reference_frame_number": 1,
19 "base64": False,
20}
21job = client.submit_async("ai-face-swap", **payload)
22print(job.request_id) # available immediately
23try:
24 result = job.wait(timeout=900, interval=2.0)
25 print(result["status"]) # COMPLETED
26 print(result.get("output")) # model output (e.g. video URL)
27except InferenceTimeout as e:
28 print("still running:", e.request_id) # re-poll later with this id
29except InferenceFailed as e:
30 print("failed:", e.detail)
31
32# Fast models (<=600s) can use the one-liner instead:
33# result = segmind.run("ai-face-swap", **payload)API Endpoint
https://api.segmind.com/v1/ai-face-swapParameters
source_imagerequiredstring (uri)Source face image URL for face swap
targetrequiredstring (uri)Target Video URL for face swap
"https://segmind-resources.s3.amazonaws.com/input/1f234efe-9867-475f-8ef2-81eef026fb50-7eb8f231-ace8-4dbe-bb6a-43ae13d1a89e.mp4"base64optionalbooleanBase64 encoding of the output
falseface_selector_age_endoptionalintegerMaximum age for face selection
100Range: 0 - 100face_selector_age_startoptionalintegerMinimum age for face selection
0Range: 0 - 100face_selector_genderoptionalstringGender filter for face selection
null"female""male""none"face_selector_modeoptionalstringSelection strategy for multiple faces
"reference""many""one""reference"face_selector_orderoptionalstringOrder priority for face selection
"large-small""left-right""right-left""top-bottom""bottom-top""small-large""large-small""best-worst""worst-best"face_selector_raceoptionalstringRace filter for face selection
null"white""black""asian""indian""middle eastern""latino hispanic""none"pixel_boostoptionalstringUpscale resolution for enhanced quality
"384x384""128x128""256x256""384x384""512x512""768x768""1024x1024"reference_face_distanceoptionalnumberMaximum distance for reference face matching
0.6Range: 0 - 1reference_frame_numberoptionalintegerSpecify the frame used to create the reference face
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/ai-face-swapSubmit — 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