Flux Depth Dev Serverless API
Open-weight depth-aware image generation. Edit images while preserving spatial relationships.
POST /v2/flux-depth-dev · 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 "flux-depth-dev",
9 seed=85412,
10 prompt="spiderman lecture, photorealistic",
11 guidance=10,
12 megapixels="1",
13 num_outputs=1,
14 control_image="https://segmind-sd-models.s3.us-east-1.amazonaws.com/display_images/flux-tools/flux-dev-depth-ip-1.png",
15 output_format="jpg",
16 output_quality=80,
17 num_inference_steps=28,
18 disable_safety_checker=False,
19)
20print(result["status"]) # COMPLETED
21print(result.get("output")) # model output (e.g. media URL)
22print(result["metrics"]["inference_time"]) # server compute seconds
23
24# --- Or submit + poll manually (track request_id, control the cadence) ---
25from segmind import SegmindClient, InferenceFailed, InferenceTimeout
26
27client = SegmindClient() # reads SEGMIND_API_KEY
28payload = {
29 "seed": 85412,
30 "prompt": "spiderman lecture, photorealistic",
31 "guidance": 10,
32 "megapixels": "1",
33 "num_outputs": 1,
34 "control_image": "https://segmind-sd-models.s3.us-east-1.amazonaws.com/display_images/flux-tools/flux-dev-depth-ip-1.png",
35 "output_format": "jpg",
36 "output_quality": 80,
37 "num_inference_steps": 28,
38 "disable_safety_checker": False,
39}
40job = client.submit_async("flux-depth-dev", **payload)
41print(job.request_id) # available immediately
42try:
43 result = job.wait(timeout=600, interval=1.0)
44except InferenceTimeout as e:
45 print("still running:", e.request_id)
46except InferenceFailed as e:
47 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 "flux-depth-dev",
9 seed=85412,
10 prompt="spiderman lecture, photorealistic",
11 guidance=10,
12 megapixels="1",
13 num_outputs=1,
14 control_image="https://segmind-sd-models.s3.us-east-1.amazonaws.com/display_images/flux-tools/flux-dev-depth-ip-1.png",
15 output_format="jpg",
16 output_quality=80,
17 num_inference_steps=28,
18 disable_safety_checker=False,
19)
20print(result["status"]) # COMPLETED
21print(result.get("output")) # model output (e.g. media URL)
22print(result["metrics"]["inference_time"]) # server compute seconds
23
24# --- Or submit + poll manually (track request_id, control the cadence) ---
25from segmind import SegmindClient, InferenceFailed, InferenceTimeout
26
27client = SegmindClient() # reads SEGMIND_API_KEY
28payload = {
29 "seed": 85412,
30 "prompt": "spiderman lecture, photorealistic",
31 "guidance": 10,
32 "megapixels": "1",
33 "num_outputs": 1,
34 "control_image": "https://segmind-sd-models.s3.us-east-1.amazonaws.com/display_images/flux-tools/flux-dev-depth-ip-1.png",
35 "output_format": "jpg",
36 "output_quality": 80,
37 "num_inference_steps": 28,
38 "disable_safety_checker": False,
39}
40job = client.submit_async("flux-depth-dev", **payload)
41print(job.request_id) # available immediately
42try:
43 result = job.wait(timeout=600, interval=1.0)
44except InferenceTimeout as e:
45 print("still running:", e.request_id)
46except InferenceFailed as e:
47 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/flux-depth-devParameters
control_imagerequiredstring (uri)Image used to control the generation. The depth map will be automatically generated.
"https://segmind-sd-models.s3.us-east-1.amazonaws.com/display_images/flux-tools/flux-dev-depth-ip-1.png"promptrequiredstringPrompt for generated image
"spiderman lecture, photorealistic"disable_safety_checkeroptionalbooleanDisable safety checker for generated images.
falseguidanceoptionalnumberGuidance for generated image
10Range: 0 - 100megapixelsoptionalstringApproximate number of megapixels for generated image. Use match_input to match the size of the input (with an upper limit of 1440x1440 pixels)
"1""1""0.25""match_input"num_inference_stepsoptionalintegerNumber of denoising steps. Recommended range is 28-50, and lower number of steps produce lower quality outputs, faster.
28Range: 1 - 50num_outputsoptionalintegerNumber of outputs to generate
1Range: 1 - 4output_formatoptionalstringFormat of the output images.
"jpg""webp""jpg""png"output_qualityoptionalintegerQuality when saving the output images, from 0 to 100. 100 is best quality, 0 is lowest quality. Not relevant for .png outputs
80Range: 0 - 100seedoptionalintegerRandom seed. Set for reproducible generation
85412Response 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/flux-depth-devSubmit — 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