generate

Apply image transformations to a provided image.

post/api/generate/image-to-image

Request

  • The document declares no server URL.
  • Auth
    none declared

Request body multipart/form-data

promptstring required

Text prompt(s) to guide image generation.

imagestring binary required

Uploaded image to modify with the pipeline.

model_idstring

Hugging Face model ID used for image generation.

lorasstring

A LoRA (Low-Rank Adaptation) model and its corresponding weight for image generation. Example: { "latent-consistency/lcm-lora-sdxl": 1.0, "nerijs/pixel-art-xl": 1.2}.

strengthnumber

Degree of transformation applied to the reference image (0 to 1).

guidance_scalenumber

Encourages model to generate images closely linked to the text prompt (higher values may reduce image quality).

image_guidance_scalenumber

Degree to which the generated image is pushed towards the initial image.

negative_promptstring

Text prompt(s) to guide what to exclude from image generation. Ignored if guidance_scale < 1.

safety_checkboolean

Perform a safety check to estimate if generated images could be offensive or harmful.

seedinteger

Seed for random number generation.

num_inference_stepsinteger

Number of denoising steps. More steps usually lead to higher quality images but slower inference. Modulated by strength.

num_images_per_promptinteger

Number of images to generate per prompt.

Response

Successful Response

Changes

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status