Face Detailer Serverless API
Restore characters' faces to their original glory with Face Detailer. Enhance facial details, eliminate distortion, and upscale images for stunning results.
POST /v2/face-detailer · 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 "face-detailer",
9 image="https://segmind-sd-models.s3.amazonaws.com/display_images/face-detailer-test-ip.png",
10 prompt="clear face and natural skin",
11 negative_prompt="bad quality, painting, blur",
12 samples=1,
13 num_inference_steps=25,
14 guidance_scale=5,
15 seed=12467,
16 denoise=0.4,
17 image_format="jpeg",
18 image_quality=95,
19 base64=False,
20)
21print(result["status"]) # COMPLETED
22print(result.get("output")) # model output (e.g. media URL)
23print(result["metrics"]["inference_time"]) # server compute seconds
24
25# --- Or submit + poll manually (track request_id, control the cadence) ---
26from segmind import SegmindClient, InferenceFailed, InferenceTimeout
27
28client = SegmindClient() # reads SEGMIND_API_KEY
29payload = {
30 "image": "https://segmind-sd-models.s3.amazonaws.com/display_images/face-detailer-test-ip.png",
31 "prompt": "clear face and natural skin",
32 "negative_prompt": "bad quality, painting, blur",
33 "samples": 1,
34 "num_inference_steps": 25,
35 "guidance_scale": 5,
36 "seed": 12467,
37 "denoise": 0.4,
38 "image_format": "jpeg",
39 "image_quality": 95,
40 "base64": False,
41}
42job = client.submit_async("face-detailer", **payload)
43print(job.request_id) # available immediately
44try:
45 result = job.wait(timeout=600, interval=1.0)
46except InferenceTimeout as e:
47 print("still running:", e.request_id)
48except InferenceFailed as e:
49 print("failed:", e.detail) 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 "face-detailer",
9 image="https://segmind-sd-models.s3.amazonaws.com/display_images/face-detailer-test-ip.png",
10 prompt="clear face and natural skin",
11 negative_prompt="bad quality, painting, blur",
12 samples=1,
13 num_inference_steps=25,
14 guidance_scale=5,
15 seed=12467,
16 denoise=0.4,
17 image_format="jpeg",
18 image_quality=95,
19 base64=False,
20)
21print(result["status"]) # COMPLETED
22print(result.get("output")) # model output (e.g. media URL)
23print(result["metrics"]["inference_time"]) # server compute seconds
24
25# --- Or submit + poll manually (track request_id, control the cadence) ---
26from segmind import SegmindClient, InferenceFailed, InferenceTimeout
27
28client = SegmindClient() # reads SEGMIND_API_KEY
29payload = {
30 "image": "https://segmind-sd-models.s3.amazonaws.com/display_images/face-detailer-test-ip.png",
31 "prompt": "clear face and natural skin",
32 "negative_prompt": "bad quality, painting, blur",
33 "samples": 1,
34 "num_inference_steps": 25,
35 "guidance_scale": 5,
36 "seed": 12467,
37 "denoise": 0.4,
38 "image_format": "jpeg",
39 "image_quality": 95,
40 "base64": False,
41}
42job = client.submit_async("face-detailer", **payload)
43print(job.request_id) # available immediately
44try:
45 result = job.wait(timeout=600, interval=1.0)
46except InferenceTimeout as e:
47 print("still running:", e.request_id)
48except InferenceFailed as e:
49 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/face-detailerParameters
denoiserequirednumberDenoising strength to apply during generation
0.5Range: 0 - 1imagerequiredstring (uri)Input image
"https://segmind-sd-models.s3.amazonaws.com/display_images/face-detailer-test-ip.png"promptrequiredstringThe positive prompt describing the image
"clear face and natural skin"base64optionalbooleanBase64 encoding of the output image.
falseguidance_scaleoptionalnumberGuidance scale for generating the image
6Range: 5 - 10image_formatoptionalstringFormat of the output image
"jpeg""jpeg""png""webp"image_qualityoptionalintegerQuality of the output image
95Range: 10 - 100negative_promptoptionalstringNegative prompt to avoid undesired features in the image
"bad quality, painting, blur"num_inference_stepsoptionalintegerNumber of inference steps for image generation
20Range: 15 - 75samplesoptionalintegerNumber of image samples to generate
1Range: 1 - 4seedoptionalintegerRandom seed for image generation
12467Response 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
POST /v2/face-detailerSubmit — 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