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.

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

API Endpoint

POSThttps://api.segmind.com/v1/face-detailer

Parameters

denoiserequired
number

Denoising strength to apply during generation

Default: 0.5Range: 0 - 1
imagerequired
string (uri)

Input image

Default: "https://segmind-sd-models.s3.amazonaws.com/display_images/face-detailer-test-ip.png"
promptrequired
string

The positive prompt describing the image

Default: "clear face and natural skin"
base64optional
boolean

Base64 encoding of the output image.

Default: false
guidance_scaleoptional
number

Guidance scale for generating the image

Default: 6Range: 5 - 10
image_formatoptional
string

Format of the output image

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

Quality of the output image

Default: 95Range: 10 - 100
negative_promptoptional
string

Negative prompt to avoid undesired features in the image

Default: "bad quality, painting, blur"
num_inference_stepsoptional
integer

Number of inference steps for image generation

Default: 20Range: 15 - 75
samplesoptional
integer

Number of image samples to generate

Default: 1Range: 1 - 4
seedoptional
integer

Random seed for image generation

Default: 12467

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/face-detailer

    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