InvokeAI/invokeai/frontend/web/src/services/api/schema.d.ts

8087 lines
212 KiB
TypeScript

/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export type paths = {
'/api/v1/sessions/': {
/**
* List Sessions
* @description Gets a list of sessions, optionally searching
*/
get: operations['list_sessions'];
/**
* Create Session
* @description Creates a new session, optionally initializing it with an invocation graph
*/
post: operations['create_session'];
};
'/api/v1/sessions/{session_id}': {
/**
* Get Session
* @description Gets a session
*/
get: operations['get_session'];
};
'/api/v1/sessions/{session_id}/nodes': {
/**
* Add Node
* @description Adds a node to the graph
*/
post: operations['add_node'];
};
'/api/v1/sessions/{session_id}/nodes/{node_path}': {
/**
* Update Node
* @description Updates a node in the graph and removes all linked edges
*/
put: operations['update_node'];
/**
* Delete Node
* @description Deletes a node in the graph and removes all linked edges
*/
delete: operations['delete_node'];
};
'/api/v1/sessions/{session_id}/edges': {
/**
* Add Edge
* @description Adds an edge to the graph
*/
post: operations['add_edge'];
};
'/api/v1/sessions/{session_id}/edges/{from_node_id}/{from_field}/{to_node_id}/{to_field}': {
/**
* Delete Edge
* @description Deletes an edge from the graph
*/
delete: operations['delete_edge'];
};
'/api/v1/sessions/{session_id}/invoke': {
/**
* Invoke Session
* @description Invokes a session
*/
put: operations['invoke_session'];
/**
* Cancel Session Invoke
* @description Invokes a session
*/
delete: operations['cancel_session_invoke'];
};
'/api/v1/models/': {
/**
* List Models
* @description Gets a list of models
*/
get: operations['list_models'];
};
'/api/v1/models/{base_model}/{model_type}/{model_name}': {
/**
* Delete Model
* @description Delete Model
*/
delete: operations['del_model'];
/**
* Update Model
* @description Update model contents with a new config. If the model name or base fields are changed, then the model is renamed.
*/
patch: operations['update_model'];
};
'/api/v1/models/import': {
/**
* Import Model
* @description Add a model using its local path, repo_id, or remote URL. Model characteristics will be probed and configured automatically
*/
post: operations['import_model'];
};
'/api/v1/models/add': {
/**
* Add Model
* @description Add a model using the configuration information appropriate for its type. Only local models can be added by path
*/
post: operations['add_model'];
};
'/api/v1/models/convert/{base_model}/{model_type}/{model_name}': {
/**
* Convert Model
* @description Convert a checkpoint model into a diffusers model, optionally saving to the indicated destination directory, or `models` if none.
*/
put: operations['convert_model'];
};
'/api/v1/models/search': {
/** Search For Models */
get: operations['search_for_models'];
};
'/api/v1/models/ckpt_confs': {
/**
* List Ckpt Configs
* @description Return a list of the legacy checkpoint configuration files stored in `ROOT/configs/stable-diffusion`, relative to ROOT.
*/
get: operations['list_ckpt_configs'];
};
'/api/v1/models/sync': {
/**
* Sync To Config
* @description Call after making changes to models.yaml, autoimport directories or models directory to synchronize
* in-memory data structures with disk data structures.
*/
post: operations['sync_to_config'];
};
'/api/v1/models/merge/{base_model}': {
/**
* Merge Models
* @description Convert a checkpoint model into a diffusers model
*/
put: operations['merge_models'];
};
'/api/v1/images/upload': {
/**
* Upload Image
* @description Uploads an image
*/
post: operations['upload_image'];
};
'/api/v1/images/i/{image_name}': {
/**
* Get Image Dto
* @description Gets an image's DTO
*/
get: operations['get_image_dto'];
/**
* Delete Image
* @description Deletes an image
*/
delete: operations['delete_image'];
/**
* Update Image
* @description Updates an image
*/
patch: operations['update_image'];
};
'/api/v1/images/clear-intermediates': {
/**
* Clear Intermediates
* @description Clears all intermediates
*/
post: operations['clear_intermediates'];
};
'/api/v1/images/i/{image_name}/metadata': {
/**
* Get Image Metadata
* @description Gets an image's metadata
*/
get: operations['get_image_metadata'];
};
'/api/v1/images/i/{image_name}/full': {
/**
* Get Image Full
* @description Gets a full-resolution image file
*/
get: operations['get_image_full'];
/**
* Get Image Full
* @description Gets a full-resolution image file
*/
head: operations['get_image_full'];
};
'/api/v1/images/i/{image_name}/thumbnail': {
/**
* Get Image Thumbnail
* @description Gets a thumbnail image file
*/
get: operations['get_image_thumbnail'];
};
'/api/v1/images/i/{image_name}/urls': {
/**
* Get Image Urls
* @description Gets an image and thumbnail URL
*/
get: operations['get_image_urls'];
};
'/api/v1/images/': {
/**
* List Image Dtos
* @description Gets a list of image DTOs
*/
get: operations['list_image_dtos'];
};
'/api/v1/images/delete': {
/** Delete Images From List */
post: operations['delete_images_from_list'];
};
'/api/v1/images/star': {
/** Star Images In List */
post: operations['star_images_in_list'];
};
'/api/v1/images/unstar': {
/** Unstar Images In List */
post: operations['unstar_images_in_list'];
};
'/api/v1/boards/': {
/**
* List Boards
* @description Gets a list of boards
*/
get: operations['list_boards'];
/**
* Create Board
* @description Creates a board
*/
post: operations['create_board'];
};
'/api/v1/boards/{board_id}': {
/**
* Get Board
* @description Gets a board
*/
get: operations['get_board'];
/**
* Delete Board
* @description Deletes a board
*/
delete: operations['delete_board'];
/**
* Update Board
* @description Updates a board
*/
patch: operations['update_board'];
};
'/api/v1/boards/{board_id}/image_names': {
/**
* List All Board Image Names
* @description Gets a list of images for a board
*/
get: operations['list_all_board_image_names'];
};
'/api/v1/board_images/': {
/**
* Add Image To Board
* @description Creates a board_image
*/
post: operations['add_image_to_board'];
/**
* Remove Image From Board
* @description Removes an image from its board, if it had one
*/
delete: operations['remove_image_from_board'];
};
'/api/v1/board_images/batch': {
/**
* Add Images To Board
* @description Adds a list of images to a board
*/
post: operations['add_images_to_board'];
};
'/api/v1/board_images/batch/delete': {
/**
* Remove Images From Board
* @description Removes a list of images from their board, if they had one
*/
post: operations['remove_images_from_board'];
};
'/api/v1/app/version': {
/** Get Version */
get: operations['app_version'];
};
'/api/v1/app/config': {
/** Get Config */
get: operations['get_config'];
};
'/api/v1/app/logging': {
/**
* Get Log Level
* @description Returns the log level
*/
get: operations['get_log_level'];
/**
* Set Log Level
* @description Sets the log verbosity level
*/
post: operations['set_log_level'];
};
};
export type webhooks = Record<string, never>;
export type components = {
schemas: {
/** AddImagesToBoardResult */
AddImagesToBoardResult: {
/**
* Board Id
* @description The id of the board the images were added to
*/
board_id: string;
/**
* Added Image Names
* @description The image names that were added to the board
*/
added_image_names: string[];
};
/**
* Add Integers
* @description Adds two numbers
*/
AddInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default add
* @enum {string}
*/
type: 'add';
/**
* A
* @description The first number
* @default 0
*/
a?: number;
/**
* B
* @description The second number
* @default 0
*/
b?: number;
};
/**
* AppConfig
* @description App Config Response
*/
AppConfig: {
/**
* Infill Methods
* @description List of available infill methods
*/
infill_methods: string[];
/**
* Upscaling Methods
* @description List of upscaling methods
*/
upscaling_methods: components['schemas']['Upscaler'][];
/**
* Nsfw Methods
* @description List of NSFW checking methods
*/
nsfw_methods: string[];
/**
* Watermarking Methods
* @description List of invisible watermark methods
*/
watermarking_methods: string[];
};
/**
* AppVersion
* @description App Version Response
*/
AppVersion: {
/**
* Version
* @description App version
*/
version: string;
};
/**
* BaseModelType
* @description An enumeration.
* @enum {string}
*/
BaseModelType: 'sd-1' | 'sd-2' | 'sdxl' | 'sdxl-refiner';
/** BoardChanges */
BoardChanges: {
/**
* Board Name
* @description The board's new name.
*/
board_name?: string;
/**
* Cover Image Name
* @description The name of the board's new cover image.
*/
cover_image_name?: string;
};
/**
* BoardDTO
* @description Deserialized board record with cover image URL and image count.
*/
BoardDTO: {
/**
* Board Id
* @description The unique ID of the board.
*/
board_id: string;
/**
* Board Name
* @description The name of the board.
*/
board_name: string;
/**
* Created At
* @description The created timestamp of the board.
*/
created_at: string;
/**
* Updated At
* @description The updated timestamp of the board.
*/
updated_at: string;
/**
* Deleted At
* @description The deleted timestamp of the board.
*/
deleted_at?: string;
/**
* Cover Image Name
* @description The name of the board's cover image.
*/
cover_image_name?: string;
/**
* Image Count
* @description The number of images in the board.
*/
image_count: number;
};
/** Body_add_image_to_board */
Body_add_image_to_board: {
/**
* Board Id
* @description The id of the board to add to
*/
board_id: string;
/**
* Image Name
* @description The name of the image to add
*/
image_name: string;
};
/** Body_add_images_to_board */
Body_add_images_to_board: {
/**
* Board Id
* @description The id of the board to add to
*/
board_id: string;
/**
* Image Names
* @description The names of the images to add
*/
image_names: string[];
};
/** Body_delete_images_from_list */
Body_delete_images_from_list: {
/**
* Image Names
* @description The list of names of images to delete
*/
image_names: string[];
};
/** Body_import_model */
Body_import_model: {
/**
* Location
* @description A model path, repo_id or URL to import
*/
location: string;
/**
* Prediction Type
* @description Prediction type for SDv2 checkpoint files
* @default v_prediction
* @enum {string}
*/
prediction_type?: 'v_prediction' | 'epsilon' | 'sample';
};
/** Body_merge_models */
Body_merge_models: {
/**
* Model Names
* @description model name
*/
model_names: string[];
/**
* Merged Model Name
* @description Name of destination model
*/
merged_model_name: string;
/**
* Alpha
* @description Alpha weighting strength to apply to 2d and 3d models
* @default 0.5
*/
alpha?: number;
/** @description Interpolation method */
interp: components['schemas']['MergeInterpolationMethod'];
/**
* Force
* @description Force merging of models created with different versions of diffusers
* @default false
*/
force?: boolean;
/**
* Merge Dest Directory
* @description Save the merged model to the designated directory (with 'merged_model_name' appended)
*/
merge_dest_directory?: string;
};
/** Body_remove_image_from_board */
Body_remove_image_from_board: {
/**
* Image Name
* @description The name of the image to remove
*/
image_name: string;
};
/** Body_remove_images_from_board */
Body_remove_images_from_board: {
/**
* Image Names
* @description The names of the images to remove
*/
image_names: string[];
};
/** Body_star_images_in_list */
Body_star_images_in_list: {
/**
* Image Names
* @description The list of names of images to star
*/
image_names: string[];
};
/** Body_unstar_images_in_list */
Body_unstar_images_in_list: {
/**
* Image Names
* @description The list of names of images to unstar
*/
image_names: string[];
};
/** Body_upload_image */
Body_upload_image: {
/**
* File
* Format: binary
*/
file: Blob;
};
/**
* Boolean Collection
* @description A collection of boolean primitive values
*/
BooleanCollectionInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default boolean_collection
* @enum {string}
*/
type: 'boolean_collection';
/**
* Collection
* @description The collection of boolean values
* @default false
*/
collection?: boolean[];
};
/**
* BooleanCollectionOutput
* @description Base class for nodes that output a collection of booleans
*/
BooleanCollectionOutput: {
/**
* Type
* @default boolean_collection_output
* @enum {string}
*/
type?: 'boolean_collection_output';
/**
* Collection
* @description The output boolean collection
*/
collection?: boolean[];
};
/**
* Boolean
* @description A boolean primitive value
*/
BooleanInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default boolean
* @enum {string}
*/
type: 'boolean';
/**
* A
* @description The boolean value
* @default false
*/
a?: boolean;
};
/**
* BooleanOutput
* @description Base class for nodes that output a single boolean
*/
BooleanOutput: {
/**
* Type
* @default boolean_output
* @enum {string}
*/
type?: 'boolean_output';
/**
* A
* @description The output boolean
*/
a: boolean;
};
/**
* Canny Processor
* @description Canny edge detection for ControlNet
*/
CannyImageProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default canny_image_processor
* @enum {string}
*/
type: 'canny_image_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
/**
* Low Threshold
* @description The low threshold of the Canny pixel gradient (0-255)
* @default 100
*/
low_threshold?: number;
/**
* High Threshold
* @description The high threshold of the Canny pixel gradient (0-255)
* @default 200
*/
high_threshold?: number;
};
/** ClipField */
ClipField: {
/**
* Tokenizer
* @description Info to load tokenizer submodel
*/
tokenizer: components['schemas']['ModelInfo'];
/**
* Text Encoder
* @description Info to load text_encoder submodel
*/
text_encoder: components['schemas']['ModelInfo'];
/**
* Skipped Layers
* @description Number of skipped layers in text_encoder
*/
skipped_layers: number;
/**
* Loras
* @description Loras to apply on model loading
*/
loras: components['schemas']['LoraInfo'][];
};
/**
* CLIP Skip
* @description Skip layers in clip text_encoder model.
*/
ClipSkipInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default clip_skip
* @enum {string}
*/
type: 'clip_skip';
/**
* CLIP
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip?: components['schemas']['ClipField'];
/**
* Skipped Layers
* @description Number of layers to skip in text encoder
* @default 0
*/
skipped_layers?: number;
};
/**
* ClipSkipInvocationOutput
* @description Clip skip node output
*/
ClipSkipInvocationOutput: {
/**
* Type
* @default clip_skip_output
* @enum {string}
*/
type?: 'clip_skip_output';
/**
* CLIP
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip?: components['schemas']['ClipField'];
};
/**
* CollectInvocation
* @description Collects values into a collection
*/
CollectInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default collect
* @enum {string}
*/
type: 'collect';
/**
* Collection Item
* @description The item to collect (all inputs must be of the same type)
*/
item?: unknown;
/**
* Collection
* @description The collection, will be provided on execution
*/
collection?: unknown[];
};
/**
* CollectInvocationOutput
* @description Base class for all invocation outputs
*/
CollectInvocationOutput: {
/**
* Type
* @default collect_output
* @enum {string}
*/
type?: 'collect_output';
/**
* Collection
* @description The collection of input items
*/
collection: unknown[];
};
/**
* ColorCollectionOutput
* @description Base class for nodes that output a collection of colors
*/
ColorCollectionOutput: {
/**
* Type
* @default color_collection_output
* @enum {string}
*/
type?: 'color_collection_output';
/**
* Collection
* @description The output colors
*/
collection?: components['schemas']['ColorField'][];
};
/**
* Color Correct
* @description Shifts the colors of a target image to match the reference image, optionally
* using a mask to only color-correct certain regions of the target image.
*/
ColorCorrectInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default color_correct
* @enum {string}
*/
type: 'color_correct';
/**
* Image
* @description The image to color-correct
*/
image?: components['schemas']['ImageField'];
/**
* Reference
* @description Reference image for color-correction
*/
reference?: components['schemas']['ImageField'];
/**
* Mask
* @description Mask to use when applying color-correction
*/
mask?: components['schemas']['ImageField'];
/**
* Mask Blur Radius
* @description Mask blur radius
* @default 8
*/
mask_blur_radius?: number;
};
/**
* ColorField
* @description A color primitive field
*/
ColorField: {
/**
* R
* @description The red component
*/
r: number;
/**
* G
* @description The green component
*/
g: number;
/**
* B
* @description The blue component
*/
b: number;
/**
* A
* @description The alpha component
*/
a: number;
};
/**
* Color Primitive
* @description A color primitive value
*/
ColorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default color
* @enum {string}
*/
type: 'color';
/**
* Color
* @description The color value
* @default {
* "r": 0,
* "g": 0,
* "b": 0,
* "a": 255
* }
*/
color?: components['schemas']['ColorField'];
};
/**
* ColorOutput
* @description Base class for nodes that output a single color
*/
ColorOutput: {
/**
* Type
* @default color_output
* @enum {string}
*/
type?: 'color_output';
/**
* Color
* @description The output color
*/
color: components['schemas']['ColorField'];
};
/**
* Compel Prompt
* @description Parse prompt using compel package to conditioning.
*/
CompelInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default compel
* @enum {string}
*/
type: 'compel';
/**
* Prompt
* @description Prompt to be parsed by Compel to create a conditioning tensor
* @default
*/
prompt?: string;
/**
* CLIP
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip?: components['schemas']['ClipField'];
};
/**
* Conditioning Collection
* @description A collection of conditioning tensor primitive values
*/
ConditioningCollectionInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default conditioning_collection
* @enum {string}
*/
type: 'conditioning_collection';
/**
* Collection
* @description The collection of conditioning tensors
* @default 0
*/
collection?: components['schemas']['ConditioningField'][];
};
/**
* ConditioningCollectionOutput
* @description Base class for nodes that output a collection of conditioning tensors
*/
ConditioningCollectionOutput: {
/**
* Type
* @default conditioning_collection_output
* @enum {string}
*/
type?: 'conditioning_collection_output';
/**
* Collection
* @description The output conditioning tensors
*/
collection?: components['schemas']['ConditioningField'][];
};
/**
* ConditioningField
* @description A conditioning tensor primitive value
*/
ConditioningField: {
/**
* Conditioning Name
* @description The name of conditioning tensor
*/
conditioning_name: string;
};
/**
* Conditioning Primitive
* @description A conditioning tensor primitive value
*/
ConditioningInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default conditioning
* @enum {string}
*/
type: 'conditioning';
/**
* Conditioning
* @description Conditioning tensor
*/
conditioning?: components['schemas']['ConditioningField'];
};
/**
* ConditioningOutput
* @description Base class for nodes that output a single conditioning tensor
*/
ConditioningOutput: {
/**
* Type
* @default conditioning_output
* @enum {string}
*/
type?: 'conditioning_output';
/**
* Conditioning
* @description Conditioning tensor
*/
conditioning: components['schemas']['ConditioningField'];
};
/**
* Content Shuffle Processor
* @description Applies content shuffle processing to image
*/
ContentShuffleImageProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default content_shuffle_image_processor
* @enum {string}
*/
type: 'content_shuffle_image_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
/**
* Detect Resolution
* @description Pixel resolution for detection
* @default 512
*/
detect_resolution?: number;
/**
* Image Resolution
* @description Pixel resolution for output image
* @default 512
*/
image_resolution?: number;
/**
* H
* @description Content shuffle `h` parameter
* @default 512
*/
h?: number;
/**
* W
* @description Content shuffle `w` parameter
* @default 512
*/
w?: number;
/**
* F
* @description Content shuffle `f` parameter
* @default 256
*/
f?: number;
};
/** ControlField */
ControlField: {
/**
* Image
* @description The control image
*/
image: components['schemas']['ImageField'];
/**
* Control Model
* @description The ControlNet model to use
*/
control_model: components['schemas']['ControlNetModelField'];
/**
* Control Weight
* @description The weight given to the ControlNet
* @default 1
*/
control_weight?: number | number[];
/**
* Begin Step Percent
* @description When the ControlNet is first applied (% of total steps)
* @default 0
*/
begin_step_percent?: number;
/**
* End Step Percent
* @description When the ControlNet is last applied (% of total steps)
* @default 1
*/
end_step_percent?: number;
/**
* Control Mode
* @description The control mode to use
* @default balanced
* @enum {string}
*/
control_mode?: 'balanced' | 'more_prompt' | 'more_control' | 'unbalanced';
/**
* Resize Mode
* @description The resize mode to use
* @default just_resize
* @enum {string}
*/
resize_mode?:
| 'just_resize'
| 'crop_resize'
| 'fill_resize'
| 'just_resize_simple';
};
/**
* ControlNet
* @description Collects ControlNet info to pass to other nodes
*/
ControlNetInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default controlnet
* @enum {string}
*/
type: 'controlnet';
/**
* Image
* @description The control image
*/
image?: components['schemas']['ImageField'];
/**
* Control Model
* @description ControlNet model to load
* @default lllyasviel/sd-controlnet-canny
*/
control_model?: components['schemas']['ControlNetModelField'];
/**
* Control Weight
* @description The weight given to the ControlNet
* @default 1
*/
control_weight?: number | number[];
/**
* Begin Step Percent
* @description When the ControlNet is first applied (% of total steps)
* @default 0
*/
begin_step_percent?: number;
/**
* End Step Percent
* @description When the ControlNet is last applied (% of total steps)
* @default 1
*/
end_step_percent?: number;
/**
* Control Mode
* @description The control mode used
* @default balanced
* @enum {string}
*/
control_mode?: 'balanced' | 'more_prompt' | 'more_control' | 'unbalanced';
/**
* Resize Mode
* @description The resize mode used
* @default just_resize
* @enum {string}
*/
resize_mode?:
| 'just_resize'
| 'crop_resize'
| 'fill_resize'
| 'just_resize_simple';
};
/** ControlNetModelCheckpointConfig */
ControlNetModelCheckpointConfig: {
/** Model Name */
model_name: string;
base_model: components['schemas']['BaseModelType'];
/**
* Model Type
* @enum {string}
*/
model_type: 'controlnet';
/** Path */
path: string;
/** Description */
description?: string;
/**
* Model Format
* @enum {string}
*/
model_format: 'checkpoint';
error?: components['schemas']['ModelError'];
/** Config */
config: string;
};
/** ControlNetModelDiffusersConfig */
ControlNetModelDiffusersConfig: {
/** Model Name */
model_name: string;
base_model: components['schemas']['BaseModelType'];
/**
* Model Type
* @enum {string}
*/
model_type: 'controlnet';
/** Path */
path: string;
/** Description */
description?: string;
/**
* Model Format
* @enum {string}
*/
model_format: 'diffusers';
error?: components['schemas']['ModelError'];
};
/**
* ControlNetModelField
* @description ControlNet model field
*/
ControlNetModelField: {
/**
* Model Name
* @description Name of the ControlNet model
*/
model_name: string;
/** @description Base model */
base_model: components['schemas']['BaseModelType'];
};
/**
* ControlOutput
* @description node output for ControlNet info
*/
ControlOutput: {
/**
* Type
* @default control_output
* @enum {string}
*/
type?: 'control_output';
/**
* Control
* @description ControlNet(s) to apply
*/
control: components['schemas']['ControlField'];
};
/**
* CoreMetadata
* @description Core generation metadata for an image generated in InvokeAI.
*/
CoreMetadata: {
/**
* App Version
* @description The version of InvokeAI used to generate this image
* @default 3.0.2post1
*/
app_version?: string;
/**
* Generation Mode
* @description The generation mode that output this image
*/
generation_mode: string;
/**
* Positive Prompt
* @description The positive prompt parameter
*/
positive_prompt: string;
/**
* Negative Prompt
* @description The negative prompt parameter
*/
negative_prompt: string;
/**
* Width
* @description The width parameter
*/
width: number;
/**
* Height
* @description The height parameter
*/
height: number;
/**
* Seed
* @description The seed used for noise generation
*/
seed: number;
/**
* Rand Device
* @description The device used for random number generation
*/
rand_device: string;
/**
* Cfg Scale
* @description The classifier-free guidance scale parameter
*/
cfg_scale: number;
/**
* Steps
* @description The number of steps used for inference
*/
steps: number;
/**
* Scheduler
* @description The scheduler used for inference
*/
scheduler: string;
/**
* Clip Skip
* @description The number of skipped CLIP layers
*/
clip_skip: number;
/**
* Model
* @description The main model used for inference
*/
model: components['schemas']['MainModelField'];
/**
* Controlnets
* @description The ControlNets used for inference
*/
controlnets: components['schemas']['ControlField'][];
/**
* Loras
* @description The LoRAs used for inference
*/
loras: components['schemas']['LoRAMetadataField'][];
/**
* Vae
* @description The VAE used for decoding, if the main model's default was not used
*/
vae?: components['schemas']['VAEModelField'];
/**
* Strength
* @description The strength used for latents-to-latents
*/
strength?: number;
/**
* Init Image
* @description The name of the initial image
*/
init_image?: string;
/**
* Positive Style Prompt
* @description The positive style prompt parameter
*/
positive_style_prompt?: string;
/**
* Negative Style Prompt
* @description The negative style prompt parameter
*/
negative_style_prompt?: string;
/**
* Refiner Model
* @description The SDXL Refiner model used
*/
refiner_model?: components['schemas']['MainModelField'];
/**
* Refiner Cfg Scale
* @description The classifier-free guidance scale parameter used for the refiner
*/
refiner_cfg_scale?: number;
/**
* Refiner Steps
* @description The number of steps used for the refiner
*/
refiner_steps?: number;
/**
* Refiner Scheduler
* @description The scheduler used for the refiner
*/
refiner_scheduler?: string;
/**
* Refiner Positive Aesthetic Store
* @description The aesthetic score used for the refiner
*/
refiner_positive_aesthetic_store?: number;
/**
* Refiner Negative Aesthetic Store
* @description The aesthetic score used for the refiner
*/
refiner_negative_aesthetic_store?: number;
/**
* Refiner Start
* @description The start value used for refiner denoising
*/
refiner_start?: number;
};
/**
* OpenCV Inpaint
* @description Simple inpaint using opencv.
*/
CvInpaintInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default cv_inpaint
* @enum {string}
*/
type: 'cv_inpaint';
/**
* Image
* @description The image to inpaint
*/
image?: components['schemas']['ImageField'];
/**
* Mask
* @description The mask to use when inpainting
*/
mask?: components['schemas']['ImageField'];
};
/** DeleteBoardResult */
DeleteBoardResult: {
/**
* Board Id
* @description The id of the board that was deleted.
*/
board_id: string;
/**
* Deleted Board Images
* @description The image names of the board-images relationships that were deleted.
*/
deleted_board_images: string[];
/**
* Deleted Images
* @description The names of the images that were deleted.
*/
deleted_images: string[];
};
/** DeleteImagesFromListResult */
DeleteImagesFromListResult: {
/** Deleted Images */
deleted_images: string[];
};
/**
* Denoise Latents
* @description Denoises noisy latents to decodable images
*/
DenoiseLatentsInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default denoise_latents
* @enum {string}
*/
type: 'denoise_latents';
/**
* Noise
* @description Noise tensor
*/
noise?: components['schemas']['LatentsField'];
/**
* Steps
* @description Number of steps to run
* @default 10
*/
steps?: number;
/**
* Cfg Scale
* @description Classifier-Free Guidance scale
* @default 7.5
*/
cfg_scale?: number | number[];
/**
* Denoising Start
* @description When to start denoising, expressed a percentage of total steps
* @default 0
*/
denoising_start?: number;
/**
* Denoising End
* @description When to stop denoising, expressed a percentage of total steps
* @default 1
*/
denoising_end?: number;
/**
* Scheduler
* @description Scheduler to use during inference
* @default euler
* @enum {string}
*/
scheduler?:
| 'ddim'
| 'ddpm'
| 'deis'
| 'lms'
| 'lms_k'
| 'pndm'
| 'heun'
| 'heun_k'
| 'euler'
| 'euler_k'
| 'euler_a'
| 'kdpm_2'
| 'kdpm_2_a'
| 'dpmpp_2s'
| 'dpmpp_2s_k'
| 'dpmpp_2m'
| 'dpmpp_2m_k'
| 'dpmpp_2m_sde'
| 'dpmpp_2m_sde_k'
| 'dpmpp_sde'
| 'dpmpp_sde_k'
| 'unipc';
/**
* Control
* @description ControlNet(s) to apply
*/
control?:
| components['schemas']['ControlField']
| components['schemas']['ControlField'][];
/**
* Latents
* @description Latents tensor
*/
latents?: components['schemas']['LatentsField'];
/**
* Mask
* @description The mask to use for the operation
*/
mask?: components['schemas']['ImageField'];
/**
* Positive Conditioning
* @description Positive conditioning tensor
*/
positive_conditioning?: components['schemas']['ConditioningField'];
/**
* Negative Conditioning
* @description Negative conditioning tensor
*/
negative_conditioning?: components['schemas']['ConditioningField'];
/**
* Unet
* @description UNet (scheduler, LoRAs)
*/
unet?: components['schemas']['UNetField'];
};
/**
* Divide Integers
* @description Divides two numbers
*/
DivideInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default div
* @enum {string}
*/
type: 'div';
/**
* A
* @description The first number
* @default 0
*/
a?: number;
/**
* B
* @description The second number
* @default 0
*/
b?: number;
};
/**
* Dynamic Prompt
* @description Parses a prompt using adieyal/dynamicprompts' random or combinatorial generator
*/
DynamicPromptInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default dynamic_prompt
* @enum {string}
*/
type: 'dynamic_prompt';
/**
* Prompt
* @description The prompt to parse with dynamicprompts
*/
prompt?: string;
/**
* Max Prompts
* @description The number of prompts to generate
* @default 1
*/
max_prompts?: number;
/**
* Combinatorial
* @description Whether to use the combinatorial generator
* @default false
*/
combinatorial?: boolean;
};
/**
* Upscale (RealESRGAN)
* @description Upscales an image using RealESRGAN.
*/
ESRGANInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default esrgan
* @enum {string}
*/
type: 'esrgan';
/**
* Image
* @description The input image
*/
image?: components['schemas']['ImageField'];
/**
* Model Name
* @description The Real-ESRGAN model to use
* @default RealESRGAN_x4plus.pth
* @enum {string}
*/
model_name?:
| 'RealESRGAN_x4plus.pth'
| 'RealESRGAN_x4plus_anime_6B.pth'
| 'ESRGAN_SRx4_DF2KOST_official-ff704c30.pth'
| 'RealESRGAN_x2plus.pth';
};
/** Edge */
Edge: {
/**
* Source
* @description The connection for the edge's from node and field
*/
source: components['schemas']['EdgeConnection'];
/**
* Destination
* @description The connection for the edge's to node and field
*/
destination: components['schemas']['EdgeConnection'];
};
/** EdgeConnection */
EdgeConnection: {
/**
* Node Id
* @description The id of the node for this edge connection
*/
node_id: string;
/**
* Field
* @description The field for this connection
*/
field: string;
};
/**
* Float Collection
* @description A collection of float primitive values
*/
FloatCollectionInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default float_collection
* @enum {string}
*/
type: 'float_collection';
/**
* Collection
* @description The collection of float values
* @default 0
*/
collection?: number[];
};
/**
* FloatCollectionOutput
* @description Base class for nodes that output a collection of floats
*/
FloatCollectionOutput: {
/**
* Type
* @default float_collection_output
* @enum {string}
*/
type?: 'float_collection_output';
/**
* Collection
* @description The float collection
*/
collection?: number[];
};
/**
* Float
* @description A float primitive value
*/
FloatInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default float
* @enum {string}
*/
type: 'float';
/**
* Param
* @description The float value
* @default 0
*/
param?: number;
};
/**
* Float Range
* @description Creates a range
*/
FloatLinearRangeInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default float_range
* @enum {string}
*/
type: 'float_range';
/**
* Start
* @description The first value of the range
* @default 5
*/
start?: number;
/**
* Stop
* @description The last value of the range
* @default 10
*/
stop?: number;
/**
* Steps
* @description number of values to interpolate over (including start and stop)
* @default 30
*/
steps?: number;
};
/**
* FloatOutput
* @description Base class for nodes that output a single float
*/
FloatOutput: {
/**
* Type
* @default float_output
* @enum {string}
*/
type?: 'float_output';
/**
* A
* @description The output float
*/
a: number;
};
/** Graph */
Graph: {
/**
* Id
* @description The id of this graph
*/
id?: string;
/**
* Nodes
* @description The nodes in this graph
*/
nodes?: {
[key: string]:
| (
| components['schemas']['ControlNetInvocation']
| components['schemas']['ImageProcessorInvocation']
| components['schemas']['MainModelLoaderInvocation']
| components['schemas']['LoraLoaderInvocation']
| components['schemas']['SDXLLoraLoaderInvocation']
| components['schemas']['VaeLoaderInvocation']
| components['schemas']['MetadataAccumulatorInvocation']
| components['schemas']['RangeInvocation']
| components['schemas']['RangeOfSizeInvocation']
| components['schemas']['RandomRangeInvocation']
| components['schemas']['ImageCollectionInvocation']
| components['schemas']['CompelInvocation']
| components['schemas']['SDXLCompelPromptInvocation']
| components['schemas']['SDXLRefinerCompelPromptInvocation']
| components['schemas']['ClipSkipInvocation']
| components['schemas']['LoadImageInvocation']
| components['schemas']['ShowImageInvocation']
| components['schemas']['ImageCropInvocation']
| components['schemas']['ImagePasteInvocation']
| components['schemas']['MaskFromAlphaInvocation']
| components['schemas']['ImageMultiplyInvocation']
| components['schemas']['ImageChannelInvocation']
| components['schemas']['ImageConvertInvocation']
| components['schemas']['ImageBlurInvocation']
| components['schemas']['ImageResizeInvocation']
| components['schemas']['ImageScaleInvocation']
| components['schemas']['ImageLerpInvocation']
| components['schemas']['ImageInverseLerpInvocation']
| components['schemas']['ImageNSFWBlurInvocation']
| components['schemas']['ImageWatermarkInvocation']
| components['schemas']['MaskEdgeInvocation']
| components['schemas']['MaskCombineInvocation']
| components['schemas']['ColorCorrectInvocation']
| components['schemas']['ImageHueAdjustmentInvocation']
| components['schemas']['ImageLuminosityAdjustmentInvocation']
| components['schemas']['ImageSaturationAdjustmentInvocation']
| components['schemas']['CvInpaintInvocation']
| components['schemas']['InfillColorInvocation']
| components['schemas']['InfillTileInvocation']
| components['schemas']['InfillPatchMatchInvocation']
| components['schemas']['DenoiseLatentsInvocation']
| components['schemas']['LatentsToImageInvocation']
| components['schemas']['ResizeLatentsInvocation']
| components['schemas']['ScaleLatentsInvocation']
| components['schemas']['ImageToLatentsInvocation']
| components['schemas']['AddInvocation']
| components['schemas']['SubtractInvocation']
| components['schemas']['MultiplyInvocation']
| components['schemas']['DivideInvocation']
| components['schemas']['RandomIntInvocation']
| components['schemas']['NoiseInvocation']
| components['schemas']['ONNXPromptInvocation']
| components['schemas']['ONNXTextToLatentsInvocation']
| components['schemas']['ONNXLatentsToImageInvocation']
| components['schemas']['ONNXSD1ModelLoaderInvocation']
| components['schemas']['OnnxModelLoaderInvocation']
| components['schemas']['DynamicPromptInvocation']
| components['schemas']['PromptsFromFileInvocation']
| components['schemas']['ParamIntInvocation']
| components['schemas']['ParamFloatInvocation']
| components['schemas']['ParamStringInvocation']
| components['schemas']['ParamPromptInvocation']
| components['schemas']['FloatLinearRangeInvocation']
| components['schemas']['StepParamEasingInvocation']
| components['schemas']['SDXLModelLoaderInvocation']
| components['schemas']['SDXLRefinerModelLoaderInvocation']
| components['schemas']['ESRGANInvocation']
| components['schemas']['GraphInvocation']
| components['schemas']['IterateInvocation']
| components['schemas']['CollectInvocation']
| components['schemas']['CannyImageProcessorInvocation']
| components['schemas']['HedImageProcessorInvocation']
| components['schemas']['LineartImageProcessorInvocation']
| components['schemas']['LineartAnimeImageProcessorInvocation']
| components['schemas']['OpenposeImageProcessorInvocation']
| components['schemas']['MidasDepthImageProcessorInvocation']
| components['schemas']['NormalbaeImageProcessorInvocation']
| components['schemas']['MlsdImageProcessorInvocation']
| components['schemas']['PidiImageProcessorInvocation']
| components['schemas']['ContentShuffleImageProcessorInvocation']
| components['schemas']['ZoeDepthImageProcessorInvocation']
| components['schemas']['MediapipeFaceProcessorInvocation']
| components['schemas']['LeresImageProcessorInvocation']
| components['schemas']['TileResamplerProcessorInvocation']
| components['schemas']['SegmentAnythingProcessorInvocation']
)
| undefined;
};
/**
* Edges
* @description The connections between nodes and their fields in this graph
*/
edges?: components['schemas']['Edge'][];
};
/**
* GraphExecutionState
* @description Tracks the state of a graph execution
*/
GraphExecutionState: {
/**
* Id
* @description The id of the execution state
*/
id: string;
/**
* Graph
* @description The graph being executed
*/
graph: components['schemas']['Graph'];
/**
* Execution Graph
* @description The expanded graph of activated and executed nodes
*/
execution_graph: components['schemas']['Graph'];
/**
* Executed
* @description The set of node ids that have been executed
*/
executed: string[];
/**
* Executed History
* @description The list of node ids that have been executed, in order of execution
*/
executed_history: string[];
/**
* Results
* @description The results of node executions
*/
results: {
[key: string]:
| (
| components['schemas']['BooleanOutput']
| components['schemas']['BooleanCollectionOutput']
| components['schemas']['IntegerOutput']
| components['schemas']['IntegerCollectionOutput']
| components['schemas']['FloatOutput']
| components['schemas']['FloatCollectionOutput']
| components['schemas']['StringOutput']
| components['schemas']['StringCollectionOutput']
| components['schemas']['ImageOutput']
| components['schemas']['ImageCollectionOutput']
| components['schemas']['LatentsOutput']
| components['schemas']['LatentsCollectionOutput']
| components['schemas']['ColorOutput']
| components['schemas']['ColorCollectionOutput']
| components['schemas']['ConditioningOutput']
| components['schemas']['ConditioningCollectionOutput']
| components['schemas']['ControlOutput']
| components['schemas']['ModelLoaderOutput']
| components['schemas']['LoraLoaderOutput']
| components['schemas']['SDXLLoraLoaderOutput']
| components['schemas']['VaeLoaderOutput']
| components['schemas']['MetadataAccumulatorOutput']
| components['schemas']['SDXLModelLoaderOutput']
| components['schemas']['SDXLRefinerModelLoaderOutput']
| components['schemas']['ClipSkipInvocationOutput']
| components['schemas']['ONNXModelLoaderOutput']
| components['schemas']['NoiseOutput']
| components['schemas']['GraphInvocationOutput']
| components['schemas']['IterateInvocationOutput']
| components['schemas']['CollectInvocationOutput']
)
| undefined;
};
/**
* Errors
* @description Errors raised when executing nodes
*/
errors: {
[key: string]: string | undefined;
};
/**
* Prepared Source Mapping
* @description The map of prepared nodes to original graph nodes
*/
prepared_source_mapping: {
[key: string]: string | undefined;
};
/**
* Source Prepared Mapping
* @description The map of original graph nodes to prepared nodes
*/
source_prepared_mapping: {
[key: string]: string[] | undefined;
};
};
/**
* GraphInvocation
* @description Execute a graph
*/
GraphInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default graph
* @enum {string}
*/
type: 'graph';
/**
* Graph
* @description The graph to run
*/
graph?: components['schemas']['Graph'];
};
/**
* GraphInvocationOutput
* @description Base class for all invocation outputs
*/
GraphInvocationOutput: {
/**
* Type
* @default graph_output
* @enum {string}
*/
type: 'graph_output';
};
/** HTTPValidationError */
HTTPValidationError: {
/** Detail */
detail?: components['schemas']['ValidationError'][];
};
/**
* HED (softedge) Processor
* @description Applies HED edge detection to image
*/
HedImageProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default hed_image_processor
* @enum {string}
*/
type: 'hed_image_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
/**
* Detect Resolution
* @description Pixel resolution for detection
* @default 512
*/
detect_resolution?: number;
/**
* Image Resolution
* @description Pixel resolution for output image
* @default 512
*/
image_resolution?: number;
/**
* Scribble
* @description Whether or not to use scribble mode
* @default false
*/
scribble?: boolean;
};
/**
* Blur Image
* @description Blurs an image
*/
ImageBlurInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_blur
* @enum {string}
*/
type: 'img_blur';
/**
* Image
* @description The image to blur
*/
image?: components['schemas']['ImageField'];
/**
* Radius
* @description The blur radius
* @default 8
*/
radius?: number;
/**
* Blur Type
* @description The type of blur
* @default gaussian
* @enum {string}
*/
blur_type?: 'gaussian' | 'box';
};
/**
* ImageCategory
* @description The category of an image.
*
* - GENERAL: The image is an output, init image, or otherwise an image without a specialized purpose.
* - MASK: The image is a mask image.
* - CONTROL: The image is a ControlNet control image.
* - USER: The image is a user-provide image.
* - OTHER: The image is some other type of image with a specialized purpose. To be used by external nodes.
* @enum {string}
*/
ImageCategory: 'general' | 'mask' | 'control' | 'user' | 'other';
/**
* Extract Image Channel
* @description Gets a channel from an image.
*/
ImageChannelInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_chan
* @enum {string}
*/
type: 'img_chan';
/**
* Image
* @description The image to get the channel from
*/
image?: components['schemas']['ImageField'];
/**
* Channel
* @description The channel to get
* @default A
* @enum {string}
*/
channel?: 'A' | 'R' | 'G' | 'B';
};
/**
* Image Collection
* @description A collection of image primitive values
*/
ImageCollectionInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default image_collection
* @enum {string}
*/
type: 'image_collection';
/**
* Collection
* @description The collection of image values
* @default 0
*/
collection?: components['schemas']['ImageField'][];
};
/**
* ImageCollectionOutput
* @description Base class for nodes that output a collection of images
*/
ImageCollectionOutput: {
/**
* Type
* @default image_collection_output
* @enum {string}
*/
type?: 'image_collection_output';
/**
* Collection
* @description The output images
*/
collection?: components['schemas']['ImageField'][];
};
/**
* Convert Image Mode
* @description Converts an image to a different mode.
*/
ImageConvertInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_conv
* @enum {string}
*/
type: 'img_conv';
/**
* Image
* @description The image to convert
*/
image?: components['schemas']['ImageField'];
/**
* Mode
* @description The mode to convert to
* @default L
* @enum {string}
*/
mode?:
| 'L'
| 'RGB'
| 'RGBA'
| 'CMYK'
| 'YCbCr'
| 'LAB'
| 'HSV'
| 'I'
| 'F';
};
/**
* Crop Image
* @description Crops an image to a specified box. The box can be outside of the image.
*/
ImageCropInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_crop
* @enum {string}
*/
type: 'img_crop';
/**
* Image
* @description The image to crop
*/
image?: components['schemas']['ImageField'];
/**
* X
* @description The left x coordinate of the crop rectangle
* @default 0
*/
x?: number;
/**
* Y
* @description The top y coordinate of the crop rectangle
* @default 0
*/
y?: number;
/**
* Width
* @description The width of the crop rectangle
* @default 512
*/
width?: number;
/**
* Height
* @description The height of the crop rectangle
* @default 512
*/
height?: number;
};
/**
* ImageDTO
* @description Deserialized image record, enriched for the frontend.
*/
ImageDTO: {
/**
* Image Name
* @description The unique name of the image.
*/
image_name: string;
/**
* Image Url
* @description The URL of the image.
*/
image_url: string;
/**
* Thumbnail Url
* @description The URL of the image's thumbnail.
*/
thumbnail_url: string;
/** @description The type of the image. */
image_origin: components['schemas']['ResourceOrigin'];
/** @description The category of the image. */
image_category: components['schemas']['ImageCategory'];
/**
* Width
* @description The width of the image in px.
*/
width: number;
/**
* Height
* @description The height of the image in px.
*/
height: number;
/**
* Created At
* @description The created timestamp of the image.
*/
created_at: string;
/**
* Updated At
* @description The updated timestamp of the image.
*/
updated_at: string;
/**
* Deleted At
* @description The deleted timestamp of the image.
*/
deleted_at?: string;
/**
* Is Intermediate
* @description Whether this is an intermediate image.
*/
is_intermediate: boolean;
/**
* Session Id
* @description The session ID that generated this image, if it is a generated image.
*/
session_id?: string;
/**
* Node Id
* @description The node ID that generated this image, if it is a generated image.
*/
node_id?: string;
/**
* Starred
* @description Whether this image is starred.
*/
starred: boolean;
/**
* Board Id
* @description The id of the board the image belongs to, if one exists.
*/
board_id?: string;
};
/**
* ImageField
* @description An image primitive field
*/
ImageField: {
/**
* Image Name
* @description The name of the image
*/
image_name: string;
};
/**
* Image Hue Adjustment
* @description Adjusts the Hue of an image.
*/
ImageHueAdjustmentInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_hue_adjust
* @enum {string}
*/
type: 'img_hue_adjust';
/**
* Image
* @description The image to adjust
*/
image?: components['schemas']['ImageField'];
/**
* Hue
* @description The degrees by which to rotate the hue, 0-360
* @default 0
*/
hue?: number;
};
/**
* Inverse Lerp Image
* @description Inverse linear interpolation of all pixels of an image
*/
ImageInverseLerpInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_ilerp
* @enum {string}
*/
type: 'img_ilerp';
/**
* Image
* @description The image to lerp
*/
image?: components['schemas']['ImageField'];
/**
* Min
* @description The minimum input value
* @default 0
*/
min?: number;
/**
* Max
* @description The maximum input value
* @default 255
*/
max?: number;
};
/**
* Image Primitive
* @description An image primitive value
*/
ImageInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default image
* @enum {string}
*/
type: 'image';
/**
* Image
* @description The image to load
*/
image?: components['schemas']['ImageField'];
};
/**
* Lerp Image
* @description Linear interpolation of all pixels of an image
*/
ImageLerpInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_lerp
* @enum {string}
*/
type: 'img_lerp';
/**
* Image
* @description The image to lerp
*/
image?: components['schemas']['ImageField'];
/**
* Min
* @description The minimum output value
* @default 0
*/
min?: number;
/**
* Max
* @description The maximum output value
* @default 255
*/
max?: number;
};
/**
* Image Luminosity Adjustment
* @description Adjusts the Luminosity (Value) of an image.
*/
ImageLuminosityAdjustmentInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_luminosity_adjust
* @enum {string}
*/
type: 'img_luminosity_adjust';
/**
* Image
* @description The image to adjust
*/
image?: components['schemas']['ImageField'];
/**
* Luminosity
* @description The factor by which to adjust the luminosity (value)
* @default 1
*/
luminosity?: number;
};
/**
* ImageMetadata
* @description An image's generation metadata
*/
ImageMetadata: {
/**
* Metadata
* @description The image's core metadata, if it was created in the Linear or Canvas UI
*/
metadata?: Record<string, never>;
/**
* Graph
* @description The graph that created the image
*/
graph?: Record<string, never>;
};
/**
* Multiply Images
* @description Multiplies two images together using `PIL.ImageChops.multiply()`.
*/
ImageMultiplyInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_mul
* @enum {string}
*/
type: 'img_mul';
/**
* Image1
* @description The first image to multiply
*/
image1?: components['schemas']['ImageField'];
/**
* Image2
* @description The second image to multiply
*/
image2?: components['schemas']['ImageField'];
};
/**
* Blur NSFW Image
* @description Add blur to NSFW-flagged images
*/
ImageNSFWBlurInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_nsfw
* @enum {string}
*/
type: 'img_nsfw';
/**
* Metadata
* @description Optional core metadata to be written to image
*/
metadata?: components['schemas']['CoreMetadata'];
/**
* Image
* @description The image to check
*/
image?: components['schemas']['ImageField'];
};
/**
* ImageOutput
* @description Base class for nodes that output a single image
*/
ImageOutput: {
/**
* Type
* @default image_output
* @enum {string}
*/
type?: 'image_output';
/**
* Image
* @description The output image
*/
image: components['schemas']['ImageField'];
/**
* Width
* @description The width of the image in pixels
*/
width: number;
/**
* Height
* @description The height of the image in pixels
*/
height: number;
};
/**
* Paste Image
* @description Pastes an image into another image.
*/
ImagePasteInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_paste
* @enum {string}
*/
type: 'img_paste';
/**
* Base Image
* @description The base image
*/
base_image?: components['schemas']['ImageField'];
/**
* Image
* @description The image to paste
*/
image?: components['schemas']['ImageField'];
/**
* Mask
* @description The mask to use when pasting
*/
mask?: components['schemas']['ImageField'];
/**
* X
* @description The left x coordinate at which to paste the image
* @default 0
*/
x?: number;
/**
* Y
* @description The top y coordinate at which to paste the image
* @default 0
*/
y?: number;
};
/**
* ImageProcessorInvocation
* @description Base class for invocations that preprocess images for ControlNet
*/
ImageProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default image_processor
* @enum {string}
*/
type: 'image_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
};
/**
* ImageRecordChanges
* @description A set of changes to apply to an image record.
*
* Only limited changes are valid:
* - `image_category`: change the category of an image
* - `session_id`: change the session associated with an image
* - `is_intermediate`: change the image's `is_intermediate` flag
* - `starred`: change whether the image is starred
*/
ImageRecordChanges: {
/** @description The image's new category. */
image_category?: components['schemas']['ImageCategory'];
/**
* Session Id
* @description The image's new session ID.
*/
session_id?: string;
/**
* Is Intermediate
* @description The image's new `is_intermediate` flag.
*/
is_intermediate?: boolean;
/**
* Starred
* @description The image's new `starred` state
*/
starred?: boolean;
};
/**
* Resize Image
* @description Resizes an image to specific dimensions
*/
ImageResizeInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_resize
* @enum {string}
*/
type: 'img_resize';
/**
* Image
* @description The image to resize
*/
image?: components['schemas']['ImageField'];
/**
* Width
* @description The width to resize to (px)
* @default 512
*/
width?: number;
/**
* Height
* @description The height to resize to (px)
* @default 512
*/
height?: number;
/**
* Resample Mode
* @description The resampling mode
* @default bicubic
* @enum {string}
*/
resample_mode?:
| 'nearest'
| 'box'
| 'bilinear'
| 'hamming'
| 'bicubic'
| 'lanczos';
};
/**
* Image Saturation Adjustment
* @description Adjusts the Saturation of an image.
*/
ImageSaturationAdjustmentInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_saturation_adjust
* @enum {string}
*/
type: 'img_saturation_adjust';
/**
* Image
* @description The image to adjust
*/
image?: components['schemas']['ImageField'];
/**
* Saturation
* @description The factor by which to adjust the saturation
* @default 1
*/
saturation?: number;
};
/**
* Scale Image
* @description Scales an image by a factor
*/
ImageScaleInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_scale
* @enum {string}
*/
type: 'img_scale';
/**
* Image
* @description The image to scale
*/
image?: components['schemas']['ImageField'];
/**
* Scale Factor
* @description The factor by which to scale the image
* @default 2
*/
scale_factor?: number;
/**
* Resample Mode
* @description The resampling mode
* @default bicubic
* @enum {string}
*/
resample_mode?:
| 'nearest'
| 'box'
| 'bilinear'
| 'hamming'
| 'bicubic'
| 'lanczos';
};
/**
* Image to Latents
* @description Encodes an image into latents.
*/
ImageToLatentsInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default i2l
* @enum {string}
*/
type: 'i2l';
/**
* Image
* @description The image to encode
*/
image?: components['schemas']['ImageField'];
/**
* Vae
* @description VAE
*/
vae?: components['schemas']['VaeField'];
/**
* Tiled
* @description Processing using overlapping tiles (reduce memory consumption)
* @default false
*/
tiled?: boolean;
/**
* Fp32
* @description Whether or not to use full float32 precision
* @default false
*/
fp32?: boolean;
};
/**
* ImageUrlsDTO
* @description The URLs for an image and its thumbnail.
*/
ImageUrlsDTO: {
/**
* Image Name
* @description The unique name of the image.
*/
image_name: string;
/**
* Image Url
* @description The URL of the image.
*/
image_url: string;
/**
* Thumbnail Url
* @description The URL of the image's thumbnail.
*/
thumbnail_url: string;
};
/**
* Add Invisible Watermark
* @description Add an invisible watermark to an image
*/
ImageWatermarkInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default img_watermark
* @enum {string}
*/
type: 'img_watermark';
/**
* Image
* @description The image to check
*/
image?: components['schemas']['ImageField'];
/**
* Text
* @description Watermark text
* @default InvokeAI
*/
text?: string;
/**
* Metadata
* @description Optional core metadata to be written to image
*/
metadata?: components['schemas']['CoreMetadata'];
};
/**
* Solid Color Infill
* @description Infills transparent areas of an image with a solid color
*/
InfillColorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default infill_rgba
* @enum {string}
*/
type: 'infill_rgba';
/**
* Image
* @description The image to infill
*/
image?: components['schemas']['ImageField'];
/**
* Color
* @description The color to use to infill
* @default {
* "r": 127,
* "g": 127,
* "b": 127,
* "a": 255
* }
*/
color?: components['schemas']['ColorField'];
};
/**
* PatchMatch Infill
* @description Infills transparent areas of an image using the PatchMatch algorithm
*/
InfillPatchMatchInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default infill_patchmatch
* @enum {string}
*/
type: 'infill_patchmatch';
/**
* Image
* @description The image to infill
*/
image?: components['schemas']['ImageField'];
};
/**
* Tile Infill
* @description Infills transparent areas of an image with tiles of the image
*/
InfillTileInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default infill_tile
* @enum {string}
*/
type: 'infill_tile';
/**
* Image
* @description The image to infill
*/
image?: components['schemas']['ImageField'];
/**
* Tile Size
* @description The tile size (px)
* @default 32
*/
tile_size?: number;
/**
* Seed
* @description The seed to use for tile generation (omit for random)
*/
seed?: number;
};
/**
* Integer Collection
* @description A collection of integer primitive values
*/
IntegerCollectionInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default integer_collection
* @enum {string}
*/
type: 'integer_collection';
/**
* Collection
* @description The collection of integer values
* @default 0
*/
collection?: number[];
};
/**
* IntegerCollectionOutput
* @description Base class for nodes that output a collection of integers
*/
IntegerCollectionOutput: {
/**
* Type
* @default integer_collection_output
* @enum {string}
*/
type?: 'integer_collection_output';
/**
* Collection
* @description The int collection
*/
collection?: number[];
};
/**
* Integer
* @description An integer primitive value
*/
IntegerInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default integer
* @enum {string}
*/
type: 'integer';
/**
* A
* @description The integer value
* @default 0
*/
a?: number;
};
/**
* IntegerOutput
* @description Base class for nodes that output a single integer
*/
IntegerOutput: {
/**
* Type
* @default integer_output
* @enum {string}
*/
type?: 'integer_output';
/**
* A
* @description The output integer
*/
a: number;
};
/**
* IterateInvocation
* @description Iterates over a list of items
*/
IterateInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default iterate
* @enum {string}
*/
type: 'iterate';
/**
* Collection
* @description The list of items to iterate over
*/
collection?: unknown[];
/**
* Index
* @description The index, will be provided on executed iterators
* @default 0
*/
index?: number;
};
/**
* IterateInvocationOutput
* @description Used to connect iteration outputs. Will be expanded to a specific output.
*/
IterateInvocationOutput: {
/**
* Type
* @default iterate_output
* @enum {string}
*/
type?: 'iterate_output';
/**
* Collection Item
* @description The item being iterated over
*/
item?: unknown;
};
/**
* Latents Collection
* @description A collection of latents tensor primitive values
*/
LatentsCollectionInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default latents_collection
* @enum {string}
*/
type: 'latents_collection';
/**
* Collection
* @description The collection of latents tensors
* @default 0
*/
collection?: components['schemas']['LatentsField'][];
};
/**
* LatentsCollectionOutput
* @description Base class for nodes that output a collection of latents tensors
*/
LatentsCollectionOutput: {
/**
* Type
* @default latents_collection_output
* @enum {string}
*/
type?: 'latents_collection_output';
/**
* Collection
* @description Latents tensor
*/
collection?: components['schemas']['LatentsField'][];
};
/**
* LatentsField
* @description A latents tensor primitive field
*/
LatentsField: {
/**
* Latents Name
* @description The name of the latents
*/
latents_name: string;
/**
* Seed
* @description Seed used to generate this latents
*/
seed?: number;
};
/**
* Latents Primitive
* @description A latents tensor primitive value
*/
LatentsInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default latents
* @enum {string}
*/
type: 'latents';
/**
* Latents
* @description The latents tensor
*/
latents?: components['schemas']['LatentsField'];
};
/**
* LatentsOutput
* @description Base class for nodes that output a single latents tensor
*/
LatentsOutput: {
/**
* Type
* @default latents_output
* @enum {string}
*/
type?: 'latents_output';
/**
* Latents
* @description Latents tensor
*/
latents: components['schemas']['LatentsField'];
/**
* Width
* @description Width of output (px)
*/
width: number;
/**
* Height
* @description Height of output (px)
*/
height: number;
};
/**
* Latents to Image
* @description Generates an image from latents.
*/
LatentsToImageInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default l2i
* @enum {string}
*/
type: 'l2i';
/**
* Tiled
* @description Processing using overlapping tiles (reduce memory consumption)
* @default false
*/
tiled?: boolean;
/**
* Fp32
* @description Whether or not to use full float32 precision
* @default false
*/
fp32?: boolean;
/**
* Metadata
* @description Optional core metadata to be written to image
*/
metadata?: components['schemas']['CoreMetadata'];
/**
* Latents
* @description Latents tensor
*/
latents?: components['schemas']['LatentsField'];
/**
* Vae
* @description VAE
*/
vae?: components['schemas']['VaeField'];
};
/**
* Leres (Depth) Processor
* @description Applies leres processing to image
*/
LeresImageProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default leres_image_processor
* @enum {string}
*/
type: 'leres_image_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
/**
* Thr A
* @description Leres parameter `thr_a`
* @default 0
*/
thr_a?: number;
/**
* Thr B
* @description Leres parameter `thr_b`
* @default 0
*/
thr_b?: number;
/**
* Boost
* @description Whether to use boost mode
* @default false
*/
boost?: boolean;
/**
* Detect Resolution
* @description Pixel resolution for detection
* @default 512
*/
detect_resolution?: number;
/**
* Image Resolution
* @description Pixel resolution for output image
* @default 512
*/
image_resolution?: number;
};
/**
* Lineart Anime Processor
* @description Applies line art anime processing to image
*/
LineartAnimeImageProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default lineart_anime_image_processor
* @enum {string}
*/
type: 'lineart_anime_image_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
/**
* Detect Resolution
* @description Pixel resolution for detection
* @default 512
*/
detect_resolution?: number;
/**
* Image Resolution
* @description Pixel resolution for output image
* @default 512
*/
image_resolution?: number;
};
/**
* Lineart Processor
* @description Applies line art processing to image
*/
LineartImageProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default lineart_image_processor
* @enum {string}
*/
type: 'lineart_image_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
/**
* Detect Resolution
* @description Pixel resolution for detection
* @default 512
*/
detect_resolution?: number;
/**
* Image Resolution
* @description Pixel resolution for output image
* @default 512
*/
image_resolution?: number;
/**
* Coarse
* @description Whether to use coarse mode
* @default false
*/
coarse?: boolean;
};
/**
* LoRAMetadataField
* @description LoRA metadata for an image generated in InvokeAI.
*/
LoRAMetadataField: {
/**
* Lora
* @description The LoRA model
*/
lora: components['schemas']['LoRAModelField'];
/**
* Weight
* @description The weight of the LoRA model
*/
weight: number;
};
/** LoRAModelConfig */
LoRAModelConfig: {
/** Model Name */
model_name: string;
base_model: components['schemas']['BaseModelType'];
/**
* Model Type
* @enum {string}
*/
model_type: 'lora';
/** Path */
path: string;
/** Description */
description?: string;
model_format: components['schemas']['LoRAModelFormat'];
error?: components['schemas']['ModelError'];
};
/**
* LoRAModelField
* @description LoRA model field
*/
LoRAModelField: {
/**
* Model Name
* @description Name of the LoRA model
*/
model_name: string;
/** @description Base model */
base_model: components['schemas']['BaseModelType'];
};
/**
* LoRAModelFormat
* @description An enumeration.
* @enum {string}
*/
LoRAModelFormat: 'lycoris' | 'diffusers';
/**
* LogLevel
* @description An enumeration.
* @enum {integer}
*/
LogLevel: 0 | 10 | 20 | 30 | 40 | 50;
/** LoraInfo */
LoraInfo: {
/**
* Model Name
* @description Info to load submodel
*/
model_name: string;
/** @description Base model */
base_model: components['schemas']['BaseModelType'];
/** @description Info to load submodel */
model_type: components['schemas']['ModelType'];
/** @description Info to load submodel */
submodel?: components['schemas']['SubModelType'];
/**
* Weight
* @description Lora's weight which to use when apply to model
*/
weight: number;
};
/**
* LoRA Loader
* @description Apply selected lora to unet and text_encoder.
*/
LoraLoaderInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default lora_loader
* @enum {string}
*/
type: 'lora_loader';
/**
* LoRA
* @description LoRA model to load
*/
lora: components['schemas']['LoRAModelField'];
/**
* Weight
* @description The weight at which the LoRA is applied to each model
* @default 0.75
*/
weight?: number;
/**
* UNet
* @description UNet (scheduler, LoRAs)
*/
unet?: components['schemas']['UNetField'];
/**
* CLIP
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip?: components['schemas']['ClipField'];
};
/**
* LoraLoaderOutput
* @description Model loader output
*/
LoraLoaderOutput: {
/**
* Type
* @default lora_loader_output
* @enum {string}
*/
type?: 'lora_loader_output';
/**
* UNet
* @description UNet (scheduler, LoRAs)
*/
unet?: components['schemas']['UNetField'];
/**
* CLIP
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip?: components['schemas']['ClipField'];
};
/**
* MainModelField
* @description Main model field
*/
MainModelField: {
/**
* Model Name
* @description Name of the model
*/
model_name: string;
/** @description Base model */
base_model: components['schemas']['BaseModelType'];
/** @description Model Type */
model_type: components['schemas']['ModelType'];
};
/**
* Main Model Loader
* @description Loads a main model, outputting its submodels.
*/
MainModelLoaderInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default main_model_loader
* @enum {string}
*/
type: 'main_model_loader';
/**
* Model
* @description Main model (UNet, VAE, CLIP) to load
*/
model: components['schemas']['MainModelField'];
};
/**
* Combine Mask
* @description Combine two masks together by multiplying them using `PIL.ImageChops.multiply()`.
*/
MaskCombineInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default mask_combine
* @enum {string}
*/
type: 'mask_combine';
/**
* Mask1
* @description The first mask to combine
*/
mask1?: components['schemas']['ImageField'];
/**
* Mask2
* @description The second image to combine
*/
mask2?: components['schemas']['ImageField'];
};
/**
* Mask Edge
* @description Applies an edge mask to an image
*/
MaskEdgeInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default mask_edge
* @enum {string}
*/
type: 'mask_edge';
/**
* Image
* @description The image to apply the mask to
*/
image?: components['schemas']['ImageField'];
/**
* Edge Size
* @description The size of the edge
*/
edge_size?: number;
/**
* Edge Blur
* @description The amount of blur on the edge
*/
edge_blur?: number;
/**
* Low Threshold
* @description First threshold for the hysteresis procedure in Canny edge detection
*/
low_threshold?: number;
/**
* High Threshold
* @description Second threshold for the hysteresis procedure in Canny edge detection
*/
high_threshold?: number;
};
/**
* Mask from Alpha
* @description Extracts the alpha channel of an image as a mask.
*/
MaskFromAlphaInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default tomask
* @enum {string}
*/
type: 'tomask';
/**
* Image
* @description The image to create the mask from
*/
image?: components['schemas']['ImageField'];
/**
* Invert
* @description Whether or not to invert the mask
* @default false
*/
invert?: boolean;
};
/**
* Mediapipe Face Processor
* @description Applies mediapipe face processing to image
*/
MediapipeFaceProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default mediapipe_face_processor
* @enum {string}
*/
type: 'mediapipe_face_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
/**
* Max Faces
* @description Maximum number of faces to detect
* @default 1
*/
max_faces?: number;
/**
* Min Confidence
* @description Minimum confidence for face detection
* @default 0.5
*/
min_confidence?: number;
};
/**
* MergeInterpolationMethod
* @description An enumeration.
* @enum {string}
*/
MergeInterpolationMethod:
| 'weighted_sum'
| 'sigmoid'
| 'inv_sigmoid'
| 'add_difference';
/**
* Metadata Accumulator
* @description Outputs a Core Metadata Object
*/
MetadataAccumulatorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default metadata_accumulator
* @enum {string}
*/
type: 'metadata_accumulator';
/**
* Generation Mode
* @description The generation mode that output this image
*/
generation_mode?: string;
/**
* Positive Prompt
* @description The positive prompt parameter
*/
positive_prompt?: string;
/**
* Negative Prompt
* @description The negative prompt parameter
*/
negative_prompt?: string;
/**
* Width
* @description The width parameter
*/
width?: number;
/**
* Height
* @description The height parameter
*/
height?: number;
/**
* Seed
* @description The seed used for noise generation
*/
seed?: number;
/**
* Rand Device
* @description The device used for random number generation
*/
rand_device?: string;
/**
* Cfg Scale
* @description The classifier-free guidance scale parameter
*/
cfg_scale?: number;
/**
* Steps
* @description The number of steps used for inference
*/
steps?: number;
/**
* Scheduler
* @description The scheduler used for inference
*/
scheduler?: string;
/**
* Clip Skip
* @description The number of skipped CLIP layers
*/
clip_skip?: number;
/**
* Model
* @description The main model used for inference
*/
model?: components['schemas']['MainModelField'];
/**
* Controlnets
* @description The ControlNets used for inference
*/
controlnets?: components['schemas']['ControlField'][];
/**
* Loras
* @description The LoRAs used for inference
*/
loras?: components['schemas']['LoRAMetadataField'][];
/**
* Strength
* @description The strength used for latents-to-latents
*/
strength?: number;
/**
* Init Image
* @description The name of the initial image
*/
init_image?: string;
/**
* Vae
* @description The VAE used for decoding, if the main model's default was not used
*/
vae?: components['schemas']['VAEModelField'];
/**
* Positive Style Prompt
* @description The positive style prompt parameter
*/
positive_style_prompt?: string;
/**
* Negative Style Prompt
* @description The negative style prompt parameter
*/
negative_style_prompt?: string;
/**
* Refiner Model
* @description The SDXL Refiner model used
*/
refiner_model?: components['schemas']['MainModelField'];
/**
* Refiner Cfg Scale
* @description The classifier-free guidance scale parameter used for the refiner
*/
refiner_cfg_scale?: number;
/**
* Refiner Steps
* @description The number of steps used for the refiner
*/
refiner_steps?: number;
/**
* Refiner Scheduler
* @description The scheduler used for the refiner
*/
refiner_scheduler?: string;
/**
* Refiner Positive Aesthetic Store
* @description The aesthetic score used for the refiner
*/
refiner_positive_aesthetic_store?: number;
/**
* Refiner Negative Aesthetic Store
* @description The aesthetic score used for the refiner
*/
refiner_negative_aesthetic_store?: number;
/**
* Refiner Start
* @description The start value used for refiner denoising
*/
refiner_start?: number;
};
/**
* MetadataAccumulatorOutput
* @description The output of the MetadataAccumulator node
*/
MetadataAccumulatorOutput: {
/**
* Type
* @default metadata_accumulator_output
* @enum {string}
*/
type?: 'metadata_accumulator_output';
/**
* Metadata
* @description The core metadata for the image
*/
metadata: components['schemas']['CoreMetadata'];
};
/**
* Midas (Depth) Processor
* @description Applies Midas depth processing to image
*/
MidasDepthImageProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default midas_depth_image_processor
* @enum {string}
*/
type: 'midas_depth_image_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
/**
* A Mult
* @description Midas parameter `a_mult` (a = a_mult * PI)
* @default 2
*/
a_mult?: number;
/**
* Bg Th
* @description Midas parameter `bg_th`
* @default 0.1
*/
bg_th?: number;
};
/**
* MLSD Processor
* @description Applies MLSD processing to image
*/
MlsdImageProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default mlsd_image_processor
* @enum {string}
*/
type: 'mlsd_image_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
/**
* Detect Resolution
* @description Pixel resolution for detection
* @default 512
*/
detect_resolution?: number;
/**
* Image Resolution
* @description Pixel resolution for output image
* @default 512
*/
image_resolution?: number;
/**
* Thr V
* @description MLSD parameter `thr_v`
* @default 0.1
*/
thr_v?: number;
/**
* Thr D
* @description MLSD parameter `thr_d`
* @default 0.1
*/
thr_d?: number;
};
/**
* ModelError
* @description An enumeration.
* @enum {string}
*/
ModelError: 'not_found';
/** ModelInfo */
ModelInfo: {
/**
* Model Name
* @description Info to load submodel
*/
model_name: string;
/** @description Base model */
base_model: components['schemas']['BaseModelType'];
/** @description Info to load submodel */
model_type: components['schemas']['ModelType'];
/** @description Info to load submodel */
submodel?: components['schemas']['SubModelType'];
};
/**
* ModelLoaderOutput
* @description Model loader output
*/
ModelLoaderOutput: {
/**
* Type
* @default model_loader_output
* @enum {string}
*/
type?: 'model_loader_output';
/**
* UNet
* @description UNet (scheduler, LoRAs)
*/
unet: components['schemas']['UNetField'];
/**
* CLIP
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip: components['schemas']['ClipField'];
/**
* VAE
* @description VAE
*/
vae: components['schemas']['VaeField'];
};
/**
* ModelType
* @description An enumeration.
* @enum {string}
*/
ModelType: 'onnx' | 'main' | 'vae' | 'lora' | 'controlnet' | 'embedding';
/**
* ModelVariantType
* @description An enumeration.
* @enum {string}
*/
ModelVariantType: 'normal' | 'inpaint' | 'depth';
/** ModelsList */
ModelsList: {
/** Models */
models: (
| components['schemas']['ONNXStableDiffusion1ModelConfig']
| components['schemas']['StableDiffusion1ModelCheckpointConfig']
| components['schemas']['StableDiffusion1ModelDiffusersConfig']
| components['schemas']['VaeModelConfig']
| components['schemas']['LoRAModelConfig']
| components['schemas']['ControlNetModelCheckpointConfig']
| components['schemas']['ControlNetModelDiffusersConfig']
| components['schemas']['TextualInversionModelConfig']
| components['schemas']['ONNXStableDiffusion2ModelConfig']
| components['schemas']['StableDiffusion2ModelCheckpointConfig']
| components['schemas']['StableDiffusion2ModelDiffusersConfig']
| components['schemas']['StableDiffusionXLModelCheckpointConfig']
| components['schemas']['StableDiffusionXLModelDiffusersConfig']
)[];
};
/**
* Multiply Integers
* @description Multiplies two numbers
*/
MultiplyInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default mul
* @enum {string}
*/
type: 'mul';
/**
* A
* @description The first number
* @default 0
*/
a?: number;
/**
* B
* @description The second number
* @default 0
*/
b?: number;
};
/**
* Noise
* @description Generates latent noise.
*/
NoiseInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default noise
* @enum {string}
*/
type: 'noise';
/**
* Seed
* @description Seed for random number generation
*/
seed?: number;
/**
* Width
* @description Width of output (px)
* @default 512
*/
width?: number;
/**
* Height
* @description Height of output (px)
* @default 512
*/
height?: number;
/**
* Use Cpu
* @description Use CPU for noise generation (for reproducible results across platforms)
* @default true
*/
use_cpu?: boolean;
};
/**
* NoiseOutput
* @description Invocation noise output
*/
NoiseOutput: {
/**
* Type
* @default noise_output
* @enum {string}
*/
type?: 'noise_output';
/**
* Noise
* @description Noise tensor
*/
noise?: components['schemas']['LatentsField'];
/**
* Width
* @description Width of output (px)
*/
width: number;
/**
* Height
* @description Height of output (px)
*/
height: number;
};
/**
* Normal BAE Processor
* @description Applies NormalBae processing to image
*/
NormalbaeImageProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default normalbae_image_processor
* @enum {string}
*/
type: 'normalbae_image_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
/**
* Detect Resolution
* @description Pixel resolution for detection
* @default 512
*/
detect_resolution?: number;
/**
* Image Resolution
* @description Pixel resolution for output image
* @default 512
*/
image_resolution?: number;
};
/**
* ONNX Latents to Image
* @description Generates an image from latents.
*/
ONNXLatentsToImageInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default l2i_onnx
* @enum {string}
*/
type: 'l2i_onnx';
/**
* Latents
* @description Denoised latents tensor
*/
latents?: components['schemas']['LatentsField'];
/**
* Vae
* @description VAE
*/
vae?: components['schemas']['VaeField'];
/**
* Metadata
* @description Optional core metadata to be written to image
*/
metadata?: components['schemas']['CoreMetadata'];
};
/**
* ONNXModelLoaderOutput
* @description Model loader output
*/
ONNXModelLoaderOutput: {
/**
* Type
* @default model_loader_output_onnx
* @enum {string}
*/
type?: 'model_loader_output_onnx';
/**
* UNet
* @description UNet (scheduler, LoRAs)
*/
unet?: components['schemas']['UNetField'];
/**
* CLIP
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip?: components['schemas']['ClipField'];
/**
* VAE Decoder
* @description VAE
*/
vae_decoder?: components['schemas']['VaeField'];
/**
* VAE Encoder
* @description VAE
*/
vae_encoder?: components['schemas']['VaeField'];
};
/**
* ONNX Prompt (Raw)
* @description A node to process inputs and produce outputs.
* May use dependency injection in __init__ to receive providers.
*/
ONNXPromptInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default prompt_onnx
* @enum {string}
*/
type: 'prompt_onnx';
/**
* Prompt
* @description Raw prompt text (no parsing)
* @default
*/
prompt?: string;
/**
* Clip
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip?: components['schemas']['ClipField'];
};
/** ONNXStableDiffusion1ModelConfig */
ONNXStableDiffusion1ModelConfig: {
/** Model Name */
model_name: string;
base_model: components['schemas']['BaseModelType'];
/**
* Model Type
* @enum {string}
*/
model_type: 'onnx';
/** Path */
path: string;
/** Description */
description?: string;
/**
* Model Format
* @enum {string}
*/
model_format: 'onnx';
error?: components['schemas']['ModelError'];
variant: components['schemas']['ModelVariantType'];
};
/** ONNXStableDiffusion2ModelConfig */
ONNXStableDiffusion2ModelConfig: {
/** Model Name */
model_name: string;
base_model: components['schemas']['BaseModelType'];
/**
* Model Type
* @enum {string}
*/
model_type: 'onnx';
/** Path */
path: string;
/** Description */
description?: string;
/**
* Model Format
* @enum {string}
*/
model_format: 'onnx';
error?: components['schemas']['ModelError'];
variant: components['schemas']['ModelVariantType'];
prediction_type: components['schemas']['SchedulerPredictionType'];
/** Upcast Attention */
upcast_attention: boolean;
};
/**
* ONNX Text to Latents
* @description Generates latents from conditionings.
*/
ONNXTextToLatentsInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default t2l_onnx
* @enum {string}
*/
type: 't2l_onnx';
/**
* Positive Conditioning
* @description Positive conditioning tensor
*/
positive_conditioning?: components['schemas']['ConditioningField'];
/**
* Negative Conditioning
* @description Negative conditioning tensor
*/
negative_conditioning?: components['schemas']['ConditioningField'];
/**
* Noise
* @description Noise tensor
*/
noise?: components['schemas']['LatentsField'];
/**
* Steps
* @description Number of steps to run
* @default 10
*/
steps?: number;
/**
* Cfg Scale
* @description Classifier-Free Guidance scale
* @default 7.5
*/
cfg_scale?: number | number[];
/**
* Scheduler
* @description Scheduler to use during inference
* @default euler
* @enum {string}
*/
scheduler?:
| 'ddim'
| 'ddpm'
| 'deis'
| 'lms'
| 'lms_k'
| 'pndm'
| 'heun'
| 'heun_k'
| 'euler'
| 'euler_k'
| 'euler_a'
| 'kdpm_2'
| 'kdpm_2_a'
| 'dpmpp_2s'
| 'dpmpp_2s_k'
| 'dpmpp_2m'
| 'dpmpp_2m_k'
| 'dpmpp_2m_sde'
| 'dpmpp_2m_sde_k'
| 'dpmpp_sde'
| 'dpmpp_sde_k'
| 'unipc';
/**
* Precision
* @description Precision to use
* @default tensor(float16)
* @enum {string}
*/
precision?:
| 'tensor(bool)'
| 'tensor(int8)'
| 'tensor(uint8)'
| 'tensor(int16)'
| 'tensor(uint16)'
| 'tensor(int32)'
| 'tensor(uint32)'
| 'tensor(int64)'
| 'tensor(uint64)'
| 'tensor(float16)'
| 'tensor(float)'
| 'tensor(double)';
/**
* Unet
* @description UNet (scheduler, LoRAs)
*/
unet?: components['schemas']['UNetField'];
/**
* Control
* @description ControlNet(s) to apply
*/
control?:
| components['schemas']['ControlField']
| components['schemas']['ControlField'][];
};
/**
* OffsetPaginatedResults[BoardDTO]
* @description Offset-paginated results
*/
OffsetPaginatedResults_BoardDTO_: {
/**
* Items
* @description Items
*/
items: components['schemas']['BoardDTO'][];
/**
* Offset
* @description Offset from which to retrieve items
*/
offset: number;
/**
* Limit
* @description Limit of items to get
*/
limit: number;
/**
* Total
* @description Total number of items in result
*/
total: number;
};
/**
* OffsetPaginatedResults[ImageDTO]
* @description Offset-paginated results
*/
OffsetPaginatedResults_ImageDTO_: {
/**
* Items
* @description Items
*/
items: components['schemas']['ImageDTO'][];
/**
* Offset
* @description Offset from which to retrieve items
*/
offset: number;
/**
* Limit
* @description Limit of items to get
*/
limit: number;
/**
* Total
* @description Total number of items in result
*/
total: number;
};
/**
* OnnxModelField
* @description Onnx model field
*/
OnnxModelField: {
/**
* Model Name
* @description Name of the model
*/
model_name: string;
/** @description Base model */
base_model: components['schemas']['BaseModelType'];
/** @description Model Type */
model_type: components['schemas']['ModelType'];
};
/**
* ONNX Model Loader
* @description Loads a main model, outputting its submodels.
*/
OnnxModelLoaderInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default onnx_model_loader
* @enum {string}
*/
type: 'onnx_model_loader';
/**
* Model
* @description ONNX Main model (UNet, VAE, CLIP) to load
*/
model: components['schemas']['OnnxModelField'];
};
/**
* Openpose Processor
* @description Applies Openpose processing to image
*/
OpenposeImageProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default openpose_image_processor
* @enum {string}
*/
type: 'openpose_image_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
/**
* Hand And Face
* @description Whether to use hands and face mode
* @default false
*/
hand_and_face?: boolean;
/**
* Detect Resolution
* @description Pixel resolution for detection
* @default 512
*/
detect_resolution?: number;
/**
* Image Resolution
* @description Pixel resolution for output image
* @default 512
*/
image_resolution?: number;
};
/**
* PaginatedResults[GraphExecutionState]
* @description Paginated results
*/
PaginatedResults_GraphExecutionState_: {
/**
* Items
* @description Items
*/
items: components['schemas']['GraphExecutionState'][];
/**
* Page
* @description Current Page
*/
page: number;
/**
* Pages
* @description Total number of pages
*/
pages: number;
/**
* Per Page
* @description Number of items per page
*/
per_page: number;
/**
* Total
* @description Total number of items in result
*/
total: number;
};
/**
* PIDI Processor
* @description Applies PIDI processing to image
*/
PidiImageProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default pidi_image_processor
* @enum {string}
*/
type: 'pidi_image_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
/**
* Detect Resolution
* @description Pixel resolution for detection
* @default 512
*/
detect_resolution?: number;
/**
* Image Resolution
* @description Pixel resolution for output image
* @default 512
*/
image_resolution?: number;
/**
* Safe
* @description Whether or not to use safe mode
* @default false
*/
safe?: boolean;
/**
* Scribble
* @description Whether or not to use scribble mode
* @default false
*/
scribble?: boolean;
};
/**
* Prompts from File
* @description Loads prompts from a text file
*/
PromptsFromFileInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default prompt_from_file
* @enum {string}
*/
type: 'prompt_from_file';
/**
* File Path
* @description Path to prompt text file
*/
file_path?: string;
/**
* Pre Prompt
* @description String to prepend to each prompt
*/
pre_prompt?: string;
/**
* Post Prompt
* @description String to append to each prompt
*/
post_prompt?: string;
/**
* Start Line
* @description Line in the file to start start from
* @default 1
*/
start_line?: number;
/**
* Max Prompts
* @description Max lines to read from file (0=all)
* @default 1
*/
max_prompts?: number;
};
/**
* Random Integer
* @description Outputs a single random integer.
*/
RandomIntInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default rand_int
* @enum {string}
*/
type: 'rand_int';
/**
* Low
* @description The inclusive low value
* @default 0
*/
low?: number;
/**
* High
* @description The exclusive high value
* @default 2147483647
*/
high?: number;
};
/**
* Random Range
* @description Creates a collection of random numbers
*/
RandomRangeInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default random_range
* @enum {string}
*/
type: 'random_range';
/**
* Low
* @description The inclusive low value
* @default 0
*/
low?: number;
/**
* High
* @description The exclusive high value
* @default 2147483647
*/
high?: number;
/**
* Size
* @description The number of values to generate
* @default 1
*/
size?: number;
/**
* Seed
* @description The seed for the RNG (omit for random)
*/
seed?: number;
};
/**
* Integer Range
* @description Creates a range of numbers from start to stop with step
*/
RangeInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default range
* @enum {string}
*/
type: 'range';
/**
* Start
* @description The start of the range
* @default 0
*/
start?: number;
/**
* Stop
* @description The stop of the range
* @default 10
*/
stop?: number;
/**
* Step
* @description The step of the range
* @default 1
*/
step?: number;
};
/**
* Integer Range of Size
* @description Creates a range from start to start + size with step
*/
RangeOfSizeInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default range_of_size
* @enum {string}
*/
type: 'range_of_size';
/**
* Start
* @description The start of the range
* @default 0
*/
start?: number;
/**
* Size
* @description The number of values
* @default 1
*/
size?: number;
/**
* Step
* @description The step of the range
* @default 1
*/
step?: number;
};
/** RemoveImagesFromBoardResult */
RemoveImagesFromBoardResult: {
/**
* Removed Image Names
* @description The image names that were removed from their board
*/
removed_image_names: string[];
};
/**
* Resize Latents
* @description Resizes latents to explicit width/height (in pixels). Provided dimensions are floor-divided by 8.
*/
ResizeLatentsInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default lresize
* @enum {string}
*/
type: 'lresize';
/**
* Latents
* @description Latents tensor
*/
latents?: components['schemas']['LatentsField'];
/**
* Width
* @description Width of output (px)
*/
width?: number;
/**
* Height
* @description Width of output (px)
*/
height?: number;
/**
* Mode
* @description Interpolation mode
* @default bilinear
* @enum {string}
*/
mode?:
| 'nearest'
| 'linear'
| 'bilinear'
| 'bicubic'
| 'trilinear'
| 'area'
| 'nearest-exact';
/**
* Antialias
* @description Whether or not to apply antialiasing (bilinear or bicubic only)
* @default false
*/
antialias?: boolean;
};
/**
* ResourceOrigin
* @description The origin of a resource (eg image).
*
* - INTERNAL: The resource was created by the application.
* - EXTERNAL: The resource was not created by the application.
* This may be a user-initiated upload, or an internal application upload (eg Canvas init image).
* @enum {string}
*/
ResourceOrigin: 'internal' | 'external';
/**
* SDXL Compel Prompt
* @description Parse prompt using compel package to conditioning.
*/
SDXLCompelPromptInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default sdxl_compel_prompt
* @enum {string}
*/
type: 'sdxl_compel_prompt';
/**
* Prompt
* @description Prompt to be parsed by Compel to create a conditioning tensor
* @default
*/
prompt?: string;
/**
* Style
* @description Prompt to be parsed by Compel to create a conditioning tensor
* @default
*/
style?: string;
/**
* Original Width
* @default 1024
*/
original_width?: number;
/**
* Original Height
* @default 1024
*/
original_height?: number;
/**
* Crop Top
* @default 0
*/
crop_top?: number;
/**
* Crop Left
* @default 0
*/
crop_left?: number;
/**
* Target Width
* @default 1024
*/
target_width?: number;
/**
* Target Height
* @default 1024
*/
target_height?: number;
/**
* Clip
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip?: components['schemas']['ClipField'];
/**
* Clip2
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip2?: components['schemas']['ClipField'];
};
/**
* SDXL LoRA Loader
* @description Apply selected lora to unet and text_encoder.
*/
SDXLLoraLoaderInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default sdxl_lora_loader
* @enum {string}
*/
type: 'sdxl_lora_loader';
/**
* LoRA
* @description LoRA model to load
*/
lora: components['schemas']['LoRAModelField'];
/**
* Weight
* @description The weight at which the LoRA is applied to each model
* @default 0.75
*/
weight?: number;
/**
* UNET
* @description UNet (scheduler, LoRAs)
*/
unet?: components['schemas']['UNetField'];
/**
* CLIP 1
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip?: components['schemas']['ClipField'];
/**
* CLIP 2
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip2?: components['schemas']['ClipField'];
};
/**
* SDXLLoraLoaderOutput
* @description SDXL LoRA Loader Output
*/
SDXLLoraLoaderOutput: {
/**
* Type
* @default sdxl_lora_loader_output
* @enum {string}
*/
type?: 'sdxl_lora_loader_output';
/**
* UNet
* @description UNet (scheduler, LoRAs)
*/
unet?: components['schemas']['UNetField'];
/**
* CLIP 1
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip?: components['schemas']['ClipField'];
/**
* CLIP 2
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip2?: components['schemas']['ClipField'];
};
/**
* SDXL Main Model Loader
* @description Loads an sdxl base model, outputting its submodels.
*/
SDXLModelLoaderInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default sdxl_model_loader
* @enum {string}
*/
type: 'sdxl_model_loader';
/**
* Model
* @description SDXL Main model (UNet, VAE, CLIP1, CLIP2) to load
*/
model: components['schemas']['MainModelField'];
};
/**
* SDXLModelLoaderOutput
* @description SDXL base model loader output
*/
SDXLModelLoaderOutput: {
/**
* Type
* @default sdxl_model_loader_output
* @enum {string}
*/
type?: 'sdxl_model_loader_output';
/**
* UNet
* @description UNet (scheduler, LoRAs)
*/
unet: components['schemas']['UNetField'];
/**
* CLIP 1
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip: components['schemas']['ClipField'];
/**
* CLIP 2
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip2: components['schemas']['ClipField'];
/**
* VAE
* @description VAE
*/
vae: components['schemas']['VaeField'];
};
/**
* SDXL Refiner Compel Prompt
* @description Parse prompt using compel package to conditioning.
*/
SDXLRefinerCompelPromptInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default sdxl_refiner_compel_prompt
* @enum {string}
*/
type: 'sdxl_refiner_compel_prompt';
/**
* Style
* @description Prompt to be parsed by Compel to create a conditioning tensor
* @default
*/
style?: string;
/**
* Original Width
* @default 1024
*/
original_width?: number;
/**
* Original Height
* @default 1024
*/
original_height?: number;
/**
* Crop Top
* @default 0
*/
crop_top?: number;
/**
* Crop Left
* @default 0
*/
crop_left?: number;
/**
* Aesthetic Score
* @description The aesthetic score to apply to the conditioning tensor
* @default 6
*/
aesthetic_score?: number;
/**
* Clip2
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip2?: components['schemas']['ClipField'];
};
/**
* SDXL Refiner Model Loader
* @description Loads an sdxl refiner model, outputting its submodels.
*/
SDXLRefinerModelLoaderInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default sdxl_refiner_model_loader
* @enum {string}
*/
type: 'sdxl_refiner_model_loader';
/**
* Model
* @description SDXL Refiner Main Modde (UNet, VAE, CLIP2) to load
*/
model: components['schemas']['MainModelField'];
};
/**
* SDXLRefinerModelLoaderOutput
* @description SDXL refiner model loader output
*/
SDXLRefinerModelLoaderOutput: {
/**
* Type
* @default sdxl_refiner_model_loader_output
* @enum {string}
*/
type?: 'sdxl_refiner_model_loader_output';
/**
* UNet
* @description UNet (scheduler, LoRAs)
*/
unet: components['schemas']['UNetField'];
/**
* CLIP 2
* @description CLIP (tokenizer, text encoder, LoRAs) and skipped layer count
*/
clip2: components['schemas']['ClipField'];
/**
* VAE
* @description VAE
*/
vae: components['schemas']['VaeField'];
};
/**
* Scale Latents
* @description Scales latents by a given factor.
*/
ScaleLatentsInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default lscale
* @enum {string}
*/
type: 'lscale';
/**
* Latents
* @description Latents tensor
*/
latents?: components['schemas']['LatentsField'];
/**
* Scale Factor
* @description The factor by which to scale
*/
scale_factor?: number;
/**
* Mode
* @description Interpolation mode
* @default bilinear
* @enum {string}
*/
mode?:
| 'nearest'
| 'linear'
| 'bilinear'
| 'bicubic'
| 'trilinear'
| 'area'
| 'nearest-exact';
/**
* Antialias
* @description Whether or not to apply antialiasing (bilinear or bicubic only)
* @default false
*/
antialias?: boolean;
};
/**
* SchedulerPredictionType
* @description An enumeration.
* @enum {string}
*/
SchedulerPredictionType: 'epsilon' | 'v_prediction' | 'sample';
/**
* Segment Anything Processor
* @description Applies segment anything processing to image
*/
SegmentAnythingProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default segment_anything_processor
* @enum {string}
*/
type: 'segment_anything_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
};
/**
* Show Image
* @description Displays a provided image, and passes it forward in the pipeline.
*/
ShowImageInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default show_image
* @enum {string}
*/
type: 'show_image';
/**
* Image
* @description The image to show
*/
image?: components['schemas']['ImageField'];
};
/** StableDiffusion1ModelCheckpointConfig */
StableDiffusion1ModelCheckpointConfig: {
/** Model Name */
model_name: string;
base_model: components['schemas']['BaseModelType'];
/**
* Model Type
* @enum {string}
*/
model_type: 'main';
/** Path */
path: string;
/** Description */
description?: string;
/**
* Model Format
* @enum {string}
*/
model_format: 'checkpoint';
error?: components['schemas']['ModelError'];
/** Vae */
vae?: string;
/** Config */
config: string;
variant: components['schemas']['ModelVariantType'];
};
/** StableDiffusion1ModelDiffusersConfig */
StableDiffusion1ModelDiffusersConfig: {
/** Model Name */
model_name: string;
base_model: components['schemas']['BaseModelType'];
/**
* Model Type
* @enum {string}
*/
model_type: 'main';
/** Path */
path: string;
/** Description */
description?: string;
/**
* Model Format
* @enum {string}
*/
model_format: 'diffusers';
error?: components['schemas']['ModelError'];
/** Vae */
vae?: string;
variant: components['schemas']['ModelVariantType'];
};
/** StableDiffusion2ModelCheckpointConfig */
StableDiffusion2ModelCheckpointConfig: {
/** Model Name */
model_name: string;
base_model: components['schemas']['BaseModelType'];
/**
* Model Type
* @enum {string}
*/
model_type: 'main';
/** Path */
path: string;
/** Description */
description?: string;
/**
* Model Format
* @enum {string}
*/
model_format: 'checkpoint';
error?: components['schemas']['ModelError'];
/** Vae */
vae?: string;
/** Config */
config: string;
variant: components['schemas']['ModelVariantType'];
};
/** StableDiffusion2ModelDiffusersConfig */
StableDiffusion2ModelDiffusersConfig: {
/** Model Name */
model_name: string;
base_model: components['schemas']['BaseModelType'];
/**
* Model Type
* @enum {string}
*/
model_type: 'main';
/** Path */
path: string;
/** Description */
description?: string;
/**
* Model Format
* @enum {string}
*/
model_format: 'diffusers';
error?: components['schemas']['ModelError'];
/** Vae */
vae?: string;
variant: components['schemas']['ModelVariantType'];
};
/** StableDiffusionXLModelCheckpointConfig */
StableDiffusionXLModelCheckpointConfig: {
/** Model Name */
model_name: string;
base_model: components['schemas']['BaseModelType'];
/**
* Model Type
* @enum {string}
*/
model_type: 'main';
/** Path */
path: string;
/** Description */
description?: string;
/**
* Model Format
* @enum {string}
*/
model_format: 'checkpoint';
error?: components['schemas']['ModelError'];
/** Vae */
vae?: string;
/** Config */
config: string;
variant: components['schemas']['ModelVariantType'];
};
/** StableDiffusionXLModelDiffusersConfig */
StableDiffusionXLModelDiffusersConfig: {
/** Model Name */
model_name: string;
base_model: components['schemas']['BaseModelType'];
/**
* Model Type
* @enum {string}
*/
model_type: 'main';
/** Path */
path: string;
/** Description */
description?: string;
/**
* Model Format
* @enum {string}
*/
model_format: 'diffusers';
error?: components['schemas']['ModelError'];
/** Vae */
vae?: string;
variant: components['schemas']['ModelVariantType'];
};
/**
* Step Param Easing
* @description Experimental per-step parameter easing for denoising steps
*/
StepParamEasingInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default step_param_easing
* @enum {string}
*/
type: 'step_param_easing';
/**
* Easing
* @description The easing function to use
* @default Linear
* @enum {string}
*/
easing?:
| 'Linear'
| 'QuadIn'
| 'QuadOut'
| 'QuadInOut'
| 'CubicIn'
| 'CubicOut'
| 'CubicInOut'
| 'QuarticIn'
| 'QuarticOut'
| 'QuarticInOut'
| 'QuinticIn'
| 'QuinticOut'
| 'QuinticInOut'
| 'SineIn'
| 'SineOut'
| 'SineInOut'
| 'CircularIn'
| 'CircularOut'
| 'CircularInOut'
| 'ExponentialIn'
| 'ExponentialOut'
| 'ExponentialInOut'
| 'ElasticIn'
| 'ElasticOut'
| 'ElasticInOut'
| 'BackIn'
| 'BackOut'
| 'BackInOut'
| 'BounceIn'
| 'BounceOut'
| 'BounceInOut';
/**
* Num Steps
* @description number of denoising steps
* @default 20
*/
num_steps?: number;
/**
* Start Value
* @description easing starting value
* @default 0
*/
start_value?: number;
/**
* End Value
* @description easing ending value
* @default 1
*/
end_value?: number;
/**
* Start Step Percent
* @description fraction of steps at which to start easing
* @default 0
*/
start_step_percent?: number;
/**
* End Step Percent
* @description fraction of steps after which to end easing
* @default 1
*/
end_step_percent?: number;
/**
* Pre Start Value
* @description value before easing start
*/
pre_start_value?: number;
/**
* Post End Value
* @description value after easing end
*/
post_end_value?: number;
/**
* Mirror
* @description include mirror of easing function
* @default false
*/
mirror?: boolean;
/**
* Show Easing Plot
* @description show easing plot
* @default false
*/
show_easing_plot?: boolean;
};
/**
* String Collection
* @description A collection of string primitive values
*/
StringCollectionInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default string_collection
* @enum {string}
*/
type: 'string_collection';
/**
* Collection
* @description The collection of string values
* @default 0
*/
collection?: string[];
};
/**
* StringCollectionOutput
* @description Base class for nodes that output a collection of strings
*/
StringCollectionOutput: {
/**
* Type
* @default string_collection_output
* @enum {string}
*/
type?: 'string_collection_output';
/**
* Collection
* @description The output strings
*/
collection?: string[];
};
/**
* String
* @description A string primitive value
*/
StringInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default string
* @enum {string}
*/
type: 'string';
/**
* Text
* @description The string value
* @default
*/
text?: string;
};
/**
* StringOutput
* @description Base class for nodes that output a single string
*/
StringOutput: {
/**
* Type
* @default string_output
* @enum {string}
*/
type?: 'string_output';
/**
* Text
* @description The output string
*/
text: string;
};
/**
* SubModelType
* @description An enumeration.
* @enum {string}
*/
SubModelType:
| 'unet'
| 'text_encoder'
| 'text_encoder_2'
| 'tokenizer'
| 'tokenizer_2'
| 'vae'
| 'vae_decoder'
| 'vae_encoder'
| 'scheduler'
| 'safety_checker';
/**
* Subtract Integers
* @description Subtracts two numbers
*/
SubtractInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default sub
* @enum {string}
*/
type: 'sub';
/**
* A
* @description The first number
* @default 0
*/
a?: number;
/**
* B
* @description The second number
* @default 0
*/
b?: number;
};
/** TextualInversionModelConfig */
TextualInversionModelConfig: {
/** Model Name */
model_name: string;
base_model: components['schemas']['BaseModelType'];
/**
* Model Type
* @enum {string}
*/
model_type: 'embedding';
/** Path */
path: string;
/** Description */
description?: string;
/** Model Format */
model_format: null;
error?: components['schemas']['ModelError'];
};
/**
* Tile Resample Processor
* @description Tile resampler processor
*/
TileResamplerProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default tile_image_processor
* @enum {string}
*/
type: 'tile_image_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
/**
* Down Sampling Rate
* @description Down sampling rate
* @default 1
*/
down_sampling_rate?: number;
};
/** UNetField */
UNetField: {
/**
* Unet
* @description Info to load unet submodel
*/
unet: components['schemas']['ModelInfo'];
/**
* Scheduler
* @description Info to load scheduler submodel
*/
scheduler: components['schemas']['ModelInfo'];
/**
* Loras
* @description Loras to apply on model loading
*/
loras: components['schemas']['LoraInfo'][];
};
/** Upscaler */
Upscaler: {
/**
* Upscaling Method
* @description Name of upscaling method
*/
upscaling_method: string;
/**
* Upscaling Models
* @description List of upscaling models for this method
*/
upscaling_models: string[];
};
/**
* VAEModelField
* @description Vae model field
*/
VAEModelField: {
/**
* Model Name
* @description Name of the model
*/
model_name: string;
/** @description Base model */
base_model: components['schemas']['BaseModelType'];
};
/** VaeField */
VaeField: {
/**
* Vae
* @description Info to load vae submodel
*/
vae: components['schemas']['ModelInfo'];
};
/**
* VAE Loader
* @description Loads a VAE model, outputting a VaeLoaderOutput
*/
VaeLoaderInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default vae_loader
* @enum {string}
*/
type: 'vae_loader';
/**
* VAE
* @description VAE model to load
*/
vae_model: components['schemas']['VAEModelField'];
};
/**
* VaeLoaderOutput
* @description Model loader output
*/
VaeLoaderOutput: {
/**
* Type
* @default vae_loader_output
* @enum {string}
*/
type?: 'vae_loader_output';
/**
* VAE
* @description VAE
*/
vae: components['schemas']['VaeField'];
};
/** VaeModelConfig */
VaeModelConfig: {
/** Model Name */
model_name: string;
base_model: components['schemas']['BaseModelType'];
/**
* Model Type
* @enum {string}
*/
model_type: 'vae';
/** Path */
path: string;
/** Description */
description?: string;
model_format: components['schemas']['VaeModelFormat'];
error?: components['schemas']['ModelError'];
};
/**
* VaeModelFormat
* @description An enumeration.
* @enum {string}
*/
VaeModelFormat: 'checkpoint' | 'diffusers';
/** ValidationError */
ValidationError: {
/** Location */
loc: (string | number)[];
/** Message */
msg: string;
/** Error Type */
type: string;
};
/**
* Zoe (Depth) Processor
* @description Applies Zoe depth processing to image
*/
ZoeDepthImageProcessorInvocation: {
/**
* Id
* @description The id of this node. Must be unique among all nodes.
*/
id: string;
/**
* Is Intermediate
* @description Whether or not this node is an intermediate node.
* @default false
*/
is_intermediate?: boolean;
/**
* Type
* @default zoe_depth_image_processor
* @enum {string}
*/
type: 'zoe_depth_image_processor';
/**
* Image
* @description The image to process
*/
image?: components['schemas']['ImageField'];
};
/**
* StableDiffusion2ModelFormat
* @description An enumeration.
* @enum {string}
*/
Input: 'connection' | 'direct' | 'any';
/**
* ControlNetModelFormat
* @description An enumeration.
* @enum {string}
*/
ControlNetModelFormat: 'checkpoint' | 'diffusers';
/**
* StableDiffusion1ModelFormat
* @description An enumeration.
* @enum {string}
*/
UIType:
| 'integer'
| 'float'
| 'boolean'
| 'string'
| 'array'
| 'ImageField'
| 'LatentsField'
| 'ConditioningField'
| 'ControlField'
| 'ColorField'
| 'ImageCollection'
| 'ConditioningCollection'
| 'ColorCollection'
| 'LatentsCollection'
| 'IntegerCollection'
| 'FloatCollection'
| 'StringCollection'
| 'BooleanCollection'
| 'MainModelField'
| 'SDXLMainModelField'
| 'SDXLRefinerModelField'
| 'ONNXModelField'
| 'VaeModelField'
| 'LoRAModelField'
| 'ControlNetModelField'
| 'UNetField'
| 'VaeField'
| 'ClipField'
| 'Collection'
| 'CollectionItem'
| 'FilePath'
| 'enum';
/**
* StableDiffusionOnnxModelFormat
* @description An enumeration.
* @enum {string}
*/
StableDiffusionOnnxModelFormat: 'olive' | 'onnx';
/**
* _InputField
* @description *DO NOT USE*
* This helper class is used to tell the client about our custom field attributes via OpenAPI
* schema generation, and Typescript type generation from that schema. It serves no functional
* purpose in the backend.
*/
_InputField: {
input: components['schemas']['Input'];
/** Ui Hidden */
ui_hidden: boolean;
ui_type?: components['schemas']['UIType'];
ui_component?: components['schemas']['UIComponent'];
};
/**
* _OutputField
* @description *DO NOT USE*
* This helper class is used to tell the client about our custom field attributes via OpenAPI
* schema generation, and Typescript type generation from that schema. It serves no functional
* purpose in the backend.
*/
_OutputField: {
/** Ui Hidden */
ui_hidden: boolean;
ui_type?: components['schemas']['UIType'];
};
/**
* StableDiffusionXLModelFormat
* @description An enumeration.
* @enum {string}
*/
StableDiffusionXLModelFormat: 'checkpoint' | 'diffusers';
/**
* StableDiffusion1ModelFormat
* @description An enumeration.
* @enum {string}
*/
StableDiffusion1ModelFormat: 'checkpoint' | 'diffusers';
/**
* ControlNetModelFormat
* @description An enumeration.
* @enum {string}
*/
ControlNetModelFormat: 'checkpoint' | 'diffusers';
/**
* StableDiffusion2ModelFormat
* @description An enumeration.
* @enum {string}
*/
StableDiffusion2ModelFormat: 'checkpoint' | 'diffusers';
/**
* StableDiffusionOnnxModelFormat
* @description An enumeration.
* @enum {string}
*/
StableDiffusionOnnxModelFormat: 'olive' | 'onnx';
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
};
export type external = Record<string, never>;
export type operations = {
/**
* List Sessions
* @description Gets a list of sessions, optionally searching
*/
list_sessions: {
parameters: {
query?: {
/** @description The page of results to get */
page?: number;
/** @description The number of results per page */
per_page?: number;
/** @description The query string to search for */
query?: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['PaginatedResults_GraphExecutionState_'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Create Session
* @description Creates a new session, optionally initializing it with an invocation graph
*/
create_session: {
requestBody?: {
content: {
'application/json': components['schemas']['Graph'];
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['GraphExecutionState'];
};
};
/** @description Invalid json */
400: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Get Session
* @description Gets a session
*/
get_session: {
parameters: {
path: {
/** @description The id of the session to get */
session_id: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['GraphExecutionState'];
};
};
/** @description Session not found */
404: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Add Node
* @description Adds a node to the graph
*/
add_node: {
parameters: {
path: {
/** @description The id of the session */
session_id: string;
};
};
requestBody: {
content: {
'application/json':
| components['schemas']['ControlNetInvocation']
| components['schemas']['ImageProcessorInvocation']
| components['schemas']['MainModelLoaderInvocation']
| components['schemas']['LoraLoaderInvocation']
| components['schemas']['SDXLLoraLoaderInvocation']
| components['schemas']['VaeLoaderInvocation']
| components['schemas']['MetadataAccumulatorInvocation']
| components['schemas']['RangeInvocation']
| components['schemas']['RangeOfSizeInvocation']
| components['schemas']['RandomRangeInvocation']
| components['schemas']['ImageCollectionInvocation']
| components['schemas']['CompelInvocation']
| components['schemas']['SDXLCompelPromptInvocation']
| components['schemas']['SDXLRefinerCompelPromptInvocation']
| components['schemas']['ClipSkipInvocation']
| components['schemas']['LoadImageInvocation']
| components['schemas']['ShowImageInvocation']
| components['schemas']['ImageCropInvocation']
| components['schemas']['ImagePasteInvocation']
| components['schemas']['MaskFromAlphaInvocation']
| components['schemas']['ImageMultiplyInvocation']
| components['schemas']['ImageChannelInvocation']
| components['schemas']['ImageConvertInvocation']
| components['schemas']['ImageBlurInvocation']
| components['schemas']['ImageResizeInvocation']
| components['schemas']['ImageScaleInvocation']
| components['schemas']['ImageLerpInvocation']
| components['schemas']['ImageInverseLerpInvocation']
| components['schemas']['ImageNSFWBlurInvocation']
| components['schemas']['ImageWatermarkInvocation']
| components['schemas']['MaskEdgeInvocation']
| components['schemas']['MaskCombineInvocation']
| components['schemas']['ColorCorrectInvocation']
| components['schemas']['ImageHueAdjustmentInvocation']
| components['schemas']['ImageLuminosityAdjustmentInvocation']
| components['schemas']['ImageSaturationAdjustmentInvocation']
| components['schemas']['CvInpaintInvocation']
| components['schemas']['InfillColorInvocation']
| components['schemas']['InfillTileInvocation']
| components['schemas']['InfillPatchMatchInvocation']
| components['schemas']['DenoiseLatentsInvocation']
| components['schemas']['LatentsToImageInvocation']
| components['schemas']['ResizeLatentsInvocation']
| components['schemas']['ScaleLatentsInvocation']
| components['schemas']['ImageToLatentsInvocation']
| components['schemas']['AddInvocation']
| components['schemas']['SubtractInvocation']
| components['schemas']['MultiplyInvocation']
| components['schemas']['DivideInvocation']
| components['schemas']['RandomIntInvocation']
| components['schemas']['NoiseInvocation']
| components['schemas']['ONNXPromptInvocation']
| components['schemas']['ONNXTextToLatentsInvocation']
| components['schemas']['ONNXLatentsToImageInvocation']
| components['schemas']['ONNXSD1ModelLoaderInvocation']
| components['schemas']['OnnxModelLoaderInvocation']
| components['schemas']['DynamicPromptInvocation']
| components['schemas']['PromptsFromFileInvocation']
| components['schemas']['ParamIntInvocation']
| components['schemas']['ParamFloatInvocation']
| components['schemas']['ParamStringInvocation']
| components['schemas']['ParamPromptInvocation']
| components['schemas']['FloatLinearRangeInvocation']
| components['schemas']['StepParamEasingInvocation']
| components['schemas']['SDXLModelLoaderInvocation']
| components['schemas']['SDXLRefinerModelLoaderInvocation']
| components['schemas']['ESRGANInvocation']
| components['schemas']['GraphInvocation']
| components['schemas']['IterateInvocation']
| components['schemas']['CollectInvocation']
| components['schemas']['CannyImageProcessorInvocation']
| components['schemas']['HedImageProcessorInvocation']
| components['schemas']['LineartImageProcessorInvocation']
| components['schemas']['LineartAnimeImageProcessorInvocation']
| components['schemas']['OpenposeImageProcessorInvocation']
| components['schemas']['MidasDepthImageProcessorInvocation']
| components['schemas']['NormalbaeImageProcessorInvocation']
| components['schemas']['MlsdImageProcessorInvocation']
| components['schemas']['PidiImageProcessorInvocation']
| components['schemas']['ContentShuffleImageProcessorInvocation']
| components['schemas']['ZoeDepthImageProcessorInvocation']
| components['schemas']['MediapipeFaceProcessorInvocation']
| components['schemas']['LeresImageProcessorInvocation']
| components['schemas']['TileResamplerProcessorInvocation']
| components['schemas']['SegmentAnythingProcessorInvocation'];
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': string;
};
};
/** @description Invalid node or link */
400: never;
/** @description Session not found */
404: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Update Node
* @description Updates a node in the graph and removes all linked edges
*/
update_node: {
parameters: {
path: {
/** @description The id of the session */
session_id: string;
/** @description The path to the node in the graph */
node_path: string;
};
};
requestBody: {
content: {
'application/json':
| components['schemas']['ControlNetInvocation']
| components['schemas']['ImageProcessorInvocation']
| components['schemas']['MainModelLoaderInvocation']
| components['schemas']['LoraLoaderInvocation']
| components['schemas']['SDXLLoraLoaderInvocation']
| components['schemas']['VaeLoaderInvocation']
| components['schemas']['MetadataAccumulatorInvocation']
| components['schemas']['RangeInvocation']
| components['schemas']['RangeOfSizeInvocation']
| components['schemas']['RandomRangeInvocation']
| components['schemas']['ImageCollectionInvocation']
| components['schemas']['CompelInvocation']
| components['schemas']['SDXLCompelPromptInvocation']
| components['schemas']['SDXLRefinerCompelPromptInvocation']
| components['schemas']['ClipSkipInvocation']
| components['schemas']['LoadImageInvocation']
| components['schemas']['ShowImageInvocation']
| components['schemas']['ImageCropInvocation']
| components['schemas']['ImagePasteInvocation']
| components['schemas']['MaskFromAlphaInvocation']
| components['schemas']['ImageMultiplyInvocation']
| components['schemas']['ImageChannelInvocation']
| components['schemas']['ImageConvertInvocation']
| components['schemas']['ImageBlurInvocation']
| components['schemas']['ImageResizeInvocation']
| components['schemas']['ImageScaleInvocation']
| components['schemas']['ImageLerpInvocation']
| components['schemas']['ImageInverseLerpInvocation']
| components['schemas']['ImageNSFWBlurInvocation']
| components['schemas']['ImageWatermarkInvocation']
| components['schemas']['MaskEdgeInvocation']
| components['schemas']['MaskCombineInvocation']
| components['schemas']['ColorCorrectInvocation']
| components['schemas']['ImageHueAdjustmentInvocation']
| components['schemas']['ImageLuminosityAdjustmentInvocation']
| components['schemas']['ImageSaturationAdjustmentInvocation']
| components['schemas']['CvInpaintInvocation']
| components['schemas']['InfillColorInvocation']
| components['schemas']['InfillTileInvocation']
| components['schemas']['InfillPatchMatchInvocation']
| components['schemas']['DenoiseLatentsInvocation']
| components['schemas']['LatentsToImageInvocation']
| components['schemas']['ResizeLatentsInvocation']
| components['schemas']['ScaleLatentsInvocation']
| components['schemas']['ImageToLatentsInvocation']
| components['schemas']['AddInvocation']
| components['schemas']['SubtractInvocation']
| components['schemas']['MultiplyInvocation']
| components['schemas']['DivideInvocation']
| components['schemas']['RandomIntInvocation']
| components['schemas']['NoiseInvocation']
| components['schemas']['ONNXPromptInvocation']
| components['schemas']['ONNXTextToLatentsInvocation']
| components['schemas']['ONNXLatentsToImageInvocation']
| components['schemas']['ONNXSD1ModelLoaderInvocation']
| components['schemas']['OnnxModelLoaderInvocation']
| components['schemas']['DynamicPromptInvocation']
| components['schemas']['PromptsFromFileInvocation']
| components['schemas']['ParamIntInvocation']
| components['schemas']['ParamFloatInvocation']
| components['schemas']['ParamStringInvocation']
| components['schemas']['ParamPromptInvocation']
| components['schemas']['FloatLinearRangeInvocation']
| components['schemas']['StepParamEasingInvocation']
| components['schemas']['SDXLModelLoaderInvocation']
| components['schemas']['SDXLRefinerModelLoaderInvocation']
| components['schemas']['ESRGANInvocation']
| components['schemas']['GraphInvocation']
| components['schemas']['IterateInvocation']
| components['schemas']['CollectInvocation']
| components['schemas']['CannyImageProcessorInvocation']
| components['schemas']['HedImageProcessorInvocation']
| components['schemas']['LineartImageProcessorInvocation']
| components['schemas']['LineartAnimeImageProcessorInvocation']
| components['schemas']['OpenposeImageProcessorInvocation']
| components['schemas']['MidasDepthImageProcessorInvocation']
| components['schemas']['NormalbaeImageProcessorInvocation']
| components['schemas']['MlsdImageProcessorInvocation']
| components['schemas']['PidiImageProcessorInvocation']
| components['schemas']['ContentShuffleImageProcessorInvocation']
| components['schemas']['ZoeDepthImageProcessorInvocation']
| components['schemas']['MediapipeFaceProcessorInvocation']
| components['schemas']['LeresImageProcessorInvocation']
| components['schemas']['TileResamplerProcessorInvocation']
| components['schemas']['SegmentAnythingProcessorInvocation'];
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['GraphExecutionState'];
};
};
/** @description Invalid node or link */
400: never;
/** @description Session not found */
404: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Delete Node
* @description Deletes a node in the graph and removes all linked edges
*/
delete_node: {
parameters: {
path: {
/** @description The id of the session */
session_id: string;
/** @description The path to the node to delete */
node_path: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['GraphExecutionState'];
};
};
/** @description Invalid node or link */
400: never;
/** @description Session not found */
404: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Add Edge
* @description Adds an edge to the graph
*/
add_edge: {
parameters: {
path: {
/** @description The id of the session */
session_id: string;
};
};
requestBody: {
content: {
'application/json': components['schemas']['Edge'];
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['GraphExecutionState'];
};
};
/** @description Invalid node or link */
400: never;
/** @description Session not found */
404: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Delete Edge
* @description Deletes an edge from the graph
*/
delete_edge: {
parameters: {
path: {
/** @description The id of the session */
session_id: string;
/** @description The id of the node the edge is coming from */
from_node_id: string;
/** @description The field of the node the edge is coming from */
from_field: string;
/** @description The id of the node the edge is going to */
to_node_id: string;
/** @description The field of the node the edge is going to */
to_field: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['GraphExecutionState'];
};
};
/** @description Invalid node or link */
400: never;
/** @description Session not found */
404: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Invoke Session
* @description Invokes a session
*/
invoke_session: {
parameters: {
query?: {
/** @description Whether or not to invoke all remaining invocations */
all?: boolean;
};
path: {
/** @description The id of the session to invoke */
session_id: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': unknown;
};
};
/** @description The invocation is queued */
202: never;
/** @description The session has no invocations ready to invoke */
400: never;
/** @description Session not found */
404: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Cancel Session Invoke
* @description Invokes a session
*/
cancel_session_invoke: {
parameters: {
path: {
/** @description The id of the session to cancel */
session_id: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': unknown;
};
};
/** @description The invocation is canceled */
202: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* List Models
* @description Gets a list of models
*/
list_models: {
parameters: {
query?: {
/** @description Base models to include */
base_models?: components['schemas']['BaseModelType'][];
/** @description The type of model to get */
model_type?: components['schemas']['ModelType'];
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['ModelsList'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Delete Model
* @description Delete Model
*/
del_model: {
parameters: {
path: {
/** @description Base model */
base_model: components['schemas']['BaseModelType'];
/** @description The type of model */
model_type: components['schemas']['ModelType'];
/** @description model name */
model_name: string;
};
};
responses: {
/** @description Model deleted successfully */
204: never;
/** @description Model not found */
404: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Update Model
* @description Update model contents with a new config. If the model name or base fields are changed, then the model is renamed.
*/
update_model: {
parameters: {
path: {
/** @description Base model */
base_model: components['schemas']['BaseModelType'];
/** @description The type of model */
model_type: components['schemas']['ModelType'];
/** @description model name */
model_name: string;
};
};
requestBody: {
content: {
'application/json':
| components['schemas']['ONNXStableDiffusion1ModelConfig']
| components['schemas']['StableDiffusion1ModelCheckpointConfig']
| components['schemas']['StableDiffusion1ModelDiffusersConfig']
| components['schemas']['VaeModelConfig']
| components['schemas']['LoRAModelConfig']
| components['schemas']['ControlNetModelCheckpointConfig']
| components['schemas']['ControlNetModelDiffusersConfig']
| components['schemas']['TextualInversionModelConfig']
| components['schemas']['ONNXStableDiffusion2ModelConfig']
| components['schemas']['StableDiffusion2ModelCheckpointConfig']
| components['schemas']['StableDiffusion2ModelDiffusersConfig']
| components['schemas']['StableDiffusionXLModelCheckpointConfig']
| components['schemas']['StableDiffusionXLModelDiffusersConfig'];
};
};
responses: {
/** @description The model was updated successfully */
200: {
content: {
'application/json':
| components['schemas']['ONNXStableDiffusion1ModelConfig']
| components['schemas']['StableDiffusion1ModelCheckpointConfig']
| components['schemas']['StableDiffusion1ModelDiffusersConfig']
| components['schemas']['VaeModelConfig']
| components['schemas']['LoRAModelConfig']
| components['schemas']['ControlNetModelCheckpointConfig']
| components['schemas']['ControlNetModelDiffusersConfig']
| components['schemas']['TextualInversionModelConfig']
| components['schemas']['ONNXStableDiffusion2ModelConfig']
| components['schemas']['StableDiffusion2ModelCheckpointConfig']
| components['schemas']['StableDiffusion2ModelDiffusersConfig']
| components['schemas']['StableDiffusionXLModelCheckpointConfig']
| components['schemas']['StableDiffusionXLModelDiffusersConfig'];
};
};
/** @description Bad request */
400: never;
/** @description The model could not be found */
404: never;
/** @description There is already a model corresponding to the new name */
409: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Import Model
* @description Add a model using its local path, repo_id, or remote URL. Model characteristics will be probed and configured automatically
*/
import_model: {
requestBody: {
content: {
'application/json': components['schemas']['Body_import_model'];
};
};
responses: {
/** @description The model imported successfully */
201: {
content: {
'application/json':
| components['schemas']['ONNXStableDiffusion1ModelConfig']
| components['schemas']['StableDiffusion1ModelCheckpointConfig']
| components['schemas']['StableDiffusion1ModelDiffusersConfig']
| components['schemas']['VaeModelConfig']
| components['schemas']['LoRAModelConfig']
| components['schemas']['ControlNetModelCheckpointConfig']
| components['schemas']['ControlNetModelDiffusersConfig']
| components['schemas']['TextualInversionModelConfig']
| components['schemas']['ONNXStableDiffusion2ModelConfig']
| components['schemas']['StableDiffusion2ModelCheckpointConfig']
| components['schemas']['StableDiffusion2ModelDiffusersConfig']
| components['schemas']['StableDiffusionXLModelCheckpointConfig']
| components['schemas']['StableDiffusionXLModelDiffusersConfig'];
};
};
/** @description The model could not be found */
404: never;
/** @description There is already a model corresponding to this path or repo_id */
409: never;
/** @description Unrecognized file/folder format */
415: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
/** @description The model appeared to import successfully, but could not be found in the model manager */
424: never;
};
};
/**
* Add Model
* @description Add a model using the configuration information appropriate for its type. Only local models can be added by path
*/
add_model: {
requestBody: {
content: {
'application/json':
| components['schemas']['ONNXStableDiffusion1ModelConfig']
| components['schemas']['StableDiffusion1ModelCheckpointConfig']
| components['schemas']['StableDiffusion1ModelDiffusersConfig']
| components['schemas']['VaeModelConfig']
| components['schemas']['LoRAModelConfig']
| components['schemas']['ControlNetModelCheckpointConfig']
| components['schemas']['ControlNetModelDiffusersConfig']
| components['schemas']['TextualInversionModelConfig']
| components['schemas']['ONNXStableDiffusion2ModelConfig']
| components['schemas']['StableDiffusion2ModelCheckpointConfig']
| components['schemas']['StableDiffusion2ModelDiffusersConfig']
| components['schemas']['StableDiffusionXLModelCheckpointConfig']
| components['schemas']['StableDiffusionXLModelDiffusersConfig'];
};
};
responses: {
/** @description The model added successfully */
201: {
content: {
'application/json':
| components['schemas']['ONNXStableDiffusion1ModelConfig']
| components['schemas']['StableDiffusion1ModelCheckpointConfig']
| components['schemas']['StableDiffusion1ModelDiffusersConfig']
| components['schemas']['VaeModelConfig']
| components['schemas']['LoRAModelConfig']
| components['schemas']['ControlNetModelCheckpointConfig']
| components['schemas']['ControlNetModelDiffusersConfig']
| components['schemas']['TextualInversionModelConfig']
| components['schemas']['ONNXStableDiffusion2ModelConfig']
| components['schemas']['StableDiffusion2ModelCheckpointConfig']
| components['schemas']['StableDiffusion2ModelDiffusersConfig']
| components['schemas']['StableDiffusionXLModelCheckpointConfig']
| components['schemas']['StableDiffusionXLModelDiffusersConfig'];
};
};
/** @description The model could not be found */
404: never;
/** @description There is already a model corresponding to this path or repo_id */
409: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
/** @description The model appeared to add successfully, but could not be found in the model manager */
424: never;
};
};
/**
* Convert Model
* @description Convert a checkpoint model into a diffusers model, optionally saving to the indicated destination directory, or `models` if none.
*/
convert_model: {
parameters: {
query?: {
/** @description Save the converted model to the designated directory */
convert_dest_directory?: string;
};
path: {
/** @description Base model */
base_model: components['schemas']['BaseModelType'];
/** @description The type of model */
model_type: components['schemas']['ModelType'];
/** @description model name */
model_name: string;
};
};
responses: {
/** @description Model converted successfully */
200: {
content: {
'application/json':
| components['schemas']['ONNXStableDiffusion1ModelConfig']
| components['schemas']['StableDiffusion1ModelCheckpointConfig']
| components['schemas']['StableDiffusion1ModelDiffusersConfig']
| components['schemas']['VaeModelConfig']
| components['schemas']['LoRAModelConfig']
| components['schemas']['ControlNetModelCheckpointConfig']
| components['schemas']['ControlNetModelDiffusersConfig']
| components['schemas']['TextualInversionModelConfig']
| components['schemas']['ONNXStableDiffusion2ModelConfig']
| components['schemas']['StableDiffusion2ModelCheckpointConfig']
| components['schemas']['StableDiffusion2ModelDiffusersConfig']
| components['schemas']['StableDiffusionXLModelCheckpointConfig']
| components['schemas']['StableDiffusionXLModelDiffusersConfig'];
};
};
/** @description Bad request */
400: never;
/** @description Model not found */
404: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/** Search For Models */
search_for_models: {
parameters: {
query: {
/** @description Directory path to search for models */
search_path: string;
};
};
responses: {
/** @description Directory searched successfully */
200: {
content: {
'application/json': string[];
};
};
/** @description Invalid directory path */
404: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* List Ckpt Configs
* @description Return a list of the legacy checkpoint configuration files stored in `ROOT/configs/stable-diffusion`, relative to ROOT.
*/
list_ckpt_configs: {
responses: {
/** @description paths retrieved successfully */
200: {
content: {
'application/json': string[];
};
};
};
};
/**
* Sync To Config
* @description Call after making changes to models.yaml, autoimport directories or models directory to synchronize
* in-memory data structures with disk data structures.
*/
sync_to_config: {
responses: {
/** @description synchronization successful */
201: {
content: {
'application/json': boolean;
};
};
};
};
/**
* Merge Models
* @description Convert a checkpoint model into a diffusers model
*/
merge_models: {
parameters: {
path: {
/** @description Base model */
base_model: components['schemas']['BaseModelType'];
};
};
requestBody: {
content: {
'application/json': components['schemas']['Body_merge_models'];
};
};
responses: {
/** @description Model converted successfully */
200: {
content: {
'application/json':
| components['schemas']['ONNXStableDiffusion1ModelConfig']
| components['schemas']['StableDiffusion1ModelCheckpointConfig']
| components['schemas']['StableDiffusion1ModelDiffusersConfig']
| components['schemas']['VaeModelConfig']
| components['schemas']['LoRAModelConfig']
| components['schemas']['ControlNetModelCheckpointConfig']
| components['schemas']['ControlNetModelDiffusersConfig']
| components['schemas']['TextualInversionModelConfig']
| components['schemas']['ONNXStableDiffusion2ModelConfig']
| components['schemas']['StableDiffusion2ModelCheckpointConfig']
| components['schemas']['StableDiffusion2ModelDiffusersConfig']
| components['schemas']['StableDiffusionXLModelCheckpointConfig']
| components['schemas']['StableDiffusionXLModelDiffusersConfig'];
};
};
/** @description Incompatible models */
400: never;
/** @description One or more models not found */
404: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Upload Image
* @description Uploads an image
*/
upload_image: {
parameters: {
query: {
/** @description The category of the image */
image_category: components['schemas']['ImageCategory'];
/** @description Whether this is an intermediate image */
is_intermediate: boolean;
/** @description The board to add this image to, if any */
board_id?: string;
/** @description The session ID associated with this upload, if any */
session_id?: string;
/** @description Whether to crop the image */
crop_visible?: boolean;
};
};
requestBody: {
content: {
'multipart/form-data': components['schemas']['Body_upload_image'];
};
};
responses: {
/** @description The image was uploaded successfully */
201: {
content: {
'application/json': components['schemas']['ImageDTO'];
};
};
/** @description Image upload failed */
415: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Get Image Dto
* @description Gets an image's DTO
*/
get_image_dto: {
parameters: {
path: {
/** @description The name of image to get */
image_name: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['ImageDTO'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Delete Image
* @description Deletes an image
*/
delete_image: {
parameters: {
path: {
/** @description The name of the image to delete */
image_name: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': unknown;
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Update Image
* @description Updates an image
*/
update_image: {
parameters: {
path: {
/** @description The name of the image to update */
image_name: string;
};
};
requestBody: {
content: {
'application/json': components['schemas']['ImageRecordChanges'];
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['ImageDTO'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Clear Intermediates
* @description Clears all intermediates
*/
clear_intermediates: {
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': unknown;
};
};
};
};
/**
* Get Image Metadata
* @description Gets an image's metadata
*/
get_image_metadata: {
parameters: {
path: {
/** @description The name of image to get */
image_name: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['ImageMetadata'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Get Image Full
* @description Gets a full-resolution image file
*/
get_image_full: {
parameters: {
path: {
/** @description The name of full-resolution image file to get */
image_name: string;
};
};
responses: {
/** @description Return the full-resolution image */
200: {
content: {
'image/png': unknown;
};
};
/** @description Image not found */
404: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Get Image Thumbnail
* @description Gets a thumbnail image file
*/
get_image_thumbnail: {
parameters: {
path: {
/** @description The name of thumbnail image file to get */
image_name: string;
};
};
responses: {
/** @description Return the image thumbnail */
200: {
content: {
'image/webp': unknown;
};
};
/** @description Image not found */
404: never;
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Get Image Urls
* @description Gets an image and thumbnail URL
*/
get_image_urls: {
parameters: {
path: {
/** @description The name of the image whose URL to get */
image_name: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['ImageUrlsDTO'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* List Image Dtos
* @description Gets a list of image DTOs
*/
list_image_dtos: {
parameters: {
query?: {
/** @description The origin of images to list. */
image_origin?: components['schemas']['ResourceOrigin'];
/** @description The categories of image to include. */
categories?: components['schemas']['ImageCategory'][];
/** @description Whether to list intermediate images. */
is_intermediate?: boolean;
/** @description The board id to filter by. Use 'none' to find images without a board. */
board_id?: string;
/** @description The page offset */
offset?: number;
/** @description The number of images per page */
limit?: number;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['OffsetPaginatedResults_ImageDTO_'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/** Delete Images From List */
delete_images_from_list: {
requestBody: {
content: {
'application/json': components['schemas']['Body_delete_images_from_list'];
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['DeleteImagesFromListResult'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/** Star Images In List */
star_images_in_list: {
requestBody: {
content: {
'application/json': components['schemas']['Body_star_images_in_list'];
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': unknown;
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/** Unstar Images In List */
unstar_images_in_list: {
requestBody: {
content: {
'application/json': components['schemas']['Body_unstar_images_in_list'];
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': unknown;
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* List Boards
* @description Gets a list of boards
*/
list_boards: {
parameters: {
query?: {
/** @description Whether to list all boards */
all?: boolean;
/** @description The page offset */
offset?: number;
/** @description The number of boards per page */
limit?: number;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json':
| components['schemas']['OffsetPaginatedResults_BoardDTO_']
| components['schemas']['BoardDTO'][];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Create Board
* @description Creates a board
*/
create_board: {
parameters: {
query: {
/** @description The name of the board to create */
board_name: string;
};
};
responses: {
/** @description The board was created successfully */
201: {
content: {
'application/json': components['schemas']['BoardDTO'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Get Board
* @description Gets a board
*/
get_board: {
parameters: {
path: {
/** @description The id of board to get */
board_id: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['BoardDTO'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Delete Board
* @description Deletes a board
*/
delete_board: {
parameters: {
query?: {
/** @description Permanently delete all images on the board */
include_images?: boolean;
};
path: {
/** @description The id of board to delete */
board_id: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['DeleteBoardResult'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Update Board
* @description Updates a board
*/
update_board: {
parameters: {
path: {
/** @description The id of board to update */
board_id: string;
};
};
requestBody: {
content: {
'application/json': components['schemas']['BoardChanges'];
};
};
responses: {
/** @description The board was updated successfully */
201: {
content: {
'application/json': components['schemas']['BoardDTO'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* List All Board Image Names
* @description Gets a list of images for a board
*/
list_all_board_image_names: {
parameters: {
path: {
/** @description The id of the board */
board_id: string;
};
};
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': string[];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Add Image To Board
* @description Creates a board_image
*/
add_image_to_board: {
requestBody: {
content: {
'application/json': components['schemas']['Body_add_image_to_board'];
};
};
responses: {
/** @description The image was added to a board successfully */
201: {
content: {
'application/json': unknown;
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Remove Image From Board
* @description Removes an image from its board, if it had one
*/
remove_image_from_board: {
requestBody: {
content: {
'application/json': components['schemas']['Body_remove_image_from_board'];
};
};
responses: {
/** @description The image was removed from the board successfully */
201: {
content: {
'application/json': unknown;
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Add Images To Board
* @description Adds a list of images to a board
*/
add_images_to_board: {
requestBody: {
content: {
'application/json': components['schemas']['Body_add_images_to_board'];
};
};
responses: {
/** @description Images were added to board successfully */
201: {
content: {
'application/json': components['schemas']['AddImagesToBoardResult'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/**
* Remove Images From Board
* @description Removes a list of images from their board, if they had one
*/
remove_images_from_board: {
requestBody: {
content: {
'application/json': components['schemas']['Body_remove_images_from_board'];
};
};
responses: {
/** @description Images were removed from board successfully */
201: {
content: {
'application/json': components['schemas']['RemoveImagesFromBoardResult'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
/** Get Version */
app_version: {
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['AppVersion'];
};
};
};
};
/** Get Config */
get_config: {
responses: {
/** @description Successful Response */
200: {
content: {
'application/json': components['schemas']['AppConfig'];
};
};
};
};
/**
* Get Log Level
* @description Returns the log level
*/
get_log_level: {
responses: {
/** @description The operation was successful */
200: {
content: {
'application/json': components['schemas']['LogLevel'];
};
};
};
};
/**
* Set Log Level
* @description Sets the log verbosity level
*/
set_log_level: {
requestBody: {
content: {
'application/json': components['schemas']['LogLevel'];
};
};
responses: {
/** @description The operation was successful */
200: {
content: {
'application/json': components['schemas']['LogLevel'];
};
};
/** @description Validation Error */
422: {
content: {
'application/json': components['schemas']['HTTPValidationError'];
};
};
};
};
};