API Reference

Create a Generation of Images

post
https://cloud.leonardo.ai/api/rest/v1/generations

This endpoint will generate images

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Query parameters to be provided in the request body as a JSON object

boolean | null
Defaults to true

Enable to use Alchemy. Note: The appropriate Alchemy version is selected for the specified model. For example, XL models will use Alchemy V2.

number | null

Contrast Ratio to use with Alchemy. Must be a float between 0 and 1 inclusive.

number | null
1 to 4.5

Adjusts the contrast level of the generated image. Used in Phoenix and Flux models. Accepts values [1.0, 1.3, 1.8, 2.5, 3, 3.5, 4, 4.5]. For Phoenix, if alchemy is true, contrast needs to be 2.5 or higher.

controlnets
array of objects | null
controlnets
elements
array of objects | null
elements
userElements
array of objects | null
userElements
boolean | null

Enable to use the Expanded Domain feature of Alchemy.

boolean | null

Enable to use the Fantasy Avatar feature.

number | null

How strongly the generation should reflect the prompt. 7 is recommended. Must be between 1 and 20.

integer | null
Defaults to 768

The input height of the images. Must be between 32 and 1536 and be a multiple of 8. Note: Input resolution is not always the same as output resolution due to upscaling from other features.

boolean | null

Enable to use the High Contrast feature of Prompt Magic. Note: Controls RAW mode. Set to false to enable RAW mode.

boolean | null

Enable to use the High Resolution feature of Prompt Magic.

imagePrompts
array of strings or null | null
imagePrompts
number | null
string | null

The ID of an existing image to use in image2image.

string | null

The ID of an Init Image to use in image2image.

number | null

How strongly the generated images should reflect the original image in image2image. Must be a float between 0.1 and 0.9.

string | null
Defaults to b24e16ff-06e3-43eb-8d33-4416c2d75876

The model ID used for image generation. If not provided, uses sd_version to determine the version of Stable Diffusion to use. In-app, model IDs are under the Finetune Models menu. Click on the platform model or your custom model, then click View More. For platform models, you can also use the List Platform Models API.

string | null

The negative prompt used for the image generation

integer | null
Defaults to 4

The number of images to generate. Must be between 1 and 8. If either width or height is over 768, must be between 1 and 4.

integer | null

The Step Count to use for the generation. Must be between 10 and 60. Default is 15.

boolean | null

Enable the photoReal feature. Requires enabling alchemy and unspecifying modelId (for photoRealVersion V1).

string | null

The version of photoReal to use. Must be v1 or v2.

number | null

Depth of field of photoReal. Must be 0.55 for low, 0.5 for medium, or 0.45 for high. Defaults to 0.55 if not specified.

string | null
enum
Defaults to DYNAMIC

The style to generate images with. When photoReal is enabled, refer to the Guide section for a full list. When alchemy is disabled, use LEONARDO or NONE. When alchemy is enabled, use ANIME, CREATIVE, DYNAMIC, ENVIRONMENT, GENERAL, ILLUSTRATION, PHOTOGRAPHY, RAYTRACED, RENDER_3D, SKETCH_BW, SKETCH_COLOR, or NONE.

string
required
Defaults to A majestic cat in the snow

The prompt used to generate images

boolean | null

Enable to use Prompt Magic.

number | null

Strength of prompt magic. Must be a float between 0.1 and 1.0

string | null

Prompt magic version v2 or v3, for use when promptMagic: true

boolean | null

Whether the generated images should show in the community feed.

string
enum

The scheduler to generate images with. Defaults to EULER_DISCRETE if not specified.

Allowed:
string
enum

The base version of stable diffusion to use if not using a custom model. v1_5 is 1.5, v2 is 2.1, if not specified it will default to v1_5. Also includes SDXL and SDXL Lightning models

integer | null

Apply a fixed seed to maintain consistency across generation sets. The maximum seed value is 2147483637 for Flux and 9999999998 for other models

boolean | null

Whether the generated images should tile on all axis.

string | null
enum

Which type of transparency this image should use

Allowed:
boolean | null

Enable to use Ultra mode. Note: can not be used with Alchemy.

boolean | null

Whether the generated images should be unzoomed (requires unzoomAmount and init_image_id to be set).

number | null

How much the image should be unzoomed (requires an init_image_id and unzoom to be set to true).

number | null

How much the image should be upscaled. (Enterprise Only)

integer | null
Defaults to 1024

The input width of the images. Must be between 32 and 1536 and be a multiple of 8. Note: Input resolution is not always the same as output resolution due to upscaling from other features.

boolean | null
deprecated

This parameter will be deprecated in September 2024. Please use the controlnets array instead.

string
enum
deprecated

This parameter will be deprecated in September 2024. Please use the controlnets array instead.

Allowed:
number | null
deprecated

This parameter will be deprecated in September 2024. Please use the controlnets array instead.

boolean | null

Whether the generation is for the Canvas Editor feature.

string | null
enum

The type of request for the Canvas Editor.

Allowed:
string | null

The ID of an initial image to use in Canvas Editor request.

string | null

The ID of a mask image to use in Canvas Editor request.

boolean | null

When enabled, your prompt is expanded to include more detail.

string | null

When enhancePrompt is enabled, the prompt is enhanced based on the given instructions.

Response

Updated 8 months ago

Language
Credentials
Bearer
auth-scheme
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago