@runware/schemas 0.0.0-20260510231619

package/dist/schemas/requests/models/openai/openai-gpt-image-1-mini.json

@@ -0,0 +1,318 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "type": "object",
+  "properties": {
+    "model": {
+      "title": "Model",
+      "description": "Identifier of the model to use for generation.",
+      "type": "string",
+      "const": "openai:1@2"
+    },
+    "inputs": {
+      "title": "Inputs",
+      "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.",
+      "type": "object",
+      "properties": {
+        "referenceImages": {
+          "title": "Reference Images",
+          "description": "List of reference images (UUID, URL, Data URI, or Base64).",
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "title": "Image",
+            "description": "Image input (UUID, URL, Data URI, or Base64).",
+            "type": "string",
+            "anyOf": [
+              {
+                "format": "uuid"
+              },
+              {
+                "format": "uri"
+              },
+              {
+                "pattern": "^data:image\\/[a-zA-Z]+;base64,[a-zA-Z0-9+/=]+$"
+              },
+              {
+                "pattern": "^[a-zA-Z0-9+/=]+$"
+              }
+            ]
+          },
+          "maxItems": 16
+        }
+      },
+      "additionalProperties": false
+    },
+    "positivePrompt": {
+      "title": "Positive Prompt",
+      "description": "Text prompt describing elements to include in the generated output.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 32000
+    },
+    "width": {
+      "title": "Width",
+      "description": "Width of the generated media in pixels.",
+      "type": "integer"
+    },
+    "height": {
+      "title": "Height",
+      "description": "Height of the generated media in pixels.",
+      "type": "integer"
+    },
+    "providerSettings": {
+      "title": "Provider Settings",
+      "description": "Provider-specific configuration settings.",
+      "type": "object",
+      "properties": {
+        "openai": {
+          "title": "OpenAI Settings",
+          "description": "Provider-specific settings for OpenAI.",
+          "type": "object",
+          "properties": {
+            "background": {
+              "title": "Background",
+              "description": "Background handling in generated images.",
+              "type": "string",
+              "oneOf": [
+                {
+                  "const": "auto",
+                  "description": "Automatically determines the most appropriate background based on content."
+                },
+                {
+                  "const": "opaque",
+                  "description": "Solid background, no transparency."
+                },
+                {
+                  "const": "transparent",
+                  "description": "Transparent background areas where applicable."
+                }
+              ],
+              "default": "auto"
+            },
+            "moderation": {
+              "title": "Moderation",
+              "description": "Content moderation level.",
+              "type": "string",
+              "oneOf": [
+                {
+                  "const": "auto",
+                  "description": "Standard filtering that limits creating certain categories of potentially age-inappropriate content."
+                },
+                {
+                  "const": "low",
+                  "description": "Less restrictive filtering."
+                }
+              ],
+              "default": "auto"
+            },
+            "quality": {
+              "title": "Quality",
+              "description": "Image quality level.",
+              "type": "string",
+              "oneOf": [
+                {
+                  "const": "auto",
+                  "description": "Automatically selects optimal quality based on context."
+                },
+                {
+                  "const": "high",
+                  "description": "Maximum quality with enhanced detail and refinement."
+                },
+                {
+                  "const": "medium",
+                  "description": "Balanced quality suitable for most use cases."
+                },
+                {
+                  "const": "low",
+                  "description": "Faster generation with acceptable quality for rapid iteration."
+                }
+              ],
+              "default": "auto"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "imageInference"
+    },
+    "taskUUID": {
+      "title": "Task UUID",
+      "description": "UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.",
+      "type": "string",
+      "format": "uuid"
+    },
+    "webhookURL": {
+      "title": "Webhook URL",
+      "description": "Specifies a webhook URL where JSON responses will be sent via HTTP POST when generation tasks complete. For batch requests with multiple results, each completed item triggers a separate webhook call as it becomes available.",
+      "type": "string",
+      "format": "uri"
+    },
+    "includeCost": {
+      "title": "Include Cost",
+      "description": "Include task cost in the response.",
+      "type": "boolean",
+      "default": false
+    },
+    "numberResults": {
+      "title": "Number of Results",
+      "description": "Number of results to generate. Each result uses a different seed, producing variations of the same parameters.",
+      "type": "integer",
+      "minimum": 1,
+      "default": 1,
+      "maximum": 20
+    },
+    "uploadEndpoint": {
+      "title": "Upload Endpoint",
+      "description": "URL to upload content via HTTP PUT. The request body will contain the raw binary data.",
+      "type": "string",
+      "format": "uri"
+    },
+    "ttl": {
+      "title": "TTL",
+      "description": "Time-to-live (TTL) in seconds for generated content. Only applies when `outputType` is `URL`.",
+      "type": "integer",
+      "minimum": 60
+    },
+    "outputType": {
+      "title": "Output Type",
+      "description": "Image output type.",
+      "type": "string",
+      "enum": [
+        "URL",
+        "base64Data",
+        "dataURI"
+      ],
+      "default": "URL"
+    },
+    "outputFormat": {
+      "title": "Output Format",
+      "description": "File format for the generated image.",
+      "type": "string",
+      "enum": [
+        "JPG",
+        "PNG",
+        "WEBP"
+      ],
+      "default": "JPG"
+    },
+    "outputQuality": {
+      "title": "Output Quality",
+      "description": "Compression quality of the output. Higher values preserve quality but increase file size.",
+      "type": "integer",
+      "minimum": 20,
+      "maximum": 99,
+      "default": 95
+    },
+    "deliveryMethod": {
+      "title": "Delivery Method",
+      "description": "Determines how the API delivers task results.",
+      "type": "string",
+      "oneOf": [
+        {
+          "const": "sync",
+          "description": "Returns complete results directly in the API response."
+        },
+        {
+          "const": "async",
+          "description": "Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse."
+        }
+      ],
+      "default": "sync"
+    },
+    "safety": {
+      "type": "object",
+      "title": "Safety Settings",
+      "description": "Content safety checking configuration for image generation.",
+      "properties": {
+        "checkContent": {
+          "title": "Check Content",
+          "description": "Enable or disable content safety checking. When enabled, defaults to `fast` mode.",
+          "type": "boolean",
+          "default": false
+        },
+        "mode": {
+          "description": "Safety checking mode for image generation.",
+          "type": "string",
+          "oneOf": [
+            {
+              "const": "none",
+              "title": "None",
+              "description": "Disables checking."
+            },
+            {
+              "const": "fast",
+              "title": "Fast",
+              "description": "Performs a single check."
+            }
+          ],
+          "default": "none"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "positivePrompt",
+    "width",
+    "height",
+    "taskType",
+    "taskUUID",
+    "model"
+  ],
+  "allOf": [
+    {
+      "dependentRequired": {
+        "width": [
+          "height"
+        ],
+        "height": [
+          "width"
+        ]
+      }
+    },
+    {
+      "oneOf": [
+        {
+          "title": "1K (1:1)",
+          "properties": {
+            "width": {
+              "const": 1024
+            },
+            "height": {
+              "const": 1024
+            }
+          }
+        },
+        {
+          "title": "1K (3:2)",
+          "properties": {
+            "width": {
+              "const": 1536
+            },
+            "height": {
+              "const": 1024
+            }
+          }
+        },
+        {
+          "title": "1K (2:3)",
+          "properties": {
+            "width": {
+              "const": 1024
+            },
+            "height": {
+              "const": 1536
+            }
+          }
+        }
+      ]
+    }
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/requests/models/openai/openai-gpt-image-1.json

@@ -0,0 +1,318 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "type": "object",
+  "properties": {
+    "model": {
+      "title": "Model",
+      "description": "Identifier of the model to use for generation.",
+      "type": "string",
+      "const": "openai:1@1"
+    },
+    "inputs": {
+      "title": "Inputs",
+      "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.",
+      "type": "object",
+      "properties": {
+        "referenceImages": {
+          "title": "Reference Images",
+          "description": "List of reference images (UUID, URL, Data URI, or Base64).",
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "title": "Image",
+            "description": "Image input (UUID, URL, Data URI, or Base64).",
+            "type": "string",
+            "anyOf": [
+              {
+                "format": "uuid"
+              },
+              {
+                "format": "uri"
+              },
+              {
+                "pattern": "^data:image\\/[a-zA-Z]+;base64,[a-zA-Z0-9+/=]+$"
+              },
+              {
+                "pattern": "^[a-zA-Z0-9+/=]+$"
+              }
+            ]
+          },
+          "maxItems": 16
+        }
+      },
+      "additionalProperties": false
+    },
+    "positivePrompt": {
+      "title": "Positive Prompt",
+      "description": "Text prompt describing elements to include in the generated output.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 32000
+    },
+    "width": {
+      "title": "Width",
+      "description": "Width of the generated media in pixels.",
+      "type": "integer"
+    },
+    "height": {
+      "title": "Height",
+      "description": "Height of the generated media in pixels.",
+      "type": "integer"
+    },
+    "providerSettings": {
+      "title": "Provider Settings",
+      "description": "Provider-specific configuration settings.",
+      "type": "object",
+      "properties": {
+        "openai": {
+          "title": "OpenAI Settings",
+          "description": "Provider-specific settings for OpenAI.",
+          "type": "object",
+          "properties": {
+            "background": {
+              "title": "Background",
+              "description": "Background handling in generated images.",
+              "type": "string",
+              "oneOf": [
+                {
+                  "const": "auto",
+                  "description": "Automatically determines the most appropriate background based on content."
+                },
+                {
+                  "const": "opaque",
+                  "description": "Solid background, no transparency."
+                },
+                {
+                  "const": "transparent",
+                  "description": "Transparent background areas where applicable."
+                }
+              ],
+              "default": "auto"
+            },
+            "moderation": {
+              "title": "Moderation",
+              "description": "Content moderation level.",
+              "type": "string",
+              "oneOf": [
+                {
+                  "const": "auto",
+                  "description": "Standard filtering that limits creating certain categories of potentially age-inappropriate content."
+                },
+                {
+                  "const": "low",
+                  "description": "Less restrictive filtering."
+                }
+              ],
+              "default": "auto"
+            },
+            "quality": {
+              "title": "Quality",
+              "description": "Image quality level.",
+              "type": "string",
+              "oneOf": [
+                {
+                  "const": "auto",
+                  "description": "Automatically selects optimal quality based on context."
+                },
+                {
+                  "const": "high",
+                  "description": "Maximum quality with enhanced detail and refinement."
+                },
+                {
+                  "const": "medium",
+                  "description": "Balanced quality suitable for most use cases."
+                },
+                {
+                  "const": "low",
+                  "description": "Faster generation with acceptable quality for rapid iteration."
+                }
+              ],
+              "default": "auto"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "imageInference"
+    },
+    "taskUUID": {
+      "title": "Task UUID",
+      "description": "UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.",
+      "type": "string",
+      "format": "uuid"
+    },
+    "webhookURL": {
+      "title": "Webhook URL",
+      "description": "Specifies a webhook URL where JSON responses will be sent via HTTP POST when generation tasks complete. For batch requests with multiple results, each completed item triggers a separate webhook call as it becomes available.",
+      "type": "string",
+      "format": "uri"
+    },
+    "includeCost": {
+      "title": "Include Cost",
+      "description": "Include task cost in the response.",
+      "type": "boolean",
+      "default": false
+    },
+    "numberResults": {
+      "title": "Number of Results",
+      "description": "Number of results to generate. Each result uses a different seed, producing variations of the same parameters.",
+      "type": "integer",
+      "minimum": 1,
+      "default": 1,
+      "maximum": 20
+    },
+    "uploadEndpoint": {
+      "title": "Upload Endpoint",
+      "description": "URL to upload content via HTTP PUT. The request body will contain the raw binary data.",
+      "type": "string",
+      "format": "uri"
+    },
+    "ttl": {
+      "title": "TTL",
+      "description": "Time-to-live (TTL) in seconds for generated content. Only applies when `outputType` is `URL`.",
+      "type": "integer",
+      "minimum": 60
+    },
+    "outputType": {
+      "title": "Output Type",
+      "description": "Image output type.",
+      "type": "string",
+      "enum": [
+        "URL",
+        "base64Data",
+        "dataURI"
+      ],
+      "default": "URL"
+    },
+    "outputFormat": {
+      "title": "Output Format",
+      "description": "File format for the generated image.",
+      "type": "string",
+      "enum": [
+        "JPG",
+        "PNG",
+        "WEBP"
+      ],
+      "default": "JPG"
+    },
+    "outputQuality": {
+      "title": "Output Quality",
+      "description": "Compression quality of the output. Higher values preserve quality but increase file size.",
+      "type": "integer",
+      "minimum": 20,
+      "maximum": 99,
+      "default": 95
+    },
+    "deliveryMethod": {
+      "title": "Delivery Method",
+      "description": "Determines how the API delivers task results.",
+      "type": "string",
+      "oneOf": [
+        {
+          "const": "sync",
+          "description": "Returns complete results directly in the API response."
+        },
+        {
+          "const": "async",
+          "description": "Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse."
+        }
+      ],
+      "default": "sync"
+    },
+    "safety": {
+      "type": "object",
+      "title": "Safety Settings",
+      "description": "Content safety checking configuration for image generation.",
+      "properties": {
+        "checkContent": {
+          "title": "Check Content",
+          "description": "Enable or disable content safety checking. When enabled, defaults to `fast` mode.",
+          "type": "boolean",
+          "default": false
+        },
+        "mode": {
+          "description": "Safety checking mode for image generation.",
+          "type": "string",
+          "oneOf": [
+            {
+              "const": "none",
+              "title": "None",
+              "description": "Disables checking."
+            },
+            {
+              "const": "fast",
+              "title": "Fast",
+              "description": "Performs a single check."
+            }
+          ],
+          "default": "none"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "positivePrompt",
+    "width",
+    "height",
+    "taskType",
+    "taskUUID",
+    "model"
+  ],
+  "allOf": [
+    {
+      "dependentRequired": {
+        "width": [
+          "height"
+        ],
+        "height": [
+          "width"
+        ]
+      }
+    },
+    {
+      "oneOf": [
+        {
+          "title": "1K (1:1)",
+          "properties": {
+            "width": {
+              "const": 1024
+            },
+            "height": {
+              "const": 1024
+            }
+          }
+        },
+        {
+          "title": "1K (3:2)",
+          "properties": {
+            "width": {
+              "const": 1536
+            },
+            "height": {
+              "const": 1024
+            }
+          }
+        },
+        {
+          "title": "1K (2:3)",
+          "properties": {
+            "width": {
+              "const": 1024
+            },
+            "height": {
+              "const": 1536
+            }
+          }
+        }
+      ]
+    }
+  ],
+  "additionalProperties": false
+}