Developer Resources

The following is documentation For Access to our API, please contact us at [e-mail]

API Documentation

General Parameters

• prompt: (String) Main input text that guides the image generation process.

• negative_prompt: (String) Text describing what to avoid during the image generation.

• styles: (Array of Strings) Predefined styles to apply to the generated image.

• seed: (Integer) Seed for randomness, allowing for reproducibility. A value of -1 indicates random seeding.

• subseed: (Integer) Secondary seed to introduce variance while maintaining some characteristics from the main seed.

• subseed_strength: (Float) Determines the influence of the subseed on the generation process.

• seed_resize_from_h: (Integer) Specifies the height from which to resize the seed, used for style mixing.

• seed_resize_from_w: (Integer) Specifies the width from which to resize the seed, used for style mixing.

Image Generation Settings

• sampler_name: (String) Defines the algorithm used for sampling during generation.

• batch_size: (Integer) Number of images to generate in one batch.

• n_iter: (Integer) Number of iterations to repeat the generation process.

• steps: (Integer) Number of refinement steps in the generation process.

• cfg_scale: (Float) Controls the influence of the conditioning text relative to the noise in the image generation.

• width: (Integer) Width of the generated image in pixels.

• height: (Integer) Height of the generated image in pixels.

Enhancement and Modification Parameters

• restore_faces: (Boolean) Whether to apply face restoration on generated faces.

• tiling: (Boolean) If true, the generated images will be tileable (seamless).

• do_not_save_samples: (Boolean) If true, individual samples will not be saved.

• do_not_save_grid: (Boolean) If true, the grid of generated images will not be saved.

• eta: (Float) Controls the amount of random noise introduced during sampling.

• denoising_strength: (Float) Determines the strength of the denoising algorithm applied during image generation.

Advanced Settings

• s_min_uncond, s_churn, s_tmax, s_tmin, s_noise: Advanced settings for controlling various aspects of the sampling algorithm.

• override_settings: (Object) Temporary changes to the model's default settings used during this request.

• override_settings_restore_afterwards: (Boolean) If true, settings will be restored to defaults after this request.

• refiner_checkpoint: (String) Specifies a checkpoint for a secondary refinement model.

• refiner_switch_at: (Integer) Step at which to switch to the refiner model during generation.

• disable_extra_networks: (Boolean) If true, disables non-essential networks to save computational resources.

Image Initialization and Masking

• firstpass_image: (String) An initial image for guidance or continuation.

• init_images: (Array of Strings) Initial images for conditioning the generation.

• resize_mode: (Integer) Method of resizing initial images (e.g., fit, fill).

• image_cfg_scale: (Float) Similar to cfg_scale, but specifically for initial images.

• mask: (String) A mask image for inpainting or guided generation.

• mask_blur_x, mask_blur_y, mask_blur: Parameters controlling the blurring of the mask image.

• mask_round: (Boolean) If true, applies rounding to the edges of the mask.

• inpainting_fill: (Integer) Specifies the fill method for inpainting.

• inpaint_full_res: (Boolean) Whether inpainting should be done at full resolution.

• inpaint_full_res_padding: (Integer) Padding added around inpainting areas in full-res mode.

• inpainting_mask_invert: (Integer) Inverts the inpainting mask if set.

Scripting and Customization

• initial_noise_multiplier, latent_mask: Parameters for advanced noise and masking control.

• force_task_id: (String) Forces the use of a specific task identifier.

• sampler_index: (String) Specifies which sampler configuration to use.

• include_init_images: (Boolean) If true, initial images are included in the generation process.

• script_name: (String) The name of a custom script to run during generation.

• script_args: (Array) Arguments to pass to the custom script.

• send_images: (Boolean) If true, sends images directly to the requestor.

• save_images: (Boolean) If true, saves generated images to the server.

• alwayson_scripts: (Object) Scripts that are always applied to the generation.

• infotext: (String) Additional information or instructions related to the generation request.

General Parameters

• prompt: (String) Main input text that guides the image generation process.

• negative_prompt: (String) Text describing what to avoid during the image generation.

• styles: (Array of Strings) Predefined styles to apply to the generated image.

• seed: (Integer) Seed for randomness, allowing for reproducibility. A value of -1 indicates random seeding.

• subseed: (Integer) Secondary seed to introduce variance while maintaining some characteristics from the main seed.

• subseed_strength: (Float) Determines the influence of the subseed on the generation process.

• seed_resize_from_h: (Integer) Specifies the height from which to resize the seed, used for style mixing.

• seed_resize_from_w: (Integer) Specifies the width from which to resize the seed, used for style mixing.

Image Generation Settings

• sampler_name: (String) Defines the algorithm used for sampling during generation.

• batch_size: (Integer) Number of images to generate in one batch.

• n_iter: (Integer) Number of iterations to repeat the generation process.

• steps: (Integer) Number of refinement steps in the generation process.

• cfg_scale: (Float) Controls the influence of the conditioning text relative to the noise in the image generation.

• width: (Integer) Width of the generated image in pixels.

• height: (Integer) Height of the generated image in pixels.

Enhancement and Modification Parameters

• restore_faces: (Boolean) Whether to apply face restoration on generated faces.

• tiling: (Boolean) If true, the generated images will be tileable (seamless).

• do_not_save_samples: (Boolean) If true, individual samples will not be saved.

• do_not_save_grid: (Boolean) If true, the grid of generated images will not be saved.

• eta: (Float) Controls the amount of random noise introduced during sampling.

• denoising_strength: (Float) Determines the strength of the denoising algorithm applied during image generation.

Advanced Settings

• s_min_uncond, s_churn, s_tmax, s_tmin, s_noise: Advanced settings for controlling various aspects of the sampling algorithm.

• override_settings: (Object) Temporary changes to the model's default settings used during this request.

• override_settings_restore_afterwards: (Boolean) If true, settings will be restored to defaults after this request.

• refiner_checkpoint: (String) Specifies a checkpoint for a secondary refinement model.

• refiner_switch_at: (Integer) Step at which to switch to the refiner model during generation.

• disable_extra_networks: (Boolean) If true, disables non-essential networks to save computational resources.

Image Initialization and Masking

• firstpass_image: (String) An initial image for guidance or continuation.

• init_images: (Array of Strings) Initial images for conditioning the generation.

• resize_mode: (Integer) Method of resizing initial images (e.g., fit, fill).

• image_cfg_scale: (Float) Similar to cfg_scale, but specifically for initial images.

• mask: (String) A mask image for inpainting or guided generation.

• mask_blur_x, mask_blur_y, mask_blur: Parameters controlling the blurring of the mask image.

• mask_round: (Boolean) If true, applies rounding to the edges of the mask.

• inpainting_fill: (Integer) Specifies the fill method for inpainting.

• inpaint_full_res: (Boolean) Whether inpainting should be done at full resolution.

• inpaint_full_res_padding: (Integer) Padding added around inpainting areas in full-res mode.

• inpainting_mask_invert: (Integer) Inverts the inpainting mask if set.

Scripting and Customization

• initial_noise_multiplier, latent_mask: Parameters for advanced noise and masking control.

• force_task_id: (String) Forces the use of a specific task identifier.

• sampler_index: (String) Specifies which sampler configuration to use.

• include_init_images: (Boolean) If true, initial images are included in the generation process.

• script_name: (String) The name of a custom script to run during generation.

• script_args: (Array) Arguments to pass to the custom script.

• send_images: (Boolean) If true, sends images directly to the requestor.

• save_images: (Boolean) If true, saves generated images to the server.

• alwayson_scripts: (Object) Scripts that are always applied to the generation.

• infotext: (String) Additional information or instructions related to the generation request.

SDK Documentation

• Coming soon