face-to-many Serverless API

Turn a face into 3D, emoji, pixel art, video game, claymation or toy

POST /v2/face-to-many · 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-to-many",
 9    image="https://segmind-sd-models.s3.amazonaws.com/display_images/Ftm_ip.png.jpg",
10    prompt="a person",
11    style="3D",
12)
13print(result["status"])                      # COMPLETED
14print(result.get("output"))                  # model output (e.g. media URL)
15print(result["metrics"]["inference_time"])   # server compute seconds
16
17# --- Or submit + poll manually (track request_id, control the cadence) ---
18from segmind import SegmindClient, InferenceFailed, InferenceTimeout
19
20client = SegmindClient()                      # reads SEGMIND_API_KEY
21payload = {
22    "image": "https://segmind-sd-models.s3.amazonaws.com/display_images/Ftm_ip.png.jpg",
23    "prompt": "a person",
24    "style": "3D",
25}
26job = client.submit_async("face-to-many", **payload)
27print(job.request_id)                         # available immediately
28try:
29    result = job.wait(timeout=600, interval=1.0)
30except InferenceTimeout as e:
31    print("still running:", e.request_id)
32except InferenceFailed as e:
33    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/face-to-many

Parameters

control_depth_strengthoptional
number

Strength of the depth ControlNet. Higher values increase its influence on the output.

Default: 0.8Range: 0 - 1
custom_lora_urloptional
string

URL to a Replicate custom LoRA (https://replicate.delivery/pbxt/[id]/trained_model.tar).

Default: ""
denoising_strengthoptional
number

How much of the original image to keep. 1 fully replaces the original, 0 keeps it unchanged.

Default: 0.65Range: 0 - 1
imageoptional
string (uri)

An image of a person to convert.

Default: "https://segmind-sd-models.s3.amazonaws.com/display_images/Ftm_ip.png.jpg"
instant_id_strengthoptional
number

How strongly facial identity is preserved.

Default: 1Range: 0 - 1
lora_scaleoptional
number

How strongly the LoRA is applied.

Default: 1Range: 0 - 1
negative_promptoptional
string

Things to avoid in the generated image.

Default: ""
promptoptional
string

Describe the desired output.

Default: "a person"
prompt_strengthoptional
number

CFG scale. Higher values follow the prompt more strongly; lower values keep more likeness to the original image.

Default: 4.5Range: 0 - 20
seedoptional
integer

Seed for reproducible results. -1 randomizes on every request.

Default: -1Range: -1 - 999999999999999
styleoptional
string

The style to convert the image into.

Default: "3D"
Allowed values :
"3D""Emoji""Video game""Pixels""Clay""Toy"

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-to-many

    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