@runware/schemas 0.0.0-20260510231619

package/dist/schemas/requests/models/runware/ccsr.json

@@ -0,0 +1,187 @@
+{
+  "$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": "runware:501@1"
+    },
+    "upscaleFactor": {
+      "title": "Upscale Factor",
+      "description": "Factor by which to upscale the generated image. A value of 2 doubles width and height.",
+      "type": "integer",
+      "enum": [
+        2
+      ]
+    },
+    "settings": {
+      "title": "Settings",
+      "description": "Global inference settings.",
+      "type": "object",
+      "properties": {
+        "positivePrompt": {
+          "title": "Positive Prompt",
+          "description": "Text prompt describing elements to include in the generated output.",
+          "type": "string"
+        },
+        "negativePrompt": {
+          "title": "Negative Prompt",
+          "description": "Prompt to guide what to exclude from generation. Ignored when guidance is disabled (CFGScale ≤ 1).",
+          "type": "string"
+        },
+        "seed": {
+          "title": "Seed",
+          "description": "Random seed for reproducible generation. When not provided, a random seed is generated in the unsigned 32-bit range.",
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9223372036854776000
+        },
+        "steps": {
+          "title": "Steps",
+          "description": "Total number of denoising steps. Higher values generally produce more detailed results but take longer.",
+          "type": "integer",
+          "minimum": 20,
+          "maximum": 60
+        },
+        "CFGScale": {
+          "title": "CFG Scale",
+          "description": "Guidance scale representing how closely the output will resemble the prompt. Higher values produce results more aligned with the prompt.",
+          "type": "number",
+          "multipleOf": 0.01,
+          "minimum": 0
+        },
+        "controlNetWeight": {
+          "title": "ControlNet Weight",
+          "description": "Strength of the ControlNet influence. A value of 0 means no influence. Higher values increase the influence, and negative values can be used to steer away from the guide image.",
+          "type": "number",
+          "multipleOf": 0.01,
+          "minimum": -4,
+          "maximum": 4,
+          "default": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "upscale"
+    },
+    "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
+    },
+    "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
+    },
+    "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
+    },
+    "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"
+    },
+    "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"
+    },
+    "inputs": {
+      "title": "Inputs",
+      "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.",
+      "type": "object",
+      "properties": {
+        "image": {
+          "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+/=]+$"
+            }
+          ]
+        }
+      },
+      "required": [
+        "image"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "taskType",
+    "taskUUID",
+    "model",
+    "inputs"
+  ]
+}

package/dist/schemas/requests/models/runware/clarity.json

@@ -0,0 +1,277 @@
+{
+  "$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": "runware:500@1"
+    },
+    "upscaleFactor": {
+      "title": "Upscale Factor",
+      "description": "Factor by which to upscale the generated image. A value of 2 doubles width and height.",
+      "type": "integer",
+      "enum": [
+        2
+      ]
+    },
+    "settings": {
+      "title": "Settings",
+      "description": "Global inference settings.",
+      "type": "object",
+      "properties": {
+        "positivePrompt": {
+          "title": "Positive Prompt",
+          "description": "Text prompt describing elements to include in the generated output.",
+          "type": "string"
+        },
+        "negativePrompt": {
+          "title": "Negative Prompt",
+          "description": "Prompt to guide what to exclude from generation. Ignored when guidance is disabled (CFGScale ≤ 1).",
+          "type": "string"
+        },
+        "seed": {
+          "title": "Seed",
+          "description": "Random seed for reproducible generation. When not provided, a random seed is generated in the unsigned 32-bit range.",
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9223372036854776000
+        },
+        "steps": {
+          "title": "Steps",
+          "description": "Total number of denoising steps. Higher values generally produce more detailed results but take longer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "scheduler": {
+          "title": "Scheduler",
+          "description": "Scheduler to use for the diffusion process.",
+          "type": "string",
+          "enum": [
+            "DDIM",
+            "DDIMScheduler",
+            "DDPMScheduler",
+            "DEISMultistepScheduler",
+            "Default",
+            "DPM++",
+            "DPM++ 2M",
+            "DPM++ 2M Beta",
+            "DPM++ 2M Exponential",
+            "DPM++ 2M Karras",
+            "DPM++ 2M SDE",
+            "DPM++ 2M SDE Beta",
+            "DPM++ 2M SDE Exponential",
+            "DPM++ 2M SDE Karras",
+            "DPM++ 2M SDE Uniform",
+            "DPM++ 2M Uniform",
+            "DPM++ 3M",
+            "DPM++ 3M Beta",
+            "DPM++ 3M Exponential",
+            "DPM++ 3M Karras",
+            "DPM++ 3M SDE Uniform",
+            "DPM++ 3M Uniform",
+            "DPM++ Beta",
+            "DPM++ Exponential",
+            "DPM++ Karras",
+            "DPM++ SDE",
+            "DPM++ SDE Beta",
+            "DPM++ SDE Exponential",
+            "DPM++ SDE Karras",
+            "DPM++ Uniform",
+            "DPM++ Uniform Beta",
+            "DPM++ Uniform Exponential",
+            "DPM++ Uniform Karras",
+            "DPMSolverMultistepInverse",
+            "DPMSolverMultistepScheduler",
+            "DPMSolverSinglestepScheduler",
+            "EDMDPMSolverMultistepScheduler",
+            "EDMEulerScheduler",
+            "Euler",
+            "Euler a",
+            "Euler Beta",
+            "Euler DiscreteScheduler",
+            "Euler Exponential",
+            "Euler Karras",
+            "EulerAncestralDiscreteScheduler",
+            "FlowMatchEulerDiscreteScheduler",
+            "Heun",
+            "HeunDiscreteScheduler",
+            "Heun Karras",
+            "IPNDMScheduler",
+            "IPNDM Uniform",
+            "IPNDM Uniform Beta",
+            "IPNDM Uniform Exponential",
+            "IPNDM Uniform Karras",
+            "KDPM2AncestralDiscreteScheduler",
+            "KDPM2DiscreteScheduler",
+            "LCM",
+            "LCMScheduler",
+            "LMS",
+            "LMSDiscreteScheduler",
+            "LMS Karras",
+            "PNDMScheduler",
+            "TCDScheduler",
+            "UniPC",
+            "UniPC 2M",
+            "UniPC 2M Karras",
+            "UniPC 2M Uniform",
+            "UniPC 3M",
+            "UniPC 3M Karras",
+            "UniPC 3M Uniform",
+            "UniPC Karras",
+            "UniPC Uniform",
+            "UniPC Uniform Beta",
+            "UniPC Uniform Exponential",
+            "UniPC Uniform Karras"
+          ]
+        },
+        "CFGScale": {
+          "title": "CFG Scale",
+          "description": "Guidance scale representing how closely the output will resemble the prompt. Higher values produce results more aligned with the prompt.",
+          "type": "number",
+          "multipleOf": 0.01,
+          "minimum": 0
+        },
+        "strength": {
+          "title": "Strength",
+          "description": "Strength of the transformation. Lower values result in more influence from the original input.",
+          "type": "number",
+          "multipleOf": 0.01,
+          "minimum": 0,
+          "maximum": 1,
+          "default": 0.8
+        },
+        "controlNetWeight": {
+          "title": "ControlNet Weight",
+          "description": "Strength of the ControlNet influence. A value of 0 means no influence. Higher values increase the influence, and negative values can be used to steer away from the guide image.",
+          "type": "number",
+          "multipleOf": 0.01,
+          "minimum": -4,
+          "maximum": 4,
+          "default": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "upscale"
+    },
+    "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
+    },
+    "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
+    },
+    "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
+    },
+    "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"
+    },
+    "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"
+    },
+    "inputs": {
+      "title": "Inputs",
+      "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.",
+      "type": "object",
+      "properties": {
+        "image": {
+          "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+/=]+$"
+            }
+          ]
+        }
+      },
+      "required": [
+        "image"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "taskType",
+    "taskUUID",
+    "model",
+    "inputs"
+  ]
+}