Profile Photo Style Transfer Serverless API

Turn any image of a face into artwork using Stable Diffusion Controlnet and IPAdapter

~63.76s
POST /v2/become-image · 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    "become-image",
 9    image="https://segmind-inference-io.s3.us-east-1.amazonaws.com/sample_images/image_71.webp",
10    prompt="a person",
11    image_to_become="https://segmind-inference-io.s3.amazonaws.com/sample_images/40548cb9-ae1f-4caa-969d-382c913a74ef.webp",
12    prompt_strength=2,
13    number_of_images=2,
14    denoising_strength=1,
15    instant_id_strength=1,
16    image_to_become_noise=0.3,
17    control_depth_strength=0.8,
18    disable_safety_checker=True,
19    image_to_become_strength=0.75,
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-inference-io.s3.us-east-1.amazonaws.com/sample_images/image_71.webp",
31    "prompt": "a person",
32    "image_to_become": "https://segmind-inference-io.s3.amazonaws.com/sample_images/40548cb9-ae1f-4caa-969d-382c913a74ef.webp",
33    "prompt_strength": 2,
34    "number_of_images": 2,
35    "denoising_strength": 1,
36    "instant_id_strength": 1,
37    "image_to_become_noise": 0.3,
38    "control_depth_strength": 0.8,
39    "disable_safety_checker": True,
40    "image_to_become_strength": 0.75,
41}
42job = client.submit_async("become-image", **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/become-image

Parameters

control_depth_strengthoptional
number

Strength of depth controlnet. The bigger this is, the more controlnet affects the output.

Default: 0.8Range: 0 - 1
denoising_strengthoptional
number

How much of the original image of the person to keep. 1 is the complete destruction of the original image, 0 is the original image

Default: 1Range: 0 - 1
disable_safety_checkeroptional
boolean

Disable safety checker for generated images

Default: true
imageoptional
string (uri)

An image of a person to be converted

Default: "https://segmind-inference-io.s3.us-east-1.amazonaws.com/sample_images/image_71.webp"
image_to_becomeoptional
string (uri)

Any image to convert the person to

Default: "https://segmind-inference-io.s3.amazonaws.com/sample_images/40548cb9-ae1f-4caa-969d-382c913a74ef.webp"
image_to_become_noiseoptional
number

How much noise to add to the style image before processing. An alternative way of controlling stength.

Default: 0.3Range: 0 - 1
image_to_become_strengthoptional
number

How strong the style will be applied

Default: 0.75Range: 0 - 1
instant_id_strengthoptional
number

How strong the InstantID will be.

Default: 1Range: 0 - 1
negative_promptoptional
string

Things you do not want in the image

Default: ""
number_of_imagesoptional
integer

Number of images to generate

Default: 2Range: 1 - 10
promptoptional
string
Default: "a person"
prompt_strengthoptional
number

Strength of the prompt. This is the CFG scale, higher numbers lead to stronger prompt, lower numbers will keep more of a likeness to the original.

Default: 2Range: 0 - 3
seedoptional
integer

Fix the random seed for reproducibility

Default: null

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/become-image

    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