Background Replace

This model is capable of generating photo-realistic images given any text input, with the extra capability of inpainting the pictures by using a mask

~8.95s

~$0.01

PlaygroundAPIPricing

~8.95s

~$0.01

 1import requests
 2import json
 3
 4url = "https://api.segmind.com/v1/bg-replace"
 5headers = {
 6    "x-api-key": "YOUR_API_KEY",
 7    "Content-Type": "application/json"
 8}
 9
10data = {
11    "image": "https://segmind-sd-models.s3.amazonaws.com/outputs/bg_replace_input.jpg",
12    "ref_image": "https://segmind-sd-models.s3.amazonaws.com/outputs/bg_input_reference.jpg",
13    "prompt": "Pefume bottle placed on top of a rock, in a jungle",
14    "negative_prompt": "bad quality, painting, blur",
15    "samples": 1,
16    "scheduler": "DDIM",
17    "num_inference_steps": 25,
18    "guidance_scale": 7.5,
19    "seed": 12467,
20    "strength": 1,
21    "cn_weight": 0.9,
22    "ip_adapter_weight": 0.5,
23    "base64": false
24}
25
26response = requests.post(url, headers=headers, json=data)
27
28if response.status_code == 200:
29    result = response.json()
30    print(json.dumps(result, indent=2))
31else:
32    print(f"Error: {response.status_code}")
33    print(response.text)

 1import requests
 2import json
 3
 4url = "https://api.segmind.com/v1/bg-replace"
 5headers = {
 6    "x-api-key": "YOUR_API_KEY",
 7    "Content-Type": "application/json"
 8}
 9
10data = {
11    "image": "https://segmind-sd-models.s3.amazonaws.com/outputs/bg_replace_input.jpg",
12    "ref_image": "https://segmind-sd-models.s3.amazonaws.com/outputs/bg_input_reference.jpg",
13    "prompt": "Pefume bottle placed on top of a rock, in a jungle",
14    "negative_prompt": "bad quality, painting, blur",
15    "samples": 1,
16    "scheduler": "DDIM",
17    "num_inference_steps": 25,
18    "guidance_scale": 7.5,
19    "seed": 12467,
20    "strength": 1,
21    "cn_weight": 0.9,
22    "ip_adapter_weight": 0.5,
23    "base64": false
24}
25
26response = requests.post(url, headers=headers, json=data)
27
28if response.status_code == 200:
29    result = response.json()
30    print(json.dumps(result, indent=2))
31else:
32    print(f"Error: {response.status_code}")
33    print(response.text)

API Endpoint

POSThttps://api.segmind.com/v1/bg-replace

Parameters

imagerequired

string (uri)

Input Image.

promptrequired

string

Prompt to render

ref_imagerequired

string (uri)

Reference Image

base64optional

boolean

Base64 encoding of the output image.

Default: false

cn_weightoptional

number

Scale for classifier-free guidance

Default: 0.9Range: 0 - 1

guidance_scaleoptional

number

Scale for classifier-free guidance

Default: 7.5Range: 1 - 25

ip_adapter_weightoptional

number

Scale for classifier-free guidance

Default: 0.5Range: 0 - 1

negative_promptoptional

string

Prompts to exclude, eg. 'bad anatomy, bad hands, missing fingers'

num_inference_stepsoptional

integer

Number of denoising steps.

Default: 25Range: 20 - 100

samplesoptional

integer

Number of samples to generate.

Default: 1Range: 1 - 4

scheduleroptional

string

Type of scheduler.

Default: "DPM2 Karras"

Allowed values (12 total):

"DDIM""DPM Multi""DPM Single""Euler a""Euler""Heun""DPM2 a Karras""DPM2 Karras""LMS""PNDM"+2 more

seedoptional

integer

Seed for image generation.

Default: -1Range: -1 - 999999999999999

strengthoptional

number

Scale for classifier-free guidance

Default: 1Range: 0 - 1

Response Type

Returns: Media File

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