Profile Photo Style Transfer Serverless API
Turn any image of a face into artwork using Stable Diffusion Controlnet and IPAdapter
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) 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
https://api.segmind.com/v1/become-imageParameters
control_depth_strengthoptionalnumberStrength of depth controlnet. The bigger this is, the more controlnet affects the output.
0.8Range: 0 - 1denoising_strengthoptionalnumberHow much of the original image of the person to keep. 1 is the complete destruction of the original image, 0 is the original image
1Range: 0 - 1disable_safety_checkeroptionalbooleanDisable safety checker for generated images
trueimageoptionalstring (uri)An image of a person to be converted
"https://segmind-inference-io.s3.us-east-1.amazonaws.com/sample_images/image_71.webp"image_to_becomeoptionalstring (uri)Any image to convert the person to
"https://segmind-inference-io.s3.amazonaws.com/sample_images/40548cb9-ae1f-4caa-969d-382c913a74ef.webp"image_to_become_noiseoptionalnumberHow much noise to add to the style image before processing. An alternative way of controlling stength.
0.3Range: 0 - 1image_to_become_strengthoptionalnumberHow strong the style will be applied
0.75Range: 0 - 1instant_id_strengthoptionalnumberHow strong the InstantID will be.
1Range: 0 - 1negative_promptoptionalstringThings you do not want in the image
""number_of_imagesoptionalintegerNumber of images to generate
2Range: 1 - 10promptoptionalstring"a person"prompt_strengthoptionalnumberStrength 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.
2Range: 0 - 3seedoptionalintegerFix the random seed for reproducibility
nullResponse 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/become-imageSubmit — 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