url or an uploadId as the source for the uploaded image. \n Note: Only allow listed domains are allowed to be accepted as input URL in the request. The allow-listed domains are as follows: \n amazonaws.comwindows.netdropboxusercontent.comurl or an uploadId as the source for the uploaded image. \n Note: Only allow listed domains are allowed to be accepted as input URL in the request. The allow-listed domains are as follows: \n amazonaws.comwindows.netdropboxusercontent.comNote: Placement for source images cannot be used when a mask image is being applied.
" } }, "type": "object", "required": ["image"], "description": "Images expand payload" }, "ExpandImageResponse": { "properties": { "size": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "title": "The actual size used for the outputs", "description": "If size was passed as input, this value should be the same as the one passed as input." }, "outputs": { "items": { "$ref": "#/components/schemas/OutputImage" }, "type": "array", "minItems": 1, "title": "The list of images", "description": "Each image will have a storage item." } }, "type": "object", "required": ["size", "outputs"], "description": "Images expand response" }, "ExpandInputImage": { "properties": { "source": { "allOf": [ { "$ref": "#/components/schemas/PublicBinaryInput" } ], "title": "Source image", "description": "Source of the image to be expanded." }, "mask": { "allOf": [ { "$ref": "#/components/schemas/PublicBinaryInput" } ], "title": "Mask image", "description": "Defines the expanding area where the source image should expand towards. Mask has to be larger than the source image, and the target size has to match the size of the mask, or it will be inferred from the mask." } }, "type": "object", "required": ["source"], "title": "ExpandInputImage" }, "FillImageRequest": { "properties": { "numVariations": { "type": "integer", "maximum": 4, "minimum": 1, "title": "The number of variations", "description": "The number of variations to generate. numVariations will default to the number of seeds, or to 1 if seeds is not specified." }, "seeds": { "items": { "type": "integer" }, "type": "array", "maxItems": 4, "minItems": 1, "uniqueItems": true, "default": [0], "title": "The seed of each variation", "description": "Array of seed(s) that ensure consistent image generation across multiple API calls. For example, you can use the same seed to generate a similar image with different styles. If specified alongside with numVariations, the number of seeds must be the equal to numVariations" }, "prompt": { "type": "string", "maxLength": 1024, "minLength": 1, "title": "The prompt", "description": "The prompt used to generate the image. The longer the prompt - the better" }, "negativePrompt": { "type": "string", "maxLength": 1024, "title": "Avoid prompt", "description": "Inference will try to generate against this prompt" }, "image": { "allOf": [ { "$ref": "#/components/schemas/InputImage" } ], "title": "Input Image", "description": "Input image to fill with generative content. You can either use aurl or an uploadId as the source for the uploaded image. \n Note: Only allow listed domains are allowed to be accepted as input URL in the request. The allow-listed domains are as follows: \n amazonaws.comwindows.netdropboxusercontent.comurl or an uploadId as the source for the uploaded image. \n Note: Only allow listed domains are allowed to be accepted as input URL in the request. The allow-listed domains are as follows: \n amazonaws.comwindows.netdropboxusercontent.comurl or an uploadId as the source for the uploaded image."
},
"PublicBinaryOutput": {
"properties": {
"url": {
"type": "string",
"maxLength": 2083,
"minLength": 1,
"format": "uri",
"title": "The presigned url",
"description": "The reference to signed url of the image."
}
},
"type": "object",
"title": "PublicBinaryOutput",
"description": "A valid storage item containing a pre-signed URL. The pre-signed URL will expire in one hour."
},
"OutputImage": {
"properties": {
"seed": {
"type": "integer",
"title": "The seed used for the generation",
"description": "Identifier used to customize image generation processes."
},
"image": {
"allOf": [
{
"$ref": "#/components/schemas/PublicBinaryOutput"
}
],
"title": "The pre-signed URL used to download the image",
"description": "A valid storage item containing a pre-signed URL. The pre-signed URL will expire in one hour."
}
},
"type": "object",
"required": ["seed", "image"],
"title": "OutputImage"
},
"Placement": {
"properties": {
"inset": {
"allOf": [
{
"$ref": "#/components/schemas/PlacementInset"
}
],
"title": "Margin values in target size",
"description": "Defines the inward displacement applied to the image's edges. This parameter specifies the distance by which each edge of the image will be pushed inward, thereby reducing the visible area by the specified amount on all sides."
},
"alignment": {
"allOf": [
{
"$ref": "#/components/schemas/PlacementAlignment"
}
],
"title": "Alignment",
"description": "Specifies how the image will be anchored within the available space for each direction. For horizontal, (0,1,2)=(center, left, right). For vertical, (0,1,2)=(center, top, bottom)."
}
},
"type": "object",
"title": "Placement"
},
"PlacementAlignment": {
"properties": {
"horizontal": {
"allOf": [
{
"$ref": "#/components/schemas/AlignmentHorizontal"
}
],
"default": "center"
},
"vertical": {
"allOf": [
{
"$ref": "#/components/schemas/AlignmentVertical"
}
],
"default": "center"
}
},
"type": "object",
"title": "PlacementAlignment"
},
"PlacementInset": {
"properties": {
"left": {
"type": "integer",
"title": "Left Inset",
"description": "The space between left edge of the result image and left edge of the placed object image."
},
"top": {
"type": "integer",
"title": "Top Inset",
"description": "The space between top edge of the result image and top edge of the placed object image."
},
"right": {
"type": "integer",
"title": "Right Inset",
"description": "The space between right edge of the result image and right edge of the placed object image."
},
"bottom": {
"type": "integer",
"title": "Bottom Inset",
"description": "The space between bottom edge of the result image and bottom edge of the placed object image."
}
},
"type": "object",
"title": "PlacementInset",
"description": "Margin values in target size"
},
"Size": {
"properties": {
"width": {
"type": "integer",
"maximum": 2688,
"minimum": 1,
"title": "The desired width of the output image."
},
"height": {
"type": "integer",
"maximum": 2688,
"minimum": 1,
"title": "The desired height of the output image."
}
},
"description": "Dimensions of the generated image\n | Dimensions | Description | \n | -----------| ----- |\n | { \"width\": 2048, \"height\": 2048} | Square (1:1) |\n | { \"width\": 2304, \"height\": 1792 } | Landscape (4:3) |\n | { \"width\": 1792, \"height\": 2304 } | Portrait (3:4) | \n | { \"width\": 2688, \"height\": 1536 } | Widescreen (16:9) |\n",
"type": "object",
"required": ["width", "height"],
"title": "Size"
},
"StructureImageReference": {
"properties": {
"source": {
"$ref": "#/components/schemas/PublicBinaryInput"
}
},
"type": "object",
"title": "StructureImageReference"
},
"StructureReference": {
"properties": {
"strength": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"title": "Adherence Threshold",
"description": "Control the amount of adherence to the reference image when generating the image variations. 0 means no adherence. 100 means full adherence."
},
"imageReference": {
"allOf": [
{
"$ref": "#/components/schemas/StructureImageReference"
}
],
"title": "A structure reference image",
"description": "An image with a structure you want to use as a reference for generating image variations. \n Note: Only allow listed domains are allowed to be accepted as input URL in the request.\nThe allow-listed domains are as follows: \n amazonaws.comwindows.netdropboxusercontent.comPreset IDs. "
},
"strength": {
"type": "integer",
"maximum": 100,
"exclusiveMinimum": 0,
"title": "The strength of the style",
"description": "The strength of the style to be applied."
},
"imageReference": {
"allOf": [
{
"$ref": "#/components/schemas/StylesImageReference"
}
],
"title": "A style image reference",
"description": "Firefly will detect the style in the image and apply the same style in the generated image. \n Note: Only allow listed domains are allowed to be accepted as input URL in the request. The allow-listed domains are as follows: \n amazonaws.comwindows.netdropboxusercontent.com