openai: appmixer.openai.core.createImageEdit

Basic Information

Name

appmixer.openai.core.createImageEdit

Version

1.0.0

Visibility

Public

Description

Creates an edited or extended image given an original image and a prompt.

Properties

Field	Type	Description
No properties defined

Input Ports

in

Field	Type	Description
Image	filepicker	The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.
Prompt	text	A text description of the desired image(s). The maximum length is 1000 characters. Example: A cute baby sea otter wearing a beret
Mask	filepicker	An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where `image` should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as `image`.
Model	text	The model to use for image generation. Only `dall-e-2` is supported at this time. Example: dall-e-2
N	number	The number of images to generate. Must be between 1 and 10. Example: 1
Size	select	The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`. Example: 1024x1024
Response Format	select	The format in which the generated images are returned. Must be one of `url` or `b64_json`. Example: url
User	text	A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more. Example: user-1234

Output Ports

out

Field	Type	Description
Created		-
Data		-

Full Metadata

#metadata-viewer { display: none; }{ "version": "1.0.0", "name": "appmixer.openai.core.createImageEdit", "author": "Appmixer <info@appmixer.com>", "description": "<label>Creates an edited or extended image given an original image and a prompt.</label>", "private": false, "inPorts": [ { "name": "in", "schema": { "type": "object", "required": [ "prompt", "image" ], "properties": { "image": { "description": "The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.", "type": "string", "path": "image" }, "prompt": { "description": "A text description of the desired image(s). The maximum length is 1000 characters.", "type": "string", "example": "A cute baby sea otter wearing a beret", "path": "prompt" }, "mask": { "description": "An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where `image` should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as `image`.", "type": "string", "path": "mask" }, "model": { "x-oaiTypeLabel": "string", "default": "dall-e-2", "example": "dall-e-2", "nullable": true, "description": "The model to use for image generation. Only `dall-e-2` is supported at this time.", "type": "string", "path": "model" }, "n": { "type": "integer", "minimum": 1, "maximum": 10, "default": 1, "example": 1, "nullable": true, "description": "The number of images to generate. Must be between 1 and 10.", "path": "n" }, "size": { "type": "string", "enum": [ "256x256", "512x512", "1024x1024" ], "default": "1024x1024", "example": "1024x1024", "nullable": true, "description": "The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.", "path": "size" }, "response_format": { "type": "string", "enum": [ "url", "b64_json" ], "default": "url", "example": "url", "nullable": true, "description": "The format in which the generated images are returned. Must be one of `url` or `b64_json`.", "path": "response_format" }, "user": { "type": "string", "example": "user-1234", "description": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).\n", "path": "user" } } }, "inspector": { "inputs": { "image": { "type": "filepicker", "index": 0, "label": "Image", "tooltip": "The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask." }, "prompt": { "type": "text", "index": 1, "label": "Prompt", "tooltip": "A text description of the desired image(s). The maximum length is 1000 characters. Example: A cute baby sea otter wearing a beret" }, "mask": { "type": "filepicker", "index": 2, "label": "Mask", "tooltip": "An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where <code>image</code> should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as <code>image</code>." }, "model": { "type": "text", "index": 3, "label": "Model", "tooltip": "The model to use for image generation. Only <code>dall-e-2</code> is supported at this time. Example: dall-e-2", "defaultValue": "dall-e-2" }, "n": { "type": "number", "index": 4, "label": "N", "tooltip": "The number of images to generate. Must be between 1 and 10. Example: 1", "defaultValue": 1, "min": 1, "max": 10 }, "size": { "type": "select", "index": 5, "label": "Size", "tooltip": "The size of the generated images. Must be one of <code>256x256</code>, <code>512x512</code>, or <code>1024x1024</code>. Example: 1024x1024", "options": [ { "content": "256x256", "value": "256x256" }, { "content": "512x512", "value": "512x512" }, { "content": "1024x1024", "value": "1024x1024" } ], "defaultValue": "1024x1024" }, "response_format": { "type": "select", "index": 6, "label": "Response Format", "tooltip": "The format in which the generated images are returned. Must be one of <code>url</code> or <code>b64_json</code>. Example: url", "options": [ { "content": "url", "value": "url" }, { "content": "b64_json", "value": "b64_json" } ], "defaultValue": "url" }, "user": { "type": "text", "index": 7, "label": "User", "tooltip": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. <a href=\"https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids\" rel=\"noopener noreferrer\" target=\"_blank\">Learn more</a>.\n Example: user-1234" } } } } ], "outPorts": [ { "name": "out", "options": [ { "label": "Created", "value": "created", "schema": { "example": 1737024600 } }, { "label": "Data", "value": "data", "schema": { "type": "array", "items": { "type": "object", "description": "Represents the url or the content of an image generated by the OpenAI API.", "x-oaiMeta": { "name": "The image object", "example": "{\n \"url\": \"...\",\n \"revised_prompt\": \"...\"\n}\n" }, "properties": { "b64_json": { "type": "string", "description": "The base64-encoded JSON of the generated image, if `response_format` is `b64_json`." }, "url": { "type": "string", "description": "The URL of the generated image, if `response_format` is `url` (default)." }, "revised_prompt": { "type": "string", "description": "The prompt that was used to generate the image, if there was any revision to the prompt." } } }, "example": [ { "url": "https://oaidalleapiprodscus.blob.core.windows.net/private/generated-image.png" } ] } } ] } ], "properties": {}, "auth": { "service": "appmixer:openai" }, "icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNHB4IiBoZWlnaHQ9IjI0cHgiIGZpbGw9ImN1cnJlbnRDb2xvciIgdmlld0JveD0iMCAwIDI0IDI0IiBjb2xvcj0iYmxhY2siPjxwYXRoIGQ9Ik0yMi40MTggOS44MjJhNS45MDMgNS45MDMgMCAwIDAtLjUyLTQuOTEgNi4xIDYuMSAwIDAgMC0yLjgyMi0yLjUxMyA2LjIwNCA2LjIwNCAwIDAgMC0zLjc4LS4zODlBNi4wNTUgNi4wNTUgMCAwIDAgMTMuMjMyLjUxOCA2LjEyOSA2LjEyOSAwIDAgMCAxMC43MjYgMGE2LjE4NSA2LjE4NSAwIDAgMC0zLjYxNSAxLjE1M0E2LjA1MiA2LjA1MiAwIDAgMCA0Ljg4IDQuMTg3YTYuMTAyIDYuMTAyIDAgMCAwLTIuMzQ0IDEuMDE4QTYuMDA4IDYuMDA4IDAgMCAwIC44MjggNy4wODdhNS45ODEgNS45ODEgMCAwIDAgLjc1NCA3LjA5IDUuOTA0IDUuOTA0IDAgMCAwIC41MiA0LjkxMSA2LjEwMSA2LjEwMSAwIDAgMCAyLjgyMSAyLjUxMyA2LjIwNSA2LjIwNSAwIDAgMCAzLjc4LjM4OSA2LjA1NyA2LjA1NyAwIDAgMCAyLjA2NSAxLjQ5MiA2LjEzIDYuMTMgMCAwIDAgMi41MDUuNTE4IDYuMTg1IDYuMTg1IDAgMCAwIDMuNjE3LTEuMTU0IDYuMDUyIDYuMDUyIDAgMCAwIDIuMjMyLTMuMDM1IDYuMTAxIDYuMTAxIDAgMCAwIDIuMzQzLTEuMDE4IDYuMDA5IDYuMDA5IDAgMCAwIDEuNzA5LTEuODgzIDUuOTgxIDUuOTgxIDAgMCAwLS43NTYtNy4wODhabS05LjE0MyAxMi42MDlhNC41ODMgNC41ODMgMCAwIDEtMi45MTgtMS4wNGMuMDM3LS4wMi4xMDItLjA1Ni4xNDQtLjA4MWw0Ljg0NC0yLjc2YS43ODMuNzgzIDAgMCAwIC4zOTctLjY4di02LjczOEwxNy43OSAxMi4zYS4wNzIuMDcyIDAgMCAxIC4wNC4wNTV2NS41OGE0LjQ3MyA0LjQ3MyAwIDAgMS0xLjMzNSAzLjE3NiA0LjU5NiA0LjU5NiAwIDAgMS0zLjIxOSAxLjMyMVptLTkuNzkzLTQuMTI3YTQuNDMyIDQuNDMyIDAgMCAxLS41NDQtMy4wMTRjLjAzNi4wMjEuMDk5LjA2LjE0NC4wODVsNC44NDMgMi43NmEuNzk2Ljc5NiAwIDAgMCAuNzk1IDBsNS45MTMtMy4zNjlWMTcuMWEuMDcxLjA3MSAwIDAgMS0uMDI5LjA2Mkw5LjcwOCAxOS45NWE0LjYxNyA0LjYxNyAwIDAgMS0zLjQ1OC40NDcgNC41NTYgNC41NTYgMCAwIDEtMi43NjgtMi4wOTNaTTIuMjA4IDcuODcyQTQuNTI3IDQuNTI3IDAgMCAxIDQuNTggNS45bC0uMDAyLjE2NHY1LjUyYS43NjguNzY4IDAgMCAwIC4zOTcuNjhsNS45MTMgMy4zNjktMi4wNDcgMS4xNjZhLjA3NS4wNzUgMCAwIDEtLjA2OS4wMDZsLTQuODk2LTIuNzkyYTQuNTEgNC41MSAwIDAgMS0yLjEyLTIuNzMgNC40NSA0LjQ1IDAgMCAxIC40NTItMy40MTFabTE2LjgxOCAzLjg2MS01LjkxMy0zLjM2OCAyLjA0Ny0xLjE2NmEuMDc0LjA3NCAwIDAgMSAuMDctLjAwNmw0Ljg5NiAyLjc4OWE0LjUyNiA0LjUyNiAwIDAgMSAxLjc2MiAxLjgxNSA0LjQ0OCA0LjQ0OCAwIDAgMS0uNDE4IDQuODA4IDQuNTU2IDQuNTU2IDAgMCAxLTIuMDQ5IDEuNDk0di01LjY4NmEuNzY3Ljc2NyAwIDAgMC0uMzk1LS42OFptMi4wMzgtMy4wMjVhNi44NzQgNi44NzQgMCAwIDAtLjE0NC0uMDg1bC00Ljg0My0yLjc2YS43OTcuNzk3IDAgMCAwLS43OTYgMEw5LjM2OCA5LjIzVjYuOWEuMDcyLjA3MiAwIDAgMSAuMDMtLjA2Mmw0Ljg5NS0yLjc4N2E0LjYwOCA0LjYwOCAwIDAgMSA0Ljg4NS4yMDcgNC41MSA0LjUxIDAgMCAxIDEuNTk5IDEuOTU1Yy4zMzMuNzg4LjQzMyAxLjY1NC4yODcgMi40OTZaTTguMjU1IDEyLjg2NSA2LjIwOCAxMS43YS4wNzEuMDcxIDAgMCAxLS4wNC0uMDU2di01LjU4YzAtLjg1NC4yNDgtMS42OS43MTMtMi40MTJhNC41NCA0LjU0IDAgMCAxIDEuOTEzLTEuNjU4IDQuNjE0IDQuNjE0IDAgMCAxIDQuODUuNjE2Yy0uMDM3LjAyLS4xMDIuMDU1LS4xNDQuMDhMOC42NTcgNS40NTJhLjc4Mi43ODIgMCAwIDAtLjM5OC42OGwtLjAwNCA2LjczNFpNOS4zNjcgMTAuNSAxMi4wMDEgOWwyLjYzMyAxLjV2M0wxMi4wMDEgMTVsLTIuNjM0LTEuNXYtM1oiLz48L3N2Zz4=" }