API Endpoints

/generate/txt2img-ip-adapter

post
https://api.cloud.scenario.com/v1/generate/txt2img-ip-adapter

Trigger a new image generation in Txt2Img mode with one IpAdapter reference image that guides the generation process.

Query Params
string

If set to true, returns the original asset without transformation

string
Body Params
ipAdapterImageIds
array of strings

The IpAdapter images as an AssetId. Will be ignored if the ipAdapterImages parameter is provided

ipAdapterImageIds
string

Deprecated for type txt2img-ip-adapter and img2img-ip-adapter, use ipAdapterImageIds instead. The IpAdapter image as an AssetId. Cannot be set if ipAdapterImage is provided. Will be ignored if the ipAdapterImageIds parameter is provided.

number
0 to 1

Deprecated for type txt2img-ip-adapter and img2img-ip-adapter, use ipAdapterScales instead. IpAdapter scale factor (within [0.0, 1.0], default: 0.9). Will be ignored if the ipAdapterScales parameter is provided

string

Used to reproduce previous results. Default: randomly generated number.

string
required

The model id to use for the inference

string
enum
Defaults to style

The type of IP Adapter model to use. Must be one of [style, character], default to `style``

Allowed:
string

The epoch of the model to use for the inference. Only available for Flux Lora Trained models.

boolean
Defaults to false

If set, generated assets will be hidden and not returned in the list of images of the inference or when listing assets (default: false)

string
enum
Defaults to 1:1

The aspect ratio of the generated images. Only used for the model flux.1.1-pro-ultra. The aspect ratio is a string formatted as "width:height" (example: "16:9").

ipAdapterScales
array of numbers

IpAdapter scale factors (within [0.0, 1.0], default: 0.9).

ipAdapterScales
string

Deprecated for type txt2img-ip-adapter and img2img-ip-adapter, use ipAdapterImages instead. The IpAdapter image as a data url. Will be ignored if the ipAdapterImages parameter is provided.

string

The prompt not to guide the image generation, ignored when guidance < 1 (example: "((ugly face))") For Flux based model (not Fast-Flux): requires negativePromptStrength > 0 and active only for inference types txt2img / img2img / controlnet.

string
enum

The scheduler to use to override the default configured for the model. See detailed documentation for more details.

boolean
Defaults to false

Enable or disable the intermediate images generation (default: false)

concepts
array of objects
concepts
number
0 to 20

Controls how closely the generated image follows the prompt. Higher values result in stronger adherence to the prompt. Default and allowed values depend on the model type:

  • For Flux dev models, the default is 3.5 and allowed values are within [0, 10]
  • For Flux pro models, the default is 3 and allowed values are within [2, 5]
  • For SDXL models, the default is 6 and allowed values are within [0, 20]
  • For SD1.5 models, the default is 7.5 and allowed values are within [0, 20]
number
1 to 150

The number of denoising steps for each image generation (within [1, 150], default: 30)

number
1 to 128

The number of images to generate (within [1, 128], default: 4)

ipAdapterImages
array of strings

The IpAdapter images as a data url.

ipAdapterImages
number
64 to 2048

The width of the generated images, must be a 8 multiple (within [64, 2048], default: 512) If model.type is sd-xl, sd-xl-lora, sd-xl-composition the width must be within [512, 2048] If model.type is sd-1_5, the width must be within [64, 1024] If model.type is flux.1.1-pro-ultra, you can use the aspectRatio parameter instead

number
0 to 10

Only applicable for flux-dev based models for txt2img, img2img, and controlnet inference types.

Controls the influence of the negative prompt. Default 0 means the negative prompt has no effect. Higher values increase negative prompt influence. Must be > 0 if negativePrompt is provided.

string

The base model to use for the inference. Only Flux LoRA models can use this parameter. Allowed values are available in the model's attribute: compliantModelIds

string
required

Full text prompt including the model placeholder. (example: "an illustration of phoenix in a fantasy world, flying over a mountain, 8k, bokeh effect")

number
64 to 2048

The height of the generated images, must be a 8 multiple (within [64, 2048], default: 512) If model.type is sd-xl, sd-xl-lora, sd-xl-composition the height must be within [512, 2048] If model.type is sd-1_5, the height must be within [64, 1024] If model.type is flux.1.1-pro-ultra, you can use the aspectRatio parameter instead

Responses

Updated 5 months ago

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

Updated 5 months ago