material-transfer Serverless API
Transfer a material from an image to a subject
POST /v2/material-transfer · 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 "material-transfer",
9 steps=6,
10 prompt="marble sculpture",
11 max_width=1920,
12 max_height=1920,
13 output_format="webp",
14 subject_image="https://segmind-sd-models.s3.amazonaws.com/display_images/bird.png",
15 guidance_scale=2,
16 material_image="https://segmind-sd-models.s3.amazonaws.com/display_images/ruby.png",
17 output_quality=80,
18 material_strength="medium",
19 return_intermediate_images=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 "steps": 6,
31 "prompt": "marble sculpture",
32 "max_width": 1920,
33 "max_height": 1920,
34 "output_format": "webp",
35 "subject_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/bird.png",
36 "guidance_scale": 2,
37 "material_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/ruby.png",
38 "output_quality": 80,
39 "material_strength": "medium",
40 "return_intermediate_images": False,
41}
42job = client.submit_async("material-transfer", **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 "material-transfer",
9 steps=6,
10 prompt="marble sculpture",
11 max_width=1920,
12 max_height=1920,
13 output_format="webp",
14 subject_image="https://segmind-sd-models.s3.amazonaws.com/display_images/bird.png",
15 guidance_scale=2,
16 material_image="https://segmind-sd-models.s3.amazonaws.com/display_images/ruby.png",
17 output_quality=80,
18 material_strength="medium",
19 return_intermediate_images=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 "steps": 6,
31 "prompt": "marble sculpture",
32 "max_width": 1920,
33 "max_height": 1920,
34 "output_format": "webp",
35 "subject_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/bird.png",
36 "guidance_scale": 2,
37 "material_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/ruby.png",
38 "output_quality": 80,
39 "material_strength": "medium",
40 "return_intermediate_images": False,
41}
42job = client.submit_async("material-transfer", **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/material-transferParameters
material_imagerequiredstring (uri)Material to transfer to the input image
"https://segmind-sd-models.s3.amazonaws.com/display_images/ruby.png"subject_imagerequiredstring (uri)Subject image to transfer the material to
"https://segmind-sd-models.s3.amazonaws.com/display_images/bird.png"guidance_scaleoptionalnumberGuidance scale for the diffusion process
2Range: 1 - 10material_strengthoptionalstringAn enumeration.
"medium""medium""strong"max_heightoptionalintegerMax height of the output image
1920max_widthoptionalintegerMax width of the output image
1920negative_promptoptionalstringWhat you do not want to see in the image
""output_formatoptionalstringAn enumeration.
"webp""webp""jpg""png"output_qualityoptionalintegerQuality of the output images, from 0 to 100. 100 is best quality, 0 is lowest quality.
80Range: 0 - 100promptoptionalstringUse a prompt that describe the image when the material is applied
"marble sculpture"return_intermediate_imagesoptionalbooleanReturn intermediate images like mask, and annotated images. Useful for debugging.
falseseedoptionalintegerSet a seed for reproducibility. Random by default.
nullstepsoptionalintegerNumber of steps. 6 steps gives good results, but try increasing to 15 or 20 if you need more detail
6Response 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/material-transferSubmit — 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