@runware/schemas 0.0.0-20260510231619

package/dist/schemas/requests/models/openai/openai-gpt-5-5.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:gpt@5.5"
+    },
+    "outputFormat": {
+      "title": "Output Format",
+      "description": "Output format for the generated text.",
+      "type": "string",
+      "enum": [
+        "TEXT",
+        "JSON"
+      ],
+      "default": "TEXT"
+    },
+    "inputs": {
+      "title": "Inputs",
+      "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.",
+      "type": "object",
+      "properties": {
+        "images": {
+          "title": "Images",
+          "description": "Array of image inputs (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+/=]+$"
+              }
+            ]
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "settings": {
+      "title": "Settings",
+      "description": "Global inference settings.",
+      "type": "object",
+      "properties": {
+        "systemPrompt": {
+          "title": "System Prompt",
+          "description": "System-level instruction that guides the model's behavior and output style across the entire generation.",
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 200000
+        },
+        "maxTokens": {
+          "title": "Max Tokens",
+          "description": "Maximum number of tokens to generate in the response.",
+          "type": "integer",
+          "minimum": 1,
+          "default": 4096,
+          "maximum": 128000
+        },
+        "thinkingLevel": {
+          "title": "Thinking Level",
+          "description": "Controls the depth of internal reasoning the model performs before generating a response.",
+          "type": "string",
+          "enum": [
+            "none",
+            "low",
+            "medium",
+            "high",
+            "xhigh"
+          ],
+          "default": "medium"
+        }
+      },
+      "additionalProperties": false
+    },
+    "jsonSchema": {
+      "title": "JSON Schema",
+      "description": "JSON Schema for structured output. Only honoured when `outputFormat` is JSON. Accepts the OpenAI envelope ({name, schema, strict}) or a bare JSON Schema; bare schemas are auto-wrapped with `name='response'` and `strict=true`.",
+      "type": [
+        "object",
+        "string"
+      ],
+      "additionalProperties": true
+    },
+    "messages": {
+      "title": "Messages",
+      "description": "Array of chat messages forming the conversation context.",
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "title": "Message",
+        "description": "A single chat message with a role and content.",
+        "type": "object",
+        "properties": {
+          "role": {
+            "title": "Role",
+            "description": "The role of the message author.",
+            "type": "string",
+            "enum": [
+              "user",
+              "assistant"
+            ]
+          },
+          "content": {
+            "title": "Content",
+            "description": "The text content of the message.",
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "required": [
+          "role",
+          "content"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "toolChoice": {
+      "title": "Tool Choice",
+      "description": "Controls how the model selects which tool to call. Requires tools to be defined.",
+      "type": "object",
+      "properties": {
+        "type": {
+          "title": "Type",
+          "description": "Strategy the model uses to decide when and which tools to call.",
+          "type": "string",
+          "oneOf": [
+            {
+              "const": "auto",
+              "description": "The model decides whether to call a tool based on the conversation context. This is the recommended default."
+            },
+            {
+              "const": "any",
+              "description": "The model must call at least one tool but chooses which one. Useful when you always need structured output."
+            },
+            {
+              "const": "tool",
+              "description": "The model must call the specific tool identified by `name`. Use this to force a particular function call."
+            },
+            {
+              "const": "none",
+              "description": "The model will not call any tool, even if tools are defined. Useful for forcing a text-only response."
+            }
+          ]
+        },
+        "name": {
+          "title": "Name",
+          "description": "Name of the specific tool the model must call. Required when type is `tool`.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "type"
+      ],
+      "if": {
+        "properties": {
+          "type": {
+            "const": "tool"
+          }
+        }
+      },
+      "then": {
+        "required": [
+          "name"
+        ]
+      },
+      "additionalProperties": false
+    },
+    "tools": {
+      "title": "Tools",
+      "description": "Tool definitions available for the model to call during generation.",
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "title": "Type",
+            "description": "The kind of tool to make available to the model. User-defined functions require `name` and `schema`, while built-in tools (`search`, `codeInterpreter`) are executed server-side by the provider.",
+            "type": "string",
+            "oneOf": [
+              {
+                "const": "function",
+                "description": "User-defined function tool. The model outputs the tool name and arguments. You execute the function locally and send results back."
+              },
+              {
+                "const": "search",
+                "description": "Built-in web search. The provider executes search server-side and enriches the response automatically."
+              },
+              {
+                "const": "codeInterpreter",
+                "description": "Built-in code execution sandbox (Python). The provider runs code server-side and returns results automatically."
+              }
+            ]
+          },
+          "name": {
+            "title": "Name",
+            "description": "Unique function name. Required for function tools.",
+            "type": "string",
+            "pattern": "^[a-zA-Z0-9_-]+$",
+            "maxLength": 64
+          },
+          "description": {
+            "title": "Description",
+            "description": "Explanation of what the function does, used by the model to decide when to call it.",
+            "type": "string"
+          },
+          "schema": {
+            "title": "Schema",
+            "description": "JSON Schema object describing the function's input parameters.",
+            "type": "object",
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "type"
+        ],
+        "allOf": [
+          {
+            "if": {
+              "properties": {
+                "type": {
+                  "const": "function"
+                }
+              }
+            },
+            "then": {
+              "required": [
+                "name",
+                "schema"
+              ]
+            }
+          }
+        ],
+        "additionalProperties": false
+      }
+    },
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "textInference"
+    },
+    "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
+    },
+    "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."
+        },
+        {
+          "const": "stream",
+          "description": "Streams results token-by-token as they are generated."
+        }
+      ],
+      "default": "sync"
+    },
+    "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": 4
+    },
+    "includeUsage": {
+      "title": "Include Usage",
+      "description": "Include token usage statistics in the response.",
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "taskType",
+    "taskUUID",
+    "model",
+    "messages"
+  ]
+}

package/dist/schemas/requests/models/openai/openai-gpt-image-1-5.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:4@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": 2,
+      "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
+}