Supir Photo-Realistic Image Restoration Serverless API

SUPIR restores and enhances images to stunning, photo-realistic quality with advanced AI techniques.

~0.00s
~$5
PlaygroundAPI
Pricing
 1import requests
 2import json
 3
 4url = "https://api.segmind.com/v1/supir"
 5headers = {
 6    "x-api-key": "YOUR_API_KEY",
 7    "Content-Type": "application/json"
 8}
 9
10data = {
11    "image": "https://segmind-resources.s3.amazonaws.com/input/557ae4e3-8057-4668-bf41-ff836d0f73b0-test_upscale_1234142.jpg",
12    "s_cfg": 7.5,
13    "s_churn": 5,
14    "s_noise": 1.003,
15    "upscale": 1,
16    "a_prompt": "Cinematic, High Contrast, ultra HD, hyper detailed.",
17    "min_size": 1024,
18    "n_prompt": "worst quality, low quality, frames, watermark.",
19    "s_stage1": -1,
20    "s_stage2": 1,
21    "edm_steps": 50,
22    "use_llava": true,
23    "linear_CFG": false,
24    "model_name": "SUPIR-v0Q",
25    "color_fix_type": "Wavelet",
26    "spt_linear_CFG": 1,
27    "linear_s_stage2": false,
28    "spt_linear_s_stage2": 0
29}
30
31response = requests.post(url, headers=headers, json=data)
32
33if response.status_code == 200:
34    result = response.json()
35    print(json.dumps(result, indent=2))
36else:
37    print(f"Error: {response.status_code}")
38    print(response.text)

API Endpoint

POSThttps://api.segmind.com/v1/supir

Parameters

imagerequired
string (uri)

Input a low-quality image for enhancement. Provide a direct image URL for best results.

Default: "https://segmind-resources.s3.amazonaws.com/input/557ae4e3-8057-4668-bf41-ff836d0f73b0-test_upscale_1234142.jpg"
a_promptoptional
string

Positive prompt to enhance image detail. Suggested: 'Cinematic, High Contrast, ultra HD, detailed.'

Default: "Cinematic, High Contrast, ultra HD, hyper detailed."
color_fix_typeoptional
string

Select color fix: None, AdaIn, or Wavelet. Default is Wavelet for optimal balance.

Default: "Wavelet"
Allowed values :
"None""AdaIn""Wavelet"
edm_stepsoptional
integer

Determines number of EDM sampling steps. Default is 50; adjust for finer control.

Default: 50Range: 1 - 500
linear_CFGoptional
boolean

Increases CFG linearly with sigma. Default is false; use for advanced control.

Default: false
linear_s_stage2optional
boolean

Increases s_stage2 linearly with sigma. Default is false; enable for gradual adjustment.

Default: false
min_sizeoptional
number

Sets minimum output image resolution. Default is 1024; increase for larger outputs.

Default: 1024
model_nameoptional
string

Choose between models: SUPIR-v0Q and SUPIR-v0F. Default is SUPIR-v0Q.

Default: "SUPIR-v0Q"
Allowed values :
"SUPIR-v0Q""SUPIR-v0F"
n_promptoptional
string

Negative prompt to avoid artifacts. Use 'worst quality, low quality' for better outcomes.

Default: "worst quality, low quality, frames, watermark."
s_cfgoptional
number

Adjusts guidance scale for prompts. Default is 7.5; increase for strong guidance, reduce for subtler effects.

Default: 7.5Range: 1 - 20
s_churnoptional
number

Original churn hyperparameter of EDM. Default is 5; modify to experiment with stabilization effects.

Default: 5
s_noiseoptional
number

Regulates noise level within EDM. Start at 1.003; adjust for noise reduction or amplification.

Default: 1.003
s_stage1optional
integer

Sets Stage1 control strength. Default is -1; use positive for activation.

Default: -1
s_stage2optional
number

Sets Stage2 control strength. Default is 1; adjust for different intensities.

Default: 1
seedoptional
integer

Sets the random seed for reproducibility. Use any integer for consistent results or leave blank to randomize.

Default: null
spt_linear_CFGoptional
number

Start point for increasing CFG linearly. Default is 1; adjust as required.

Default: 1
spt_linear_s_stage2optional
number

Start point for linear increase of s_stage2. Default is 0; increase for gradual transition.

Default: 0
upscaleoptional
integer

Controls upsampling ratio. Use default 1 for no change or increase for higher resolution.

Default: 1
use_llavaoptional
boolean

Utilizes LLaVA model for captions. Default is true; enable as needed.

Default: true

Response Type

Returns: Image

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