Flux Endpoint

Overview

This endpoint helps to to edit an image using Flux.

Request

--request POST 'https://modelslab.com/api/v6/image_editing/flux_edit' \

Make a POST request to https://modelslab.com/api/v6/image_editing/flux_edit endpoint and pass the required parameters as a request body to the endpoint.

Body Attributes

Parameter	Description
key	Your API Key used for request authorization
init_image	Link to the actual image
num_inference_steps	The number of denoising steps. The acceptable values are 1-10
guidance_scale	The scale for classifier-free guidance. The minimum is 1 and the maximum is 50
base64	true or false
webhook	Set an URL to get a POST API call once the image generation is complete.
track_id	This ID is returned in the response to the webhook API call. This will be used to identify the webhook request.

Example

Body

Body

{
  "key": "",
    "init_image":"https://i.pinimg.com/736x/0d/22/64/0d226454abe91bc4828425c47bd9da74.jpg",
    "prompt":"change the colour of the dress to red",
    "guidance_scale":"50",
    "num_inference_steps":"10",
    "track_id": null,
    "webhook": null
}

Request

JS

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

var raw = JSON.stringify({
    "key":"",
    "init_image":"https://i.pinimg.com/736x/0d/22/64/0d226454abe91bc4828425c47bd9da74.jpg",
    "prompt":"change the colour of the dress to red",
    "guidance_scale":"50",
    "num_inference_steps":"10"
    "track_id": null,
    "webhook": null
});

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

fetch("https://modelslab.com/api/v6/image_editing/flux_edit", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

PHP

<?php

$payload = [
    "key" => "",
    "init_image" => "https://i.pinimg.com/736x/0d/22/64/0d226454abe91bc4828425c47bd9da74.jpg",
    "prompt" => "change the colour of the dress to red",
    "guidance_scale" => "50",
    "num_inference_steps" => "10"
    "track_id" => null,
    "webhook" => null
];

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://modelslab.com/api/v6/image_editing/flux_edit',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => json_encode($payload),
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

NODE

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://modelslab.com/api/v6/image_editing/flux_edit',
  'headers': {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "key":"",
    "init_image":"https://i.pinimg.com/736x/0d/22/64/0d226454abe91bc4828425c47bd9da74.jpg",
    "prompt":"change the colour of the dress to red",
    "guidance_scale":"50",
    "num_inference_steps":"10"
    "track_id": null,
    "webhook": null
  })
};

request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

PYTHON

import requests
import json

url = "https://modelslab.com/api/v6/image_editing/flux_edit"

payload = json.dumps({
    "key":"",
    "init_image":"https://i.pinimg.com/736x/0d/22/64/0d226454abe91bc4828425c47bd9da74.jpg",
    "prompt":"change the colour of the dress to red",
    "guidance_scale":"50",
    "num_inference_steps":"10"
    "track_id":None,
    "webhook":None
})

headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

JAVA

  OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"key\": \"\",\r\n    \"init_image\": \"https://i.ibb.co/kMRK2mg/image2.jpg\",\r\n    \"specific_object\": \"the ball\",\r\n    \"track_id\":null,\r\n    \"webhook\":null\r\n}");
Request request = new Request.Builder()
  .url("https://modelslab.com/api/v6/image_editing/flux_edit")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("X-API-Key", "{{token}}")
  .build();
Response response = client.newCall(request).execute();

Response

Success

{
    "status": "success",
    "generationTime": 5.358475685119629,
    "id": 1942,
   "future_links": [
        "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/temp/2e91ee4e-8863-4c7d-9eb9-8a9e5e7158cd.png"
    ],
    "proxy_links": [
        "https://cdn2.stablediffusionapi.com/temp/2e91ee4e-8863-4c7d-9eb9-8a9e5e7158cd.png"
    ],
    "meta": {
        "padding_down": 10,
        "padding_right": 10,
        "prompt": "change the colour of the dress to red",
        "scale_down": 6,
        "seed": 3491630746,
        "system_webhook": "http://sdapi-website-v2.test/generation_handler/imagen/1942",
        "temp": "yes",
        "track_id": null,
        "watermark": "no",
        "webhook": null
    }
}

Processing

{
    "status": "processing",
    "tip": "Your image is processing in background, you can get this image using fetch API",
    "eta": 5,
    "message": "Try to fetch request after seconds estimated",
    "fetch_result": "https://modelslab.com/api/v6/image_editing/fetch/142508646",
    "id": 142508646,
    "output": [],
    "future_links": [
        "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/temp/51aa0352-af13-4821-8d63-a8c676155fb8.png"
    ],
    "proxy_links": [
        "https://cdn2.stablediffusionapi.com/temp/51aa0352-af13-4821-8d63-a8c676155fb8.png"
    ],
    "meta": {
        "base64": "no",
        "file_prefix": "51aa0352-af13-4821-8d63-a8c676155fb8",
        "guidance_scale": 50,
        "id": "142508646",
        "image": "https://i.pinimg.com/736x/0d/22/64/0d226454abe91bc4828425c47bd9da74.jpg",
        "num_inference_steps": 10,
        "opacity": 0.7,
        "outdir": "out",
        "output": [
            "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/temp/51aa0352-af13-4821-8d63-a8c676155fb8.png"
        ],
        "padding_down": 10,
        "padding_right": 10,
        "prompt": "change the colour of the dress to red",
        "scale_down": 6,
        "seed": 1516274253,
        "system_webhook": "https://modelslab.com/generation_handler/imagen/142508646",
        "temp": "yes",
        "track_id": null,
        "watermark": "no",
        "webhook": null
    }
}

Error

{
    "status": "error",
    "message": "Error message"
}