swagger.json

{
  "openapi": "3.0.0",
  "info": {
    "version": "3.5.0",
    "title": "Stable Diffusion API",
    "description": "Simple API for generating images from text prompts using Prodia.",
    "contact": {
      "name": "Open Source",
      "url": "https://github.com/rizzlogy/stable-diffusion-nodejs",
      "email": "support@rizzy.eu.org"
    }
  },
  "tags": [
    {
      "name": "stablediff",
      "description": "Endpoints related to generating images using AI"
    },
    {
      "name": "models",
      "description": "Endpoints to check available models for image generation"
    },
    {
      "name": "style presets",
      "description": "Endpoints to check available style presets for image generation"
    }
  ],
  "paths": {
    "/api/v1/generateImage": {
      "get": {
        "tags": ["stablediff"],
        "summary": "Generate Image from Text Prompt",
        "description": "Endpoint to generate an image based on the provided text prompt and other parameters.",
        "parameters": [
          {
            "name": "prompt",
            "in": "query",
            "required": true,
            "description": "The text prompt for image generation.",
            "schema": {
              "type": "string",
              "default": "space warrior, beautiful, female, ultrarealistic, soft lighting, 8k"
            }
          },
          {
            "name": "negativePrompt",
            "in": "query",
            "required": false,
            "description": "The text negative prompt for image generation.",
            "schema": {
              "type": "string",
              "default": "3d, cartoon, anime, (deformed eyes, nose, ears, nose), bad anatomy, ugly"
            }
          },
          {
            "name": "typeModel",
            "in": "query",
            "required": true,
            "description": "The type of model.",
            "schema": {
              "type": "string",
              "enum": ["default", "sdxl"]
            }
          },
          {
            "name": "upscale",
            "in": "query",
            "required": true,
            "description": "The image upscale of model.",
            "schema": {
              "type": "string",
              "enum": ["false", "true"]
            }
          },
          {
            "name": "model",
            "in": "query",
            "required": true,
            "description": "The model to use for image generation.",
            "schema": {
              "type": "string",
              "default": "Absolute Reality V16"
            }
          },
          {
            "name": "stylePreset",
            "in": "query",
            "required": true,
            "description": "The style preset for image generation.",
            "schema": {
              "type": "string",
              "default": "default"
            }
          },
          {
            "name": "height",
            "in": "query",
            "required": true,
            "description": "The image height, Please provide values between 1 and 1024, or use 'default' or '0'.",
            "schema": {
              "type": "string",
              "default": "default"
            }
          },
          {
            "name": "width",
            "in": "query",
            "required": true,
            "description": "The image width, Please provide values between 1 and 1024, or use 'default' or '0'.",
            "schema": {
              "type": "string",
              "default": "default"
            }
          },
          {
            "name": "view",
            "in": "query",
            "required": true,
            "description": "Response format.",
            "schema": {
              "type": "string",
              "enum": ["json", "image"]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "result": {
                      "type": "string",
                      "example": "https://images.prodia.xyz/1992a4f8-20c7-4e33-8e42-26a44fa592b6.png"
                    },
                    "status": {
                      "type": "integer",
                      "example": 200
                    },
                    "creator": {
                      "type": "string",
                      "example": "Stable Diffusion - ©RizzyFuzz"
                    }
                  }
                }
              },
              "image/png": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          },
          "400": {
            "description": "Missing parameters",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "example": 400
                    },
                    "content": {
                      "type": "string",
                      "example": "Missing parameters: parameters"
                    },
                    "creator": {
                      "type": "string",
                      "example": "Stable Diffusion - ©RizzyFuzz"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "example": 500
                    },
                    "content": {
                      "type": "string",
                      "example": "Internal Server Error"
                    },
                    "creator": {
                      "type": "string",
                      "example": "Stable Diffusion - ©RizzyFuzz"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "example": 429
                    },
                    "content": {
                      "type": "string",
                      "example": "Too many requests."
                    },
                    "creator": {
                      "type": "string",
                      "example": "Stable Diffusion - ©RizzyFuzz"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/models": {
      "get": {
        "tags": ["models"],
        "summary": "Get Available Models",
        "description": "Endpoint to get the available models for image generation.",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "model": {
                      "type": "object",
                      "properties": {
                        "default": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "sdxl": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      }
                    },
                    "status": {
                      "type": "integer",
                      "example": 200
                    },
                    "creator": {
                      "type": "string",
                      "example": "Stable Diffusion - ©RizzyFuzz"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/styleSheet": {
      "get": {
        "tags": ["style presets"],
        "summary": "Get Available Style Presets",
        "description": "Endpoint to get the available style presets for image generation.",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "stylePresets": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "default"
                      }
                    },
                    "status": {
                      "type": "integer",
                      "example": 200
                    },
                    "creator": {
                      "type": "string",
                      "example": "Stable Diffusion - ©RizzyFuzz"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}