Skip to main content

Enterprise Flux: Image to Image Endpoint

Overview

The Image2Image API generates an image from an image. Pass the appropriate request parameters to the endpoint to generate image from an image.

This endpoint generates and returns an image from an image passed with its URL in the request.

caution

Make sure you add your s3 details for flux server, so you can receive image generated in your bucket. Images generated without s3 details being added will be delete after 24hours

Request

--request POST 'https://modelslab.com/api/v1/enterprise/flux/img2img' \

Make a POST request to https://modelslab.com/api/v1/enterprise/flux/img2img endpoint and pass the required parameters as a request body to the endpoint.

Body Attributes

ParameterDescription
keyYour API Key used for request authorization
promptText prompt with description of the things you want in the image to be generated
negative_promptItems you don't want in the image
init_imageLink to the Initial Image
widthMax Height: Width: 1024x1024
heightMax Height: Width: 1024x1024
samplesNumber of images to be returned in response. The maximum value is 4.
safety_checkerA checker for NSFW images. If such an image is detected, it will be replaced by a blank image.
base64Get response as base64 string, default: false, options: true or false
strengthPrompt strength when using init image. 1.0 corresponds to full destruction of information in the init image.
instant_responsequeue response instantly before processing finishes instead of waiting a minimum amount of time default: false, options: true or false
seedSeed is used to reproduce results, same seed will give you same image in return again. Pass null for a random number.
webhookSet an URL to get a POST API call once the image generation is complete.
track_idThis ID is returned in the response to the webhook API call. This will be used to identify the webhook request.

Example

Body

Body
{

"key": "",
"prompt": "a cat sitting on a bench",
"negative_prompt": "bad quality",
"init_image": "https://raw.githubusercontent.com/CompVis/stable-diffusion/main/data/inpainting_examples/overture-creations-5sI6fQgYIuo.png",
"width": "512",
"height": "512",
"samples": "1",
"temp": false,
"safety_checker": false,
"strength":0.7,
"seed": null,
"webhook": null,
"track_id": null

}

Request

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
"key": "",
"prompt": "a cat sitting on a bench",
"negative_prompt": "bad quality",
"init_image": "https://raw.githubusercontent.com/CompVis/stable-diffusion/main/data/inpainting_examples/overture-creations-5sI6fQgYIuo.png",
"width": "512",
"height": "512",
"samples": "1",
"temp": false,
"safety_checker": false,
"strength":0.7,
"seed": null,
"webhook": null,
"track_id": null
});

var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};

fetch("https://modelslab.com/api/v1/enterprise/flux/img2img", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));

Response

Example Response
{
"status": "success",
"warning": "",
"id": null,
"generationTime": 8.17,
"output": [
"https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/generations/2ac32c06-17a9-418d-b8f9-d76d32774585-0.png"
],
"proxy_links": [
"https://cdn2.stablediffusionapi.com/generations/2ac32c06-17a9-418d-b8f9-d76d32774585-0.png"
],
"nsfw_content_detected": false,
"webhook_status": "",
"meta": {
"base64": "no",
"clip_skip": null,
"file_prefix": "2ac32c06-17a9-418d-b8f9-d76d32774585",
"guidance_scale": 3.5,
"height": 512,
"init_image": "https://raw.githubusercontent.com/CompVis/stable-diffusion/main/data/inpainting_examples/overture-creations-5sI6fQgYIuo.png",
"instant_response": "no",
"model_id": "flux",
"n_samples": 1,
"negative_prompt": "bad quality",
"num_inference_steps": 10,
"opacity": 0.8,
"padding_down": 10,
"padding_right": 10,
"prompt": "a cat sitting on a bench",
"rescale": "yes",
"safety_checker": "no",
"safety_checker_type": "black",
"scale_down": 6,
"seed": 3851153854,
"strength": 0.7,
"temp": "no",
"watermark": "no",
"width": 512
}
}