@runware/schemas 0.0.0-20260510231619

package/dist/schemas/requests/models/runware/kandinsky-5-0-lite.json

@@ -0,0 +1,312 @@
+{
+  "$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:210@1"
+    },
+    "positivePrompt": {
+      "title": "Positive Prompt",
+      "description": "Text prompt describing elements to include in the generated output.",
+      "type": "string",
+      "minLength": 2
+    },
+    "negativePrompt": {
+      "title": "Negative Prompt",
+      "description": "Prompt to guide what to exclude from generation. Ignored when guidance is disabled (CFGScale ≤ 1).",
+      "type": "string"
+    },
+    "width": {
+      "title": "Width",
+      "description": "Width of the generated media in pixels.",
+      "type": "integer",
+      "minimum": 512,
+      "maximum": 768,
+      "multipleOf": 16,
+      "not": {
+        "enum": [
+          592,
+          656,
+          688,
+          752
+        ]
+      }
+    },
+    "height": {
+      "title": "Height",
+      "description": "Height of the generated media in pixels.",
+      "type": "integer",
+      "minimum": 512,
+      "maximum": 768,
+      "multipleOf": 16,
+      "not": {
+        "enum": [
+          592,
+          656,
+          688,
+          752
+        ]
+      }
+    },
+    "duration": {
+      "title": "Duration",
+      "description": "Length of the generated video in seconds. The total number of frames produced is determined by duration multiplied by the model's frame rate (fps).",
+      "type": "number",
+      "enum": [
+        5,
+        10
+      ]
+    },
+    "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,
+      "default": 20,
+      "maximum": 50
+    },
+    "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": 1,
+      "default": 5,
+      "maximum": 7
+    },
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "videoInference"
+    },
+    "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": 4
+    },
+    "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": "Video output type.",
+      "type": "string",
+      "enum": [
+        "URL"
+      ],
+      "default": "URL"
+    },
+    "outputFormat": {
+      "title": "Output Format",
+      "description": "File format for the generated video.",
+      "type": "string",
+      "enum": [
+        "MP4",
+        "WEBM",
+        "MOV"
+      ],
+      "default": "MP4"
+    },
+    "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": "async",
+          "description": "Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse. Required for long-running tasks like video generation."
+        }
+      ],
+      "default": "async"
+    },
+    "safety": {
+      "type": "object",
+      "title": "Safety Settings",
+      "description": "Content safety checking configuration for video 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 video generation.",
+          "type": "string",
+          "oneOf": [
+            {
+              "const": "none",
+              "title": "None",
+              "description": "Disables checking."
+            },
+            {
+              "const": "fast",
+              "title": "Fast",
+              "description": "Checks key frames."
+            },
+            {
+              "const": "full",
+              "title": "Full",
+              "description": "Checks all frames."
+            }
+          ],
+          "default": "none"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "positivePrompt",
+    "width",
+    "height",
+    "duration",
+    "taskType",
+    "taskUUID",
+    "model"
+  ],
+  "allOf": [
+    {
+      "dependentRequired": {
+        "width": [
+          "height"
+        ],
+        "height": [
+          "width"
+        ]
+      }
+    }
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/requests/models/runware/llama-3-1-8b-prompt-enhancer.json

@@ -0,0 +1,81 @@
+{
+  "$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:llama-3-1-8b@prompt-enhancer"
+    },
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "promptEnhance"
+    },
+    "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"
+    },
+    "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"
+    },
+    "includeCost": {
+      "title": "Include Cost",
+      "description": "Include task cost in the response.",
+      "type": "boolean",
+      "default": false
+    },
+    "prompt": {
+      "title": "Prompt",
+      "description": "The text prompt to enhance.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 300
+    },
+    "promptMaxLength": {
+      "title": "Prompt Max Length",
+      "description": "Maximum length of the enhanced prompt.",
+      "type": "integer",
+      "minimum": 12,
+      "maximum": 400
+    },
+    "promptVersions": {
+      "title": "Prompt Versions",
+      "description": "Number of enhanced prompt variations to generate.",
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 5,
+      "default": 1
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "taskType",
+    "taskUUID",
+    "model",
+    "prompt"
+  ]
+}

package/dist/schemas/requests/models/runware/object-eraser.json

@@ -0,0 +1,221 @@
+{
+  "$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:300@1"
+    },
+    "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+/=]+$"
+            }
+          ]
+        },
+        "maskImage": {
+          "title": "Mask Image",
+          "description": "Image used to specify which areas of the seed image should be edited (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",
+        "maskImage"
+      ],
+      "additionalProperties": false
+    },
+    "positivePrompt": {
+      "title": "Positive Prompt",
+      "description": "Text prompt describing elements to include in the generated output.",
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 3000
+    },
+    "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,
+      "default": 4,
+      "maximum": 5
+    },
+    "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": 1,
+      "default": 1,
+      "maximum": 10
+    },
+    "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": [
+    "inputs",
+    "taskType",
+    "taskUUID",
+    "model"
+  ],
+  "additionalProperties": false
+}