Image Guided Editing Endpoint

• outpainting
• blip_diffusion
• magic_mix
• depth2img
• image_guided_editing
• removebg_createmask
• super_resolution
• image_mixer
• multiview
• fashion
• face_gen
• fetch
• inpaint
• head shot
• object_removal
• avatar_gen
• relighting

Overview

V5 Picture to Picture endpoint is used to edit an image using a text prompt with the description of the desired changes.

Pass the image URL with the init_image parameter and add your description of the expected result to the prompt parameter.

Request

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

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

Watch the how-to video to see it in action.

Body Attributes

Parameter	Description	Values
key	Your API Key used for request authorization	string
prompt	Text prompt with description of the things you want in the image to be generated	string
init_image	Link to the initial image	URL
image_guidance_scale	The scale for image guidance.	min: 1, max: 8
steps	Number of denoising steps. The minimum is 1 and the maximum is 50. The default is 20.	integer
guidance_scale	Scale for classifier-free guidance. The minimum is 1 and the maximum is 20.	integer

Example

Body

Body

{
  "key": "",
  "init_image" : "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/livewire-tmp/2ILk0g1tgpk7wFFlc72hyAtdmHjxAj-metaZjNkNzVjMWQtMTI1OS00NDA4LTg0YmQtNzA0NTVmMTljZjcwLTAucG5n-.png",
  "prompt" : "make him woman",
  "image_guidance_scale" : 1,
  "steps" : 50,
  "guidance_scale" : 7
}

Request

JS

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

var raw = JSON.stringify({
  "key": "",
  "init_image" : "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/livewire-tmp/2ILk0g1tgpk7wFFlc72hyAtdmHjxAj-metaZjNkNzVjMWQtMTI1OS00NDA4LTg0YmQtNzA0NTVmMTljZjcwLTAucG5n-.png",
  "prompt" : "make him woman",
  "image_guidance_scale" : 1,
  "steps" : 50,
  "guidance_scale" : 7
});

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

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

PHP

<?php

$payload = [
  "key" => "", 
  "init_image" => "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/livewire-tmp/2ILk0g1tgpk7wFFlc72hyAtdmHjxAj-metaZjNkNzVjMWQtMTI1OS00NDA4LTg0YmQtNzA0NTVmMTljZjcwLTAucG5n-.png", 
  "prompt" => "make him woman", 
  "image_guidance_scale" => 1, 
  "steps" => 50, 
  "guidance_scale" => 7
];

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://modelslab.com/api/v6/image_editing/pix2pix',
  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/pix2pix',
  'headers': {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "key": "",
    "init_image" : "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/livewire-tmp/2ILk0g1tgpk7wFFlc72hyAtdmHjxAj-metaZjNkNzVjMWQtMTI1OS00NDA4LTg0YmQtNzA0NTVmMTljZjcwLTAucG5n-.png",
    "prompt" : "make him woman",
    "image_guidance_scale" : 1,
    "steps" : 50,
    "guidance_scale" : 7
  })
};

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/pix2pix"

payload = json.dumps({
  "key": "",
  "init_image" : "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/livewire-tmp/2ILk0g1tgpk7wFFlc72hyAtdmHjxAj-metaZjNkNzVjMWQtMTI1OS00NDA4LTg0YmQtNzA0NTVmMTljZjcwLTAucG5n-.png",
  "prompt" : "make him woman",
  "image_guidance_scale" : 1,
  "steps" : 50,
  "guidance_scale" : 7
})

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, "{\n  \"key\": \"\",\n  \"init_image\" : \"https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/livewire-tmp/2ILk0g1tgpk7wFFlc72hyAtdmHjxAj-metaZjNkNzVjMWQtMTI1OS00NDA4LTg0YmQtNzA0NTVmMTljZjcwLTAucG5n-.png\",\n    \"prompt\" : \"make him woman\",\n  \"image_guidance_scale\" : 1,\n  \"steps\" : 50,\n  \"guidance_scale\" : 7\n}");
Request request = new Request.Builder()
  .url("https://modelslab.com/api/v6/image_editing/pix2pix")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

Response

Example Response

{
    "status": "success",
    "generationTime": 11.955173015594482,
    "id": 235693,
    "output": [
        "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/generations/7f54383a-7c97-4d2f-885e-9761d57cc20b-0.png"
    ],
    "proxy_links": "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/generations/7f54383a-7c97-4d2f-885e-9761d57cc20b-0.png",
    "meta": {
        "H": 512,
        "W": 512,
        "file_prefix": "7f54383a-7c97-4d2f-885e-9761d57cc20b",
        "guidance_scale": 7.5,
        "image_guidance_scale": 1,
        "init_image": "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/livewire-tmp/2ILk0g1tgpk7wFFlc72hyAtdmHjxAj-metaZjNkNzVjMWQtMTI1OS00NDA4LTg0YmQtNzA0NTVmMTljZjcwLTAucG5n-.png",
        "n_samples": 1,
        "negative_prompt": "",
        "outdir": "out",
        "prompt": "make him woman",
        "safetychecker": "no",
        "seed": 2974742231,
        "steps": 50
    }
}