Stable Diffusion API Documentation

Integrate Stable Diffusion into your applications and projects with ease. This comprehensive documentation provides an overview of the API, along with clear, step-by-step instructions and best practices, allowing you to leverage Stable Diffusion’s powerful image generation capabilities in your app or software.

Authentication:

To access this API, you must subscribe and obtain an Ocp-Apim-Subscription-Key. Include this key in the header of your request to authenticate and gain access.

Request Headers:

Content-Type Set to application/json
Cache-Control Recommended to set to no-cache
Ocp-Apim-Subscription-Key YOUR_SUBSCRIPTION_KEY

Request Body

API Parameters: The API POST- https://gateway.appypie.com/getImage/v1/getSDXLImage takes the following parameters:

Name Required Type Description
prompt Yes string The prompts to guide the image generation
negative_prompt No string The prompt or prompts not to guide the image generation.
height No Number, default 1024 the height in pixels of the generated image. This is set to 1024 by default for the best results. Anything below 512 pixels won’t work well.
width No Number, default 1024 The width in pixels of the generated image. This is set to 1024 by default for the best results.
num_inference_steps No Number, default 20, Maximum 20 The number of denoising steps. More denoising steps usually lead to a higher-quality image at the expense of slower inference.
guidance_scale No float, default 5.0 Guidance scale is enabled by setting guidance_scale > 1. A higher guidance scale encourages generating images closely linked to the text prompt, usually at the expense of lower image quality.
seed No 42 The seed is used to reproduce results. Providing the same seed will yield the same image each time. Use “null” for a random number seed.

Example Request Body

JSON

{
    "prompt": "High-resolution, realistic image of a red fox sitting gracefully in a lush, green forest during springtime. The fox's fur should be detailed with natural colors, showcasing its reddish-brown coat and white underbelly. The background should be soft-focused, filled with green foliage and a few wildflowers, creating a serene and peaceful atmosphere. Sunlight should filter through the trees, casting gentle dappled light on the fox.",
    "negative_prompt": "Low-quality, blurry image, with any other animals. Avoid abstract or cartoonish styles, dark or gloomy atmosphere, unnecessary objects or distractions in the background, harsh lighting, and unnatural colors.",
    "height": 1024,
    "width": 1024,
    "num_steps": 20,
    "guidance_scale": 5,
    "seed": 40
}

Request Code

Input
   
POST https://gateway.appypie.com/getImage/v1/getSDXLImage HTTP/1.1
  
  Content-Type: application/json
  Cache-Control: no-cache
  
  {
    "prompt": "High-resolution, realistic image of a red fox sitting gracefully in a lush, green forest during springtime. The fox's fur should be detailed with natural colors, showcasing its reddish-brown coat and white underbelly. The background should be soft-focused, filled with green foliage and a few wildflowers, creating a serene and peaceful atmosphere. Sunlight should filter through the trees, casting gentle dappled light on the fox.",
    "negative_prompt": "Low-quality, blurry image, with any other animals. Avoid abstract or cartoonish styles, dark or gloomy atmosphere, unnecessary objects or distractions in the background, harsh lighting, and unnatural colors.",
    "height": 1024,
    "width": 1024,
    "num_steps": 20,
    "guidance_scale": 5,
    "seed": 40
  }
import urllib.request, json
  
  try:
      url = "https://gateway.appypie.com/getImage/v1/getSDXLImage"
  
      hdr ={
      # Request headers
      'Content-Type': 'application/json',
      'Cache-Control': 'no-cache',
      }
  
      # Request body
      data =  
      data = json.dumps(data)
      req = urllib.request.Request(url, headers=hdr, data = bytes(data.encode("utf-8")))
  
      req.get_method = lambda: 'POST'
      response = urllib.request.urlopen(req)
      print(response.getcode())
      print(response.read())
      except Exception as e:
      print(e)

                                    
// Request body
  const body = {
    "prompt": "High-resolution, realistic image of a red fox sitting gracefully in a lush, green forest during springtime. The fox's fur should be detailed with natural colors, showcasing its reddish-brown coat and white underbelly. The background should be soft-focused, filled with green foliage and a few wildflowers, creating a serene and peaceful atmosphere. Sunlight should filter through the trees, casting gentle dappled light on the fox.",
    "negative_prompt": "Low-quality, blurry image, with any other animals. Avoid abstract or cartoonish styles, dark or gloomy atmosphere, unnecessary objects or distractions in the background, harsh lighting, and unnatural colors.",
    "height": 1024,
    "width": 1024,
    "num_steps": 20,
    "guidance_scale": 5,
    "seed": 40
  };
  
  fetch('https://gateway.appypie.com/getImage/v1/getSDXLImage', {
          method: 'POST',
          body: JSON.stringify(body),
          // Request headers
          headers: {
              'Content-Type': 'application/json',
              'Cache-Control': 'no-cache',}
      })
      .then(response => {
          console.log(response.status);
          console.log(response.text());
      })
      .catch(err => console.error(err));
   curl -v -X POST "https://gateway.appypie.com/getImage/v1/getSDXLImage" -H "Content-Type: application/json" -H "Cache-Control: no-cache" --data-raw "{
      \"prompt\": \"High-resolution, realistic image of a red fox sitting gracefully in a lush, green forest during springtime. The fox's fur should be detailed with natural colors, showcasing its reddish-brown coat and white underbelly. The background should be soft-focused, filled with green foliage and a few wildflowers, creating a serene and peaceful atmosphere. Sunlight should filter through the trees, casting gentle dappled light on the fox.\",
      \"negative_prompt\": \"Low-quality, blurry image, with any other animals. Avoid abstract or cartoonish styles, dark or gloomy atmosphere, unnecessary objects or distractions in the background, harsh lighting, and unnatural colors.\",
      \"height\": 1024,
      \"width\": 1024,
      \"num_steps\": 20,
      \"guidance_scale\": 5,
      \"seed\": 40
  }"
import java.io.BufferedReader;
  import java.io.InputStreamReader;
  import java.net.HttpURLConnection;
  import java.net.URL;
  import java.net.URLEncoder;
  import java.util.HashMap;
  import java.util.Map;
  import java.io.UnsupportedEncodingException;
  import java.io.DataInputStream;
  import java.io.InputStream;
  import java.io.FileInputStream;
  
  public class HelloWorld {
  
    public static void main(String[] args) {
      try {
          String urlString = "https://gateway.appypie.com/getImage/v1/getSDXLImage";
          URL url = new URL(urlString);
          HttpURLConnection connection = (HttpURLConnection) url.openConnection();
  
          //Request headers
      connection.setRequestProperty("Content-Type", "application/json");
      
      connection.setRequestProperty("Cache-Control", "no-cache");
      
          connection.setRequestMethod("POST");
  
          // Request body
          connection.setDoOutput(true);
          connection
              .getOutputStream()
              .write(
               "{ \"prompt\": \"High-resolution, realistic image of a red fox sitting gracefully in a lush, green forest during springtime. The fox's fur should be detailed with natural colors, showcasing its reddish-brown coat and white underbelly. The background should be soft-focused, filled with green foliage and a few wildflowers, creating a serene and peaceful atmosphere. Sunlight should filter through the trees, casting gentle dappled light on the fox.\", \"negative_prompt\": \"Low-quality, blurry image, with any other animals. Avoid abstract or cartoonish styles, dark or gloomy atmosphere, unnecessary objects or distractions in the background, harsh lighting, and unnatural colors.\", \"height\": 1024, \"width\": 1024, \"num_steps\": 20, \"guidance_scale\": 5, \"seed\": 40 }".getBytes()
               );
      
          int status = connection.getResponseCode();
          System.out.println(status);
  
          BufferedReader in = new BufferedReader(
              new InputStreamReader(connection.getInputStream())
          );
          String inputLine;
          StringBuffer content = new StringBuffer();
          while ((inputLine = in.readLine()) != null) {
              content.append(inputLine);
          }
          in.close();
          System.out.println(content);
  
          connection.disconnect();
      } catch (Exception ex) {
        System.out.print("exception:" + ex.getMessage());
      }
    }
  }
$url = "https://gateway.appypie.com/getImage/v1/getSDXLImage";
  $curl = curl_init($url);
  
  curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
  curl_setopt($curl, CURLOPT_URL, $url);
  curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  
  # Request headers
  $headers = array(
      'Content-Type: application/json',
      'Cache-Control: no-cache',);
  curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
  
  # Request body
  $request_body = '{
    "prompt": "High-resolution, realistic image of a red fox sitting gracefully in a lush, green forest during springtime. The fox's fur should be detailed with natural colors, showcasing its reddish-brown coat and white underbelly. The background should be soft-focused, filled with green foliage and a few wildflowers, creating a serene and peaceful atmosphere. Sunlight should filter through the trees, casting gentle dappled light on the fox.",
    "negative_prompt": "Low-quality, blurry image, with any other animals. Avoid abstract or cartoonish styles, dark or gloomy atmosphere, unnecessary objects or distractions in the background, harsh lighting, and unnatural colors.",
    "height": 1024,
    "width": 1024,
    "num_steps": 20,
    "guidance_scale": 5,
    "seed": 40
  }';
  curl_setopt($curl, CURLOPT_POSTFIELDS, $request_body);
  
  $resp = curl_exec($curl);
  curl_close($curl);
  var_dump($resp);


Response

JSON

HTTP response
HTTP/1.1 200 OK

alt-svc: h3=":443"; ma=86400
cf-ray: 8bdbcd171a543a9f-BOM
content-encoding: br
content-type: application/json
date: Wed, 04 Sep 2024 06:07:52 GMT
nel: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
report-to: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v4?s=eQnaAjFIewOJadUXJHli6T986l%2BlJO4H9yyB0zO3xGYE5TKOWWSxUS9JmMAvoEkYIyZKqwoyx7FrGYGz5f%2FCW1Pki5N5nst9snIcQ9diy4ok8AyReDQWS9ObYHrXRI8UY9ZjYFHbPsljxMnqIH9LxKE%2BAOwh9sIN0%2Fw8ZDMdTH%2FlkVLj0p4oa7CVbUE%3D"}],"group":"cf-nel","max_age":604800}
server: cloudflare
vary: Accept-Encoding,Origin

{
    "imageUrl": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/sdxl_lightning/prompt-910739568-1725430070244-272448.png"
}

Error Handling

The Stable Diffusion API returns specific HTTP status codes and response bodies to indicate the success or failure of a request. Developers should implement error handling in their applications to manage these responses effectively.

Common Errors

  • 400 Bad Request: The request was improperly formatted, or required parameters are missing.
  • 401 Unauthorized: Authentication failed, or the required authentication credentials were not provided.
  • 500 Internal Server Error: The server encountered an unexpected issue that prevented it from completing the request.

Example Error Response

{
    "error": "Invalid prompt parameter"
}

This documentation provides all the necessary information for effectively using the Stable Diffusion API. Make sure to replace YOUR_API_KEY with the actual key you received when you subscribed to the service.