Fooocus Serverless API
Fooocus enables high-quality image generation effortlessly, combining the best of Stable Diffusion and Midjourney.
POST /v2/fooocus · 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 "fooocus",
9 prompt="cinematic 3D caricature of a woman, smiling, looking happy",
10 negative_prompt="lowquality, badquality, sketches",
11 steps=30,
12 samples=1,
13 styles="V2,Enhance,Sharp",
14 aspect_ratio="1024*1024",
15 seed=1849415,
16 guidance_scale=4,
17 scheduler="DPM++ 2M SDE Karras",
18 base_model="protovisionxl",
19 faceswap_img="https://segmind-sd-models.s3.amazonaws.com/display_images/fooocus-face-image.jpg",
20 faceswap_cn_stop=0.9,
21 faceswap_cn_weight=0.8,
22 imageprompt_img="https://segmind-sd-models.s3.amazonaws.com/display_images/fooocus-image-prompt.png",
23 imageprompt_cn_stop=0.5,
24 imageprompt_cn_weight=0.6,
25 pyracanny_cn_stop=0.5,
26 pyracanny_cn_weight=1,
27 cpds_cn_stop=0.5,
28 cpds_cn_weight=1,
29 base64=False,
30)
31print(result["status"]) # COMPLETED
32print(result.get("output")) # model output (e.g. media URL)
33print(result["metrics"]["inference_time"]) # server compute seconds
34
35# --- Or submit + poll manually (track request_id, control the cadence) ---
36from segmind import SegmindClient, InferenceFailed, InferenceTimeout
37
38client = SegmindClient() # reads SEGMIND_API_KEY
39payload = {
40 "prompt": "cinematic 3D caricature of a woman, smiling, looking happy",
41 "negative_prompt": "lowquality, badquality, sketches",
42 "steps": 30,
43 "samples": 1,
44 "styles": "V2,Enhance,Sharp",
45 "aspect_ratio": "1024*1024",
46 "seed": 1849415,
47 "guidance_scale": 4,
48 "scheduler": "DPM++ 2M SDE Karras",
49 "base_model": "protovisionxl",
50 "faceswap_img": "https://segmind-sd-models.s3.amazonaws.com/display_images/fooocus-face-image.jpg",
51 "faceswap_cn_stop": 0.9,
52 "faceswap_cn_weight": 0.8,
53 "imageprompt_img": "https://segmind-sd-models.s3.amazonaws.com/display_images/fooocus-image-prompt.png",
54 "imageprompt_cn_stop": 0.5,
55 "imageprompt_cn_weight": 0.6,
56 "pyracanny_cn_stop": 0.5,
57 "pyracanny_cn_weight": 1,
58 "cpds_cn_stop": 0.5,
59 "cpds_cn_weight": 1,
60 "base64": False,
61}
62job = client.submit_async("fooocus", **payload)
63print(job.request_id) # available immediately
64try:
65 result = job.wait(timeout=600, interval=1.0)
66except InferenceTimeout as e:
67 print("still running:", e.request_id)
68except InferenceFailed as e:
69 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 "fooocus",
9 prompt="cinematic 3D caricature of a woman, smiling, looking happy",
10 negative_prompt="lowquality, badquality, sketches",
11 steps=30,
12 samples=1,
13 styles="V2,Enhance,Sharp",
14 aspect_ratio="1024*1024",
15 seed=1849415,
16 guidance_scale=4,
17 scheduler="DPM++ 2M SDE Karras",
18 base_model="protovisionxl",
19 faceswap_img="https://segmind-sd-models.s3.amazonaws.com/display_images/fooocus-face-image.jpg",
20 faceswap_cn_stop=0.9,
21 faceswap_cn_weight=0.8,
22 imageprompt_img="https://segmind-sd-models.s3.amazonaws.com/display_images/fooocus-image-prompt.png",
23 imageprompt_cn_stop=0.5,
24 imageprompt_cn_weight=0.6,
25 pyracanny_cn_stop=0.5,
26 pyracanny_cn_weight=1,
27 cpds_cn_stop=0.5,
28 cpds_cn_weight=1,
29 base64=False,
30)
31print(result["status"]) # COMPLETED
32print(result.get("output")) # model output (e.g. media URL)
33print(result["metrics"]["inference_time"]) # server compute seconds
34
35# --- Or submit + poll manually (track request_id, control the cadence) ---
36from segmind import SegmindClient, InferenceFailed, InferenceTimeout
37
38client = SegmindClient() # reads SEGMIND_API_KEY
39payload = {
40 "prompt": "cinematic 3D caricature of a woman, smiling, looking happy",
41 "negative_prompt": "lowquality, badquality, sketches",
42 "steps": 30,
43 "samples": 1,
44 "styles": "V2,Enhance,Sharp",
45 "aspect_ratio": "1024*1024",
46 "seed": 1849415,
47 "guidance_scale": 4,
48 "scheduler": "DPM++ 2M SDE Karras",
49 "base_model": "protovisionxl",
50 "faceswap_img": "https://segmind-sd-models.s3.amazonaws.com/display_images/fooocus-face-image.jpg",
51 "faceswap_cn_stop": 0.9,
52 "faceswap_cn_weight": 0.8,
53 "imageprompt_img": "https://segmind-sd-models.s3.amazonaws.com/display_images/fooocus-image-prompt.png",
54 "imageprompt_cn_stop": 0.5,
55 "imageprompt_cn_weight": 0.6,
56 "pyracanny_cn_stop": 0.5,
57 "pyracanny_cn_weight": 1,
58 "cpds_cn_stop": 0.5,
59 "cpds_cn_weight": 1,
60 "base64": False,
61}
62job = client.submit_async("fooocus", **payload)
63print(job.request_id) # available immediately
64try:
65 result = job.wait(timeout=600, interval=1.0)
66except InferenceTimeout as e:
67 print("still running:", e.request_id)
68except InferenceFailed as e:
69 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/fooocusParameters
promptrequiredstringPrompt to render
aspect_ratiooptionalstringoutput image aspect ratio
"1024*1024""704*1408""704*1344""768*1344""768*1280""832*1216""832*1152""896*1152""896*1088""960*1088""768*1024"+18 morebase_modeloptionalstringModel for inference
"juggernaut_v8""juggernaut_v8""Unstable_diffusers_v11""protovisionxl""realism_engine_v3""realVisXL""fluentlyXL"base64optionalbooleanBase64 encoding of the output image.
falsecpds_cn_stopoptionalnumberimage propmt
0.5Range: 0 - 1.5cpds_cn_weightoptionalnumberimage propmt
1Range: 0 - 1.5cpds_imgoptionalstring (uri)cpds_img
faceswap_cn_stopoptionalnumberimage propmt
0.9Range: 0 - 1.5faceswap_cn_weightoptionalnumberimage propmt
0.8Range: 0 - 1.5faceswap_imgoptionalstring (uri)faceswap_img
guidance_scaleoptionalnumberScale for classifier-free guidance
4Range: 1 - 25imageprompt_cn_stopoptionalnumberimage prompt
0.5Range: 0 - 1.5imageprompt_cn_weightoptionalnumberimage propmt
0.6Range: 0 - 1.5imageprompt_imgoptionalstring (uri)faceswap_img
negative_promptoptionalstringPrompts to exclude, eg. bad anatomy, bad hands, missing fingers
pyracanny_cn_stopoptionalnumberimage propmt
0.5Range: 0 - 1.5pyracanny_cn_weightoptionalnumberimage propmt
1Range: 0 - 1.5pyracanny_imgoptionalstring (uri)pyracanny_img
samplesoptionalintegerNumber images to generate.
1Range: 1 - 4scheduleroptionalstringType of scheduler.
"DPM++ SDE""DPM++ SDE Karras""DPM++ 2M Karras""DPM++ 2M SDE Karras""DPM++ 2M SDE Heun Karras""DPM++ 3M SDE Karras""LMS Karras""DPM2 Karras""DPM2 a Karras""DPM++ 2S a Karras""DPM++ 2M SDE Exponential"+19 moreseedoptionalintegerSeed for image generation.
-1Range: -1 - 999999999999999stepsoptionalintegerNumber of denoising steps.
30Range: 20 - 100stylesoptionalstringStyle selection
"V2,Enhance,Sharp"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
POST /v2/fooocusSubmit — 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