@runware/schemas 0.0.0-20260510231619

package/dist/schemas/requests/models/runware/open-age-detection.json

@@ -0,0 +1,131 @@
+{
+  "$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:154@1"
+    },
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "caption"
+    },
+    "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/ovi.json

@@ -0,0 +1,313 @@
+{
+  "$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:190@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+/=]+$"
+            }
+          ]
+        }
+      },
+      "required": [
+        "image"
+      ],
+      "additionalProperties": false
+    },
+    "positivePrompt": {
+      "title": "Positive Prompt",
+      "description": "Text prompt describing elements to include in the generated output.",
+      "type": "string"
+    },
+    "fps": {
+      "title": "FPS",
+      "description": "Frames per second for video generation. Higher values create smoother motion but require more processing time.",
+      "type": "integer",
+      "default": 24,
+      "maximum": 120
+    },
+    "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": 30,
+      "maximum": 100
+    },
+    "acceleratorOptions": {
+      "title": "Accelerator Options",
+      "description": "Advanced caching mechanisms to speed up generation.",
+      "type": "object",
+      "properties": {
+        "cacheEndStep": {
+          "title": "Cache End Step",
+          "description": "Absolute step number to end caching. Must be greater than `cacheStartStep` and less than or equal to `steps`.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "cacheEndStepPercentage": {
+          "title": "Cache End Step Percentage",
+          "description": "Percentage of steps to end caching. Alternative to `cacheEndStep`. Must be greater than `cacheStartStepPercentage`.",
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 100
+        },
+        "cacheMaxConsecutiveSteps": {
+          "title": "Cache Max Consecutive Steps",
+          "description": "Limits the maximum number of consecutive steps that can use cached computations before forcing a fresh computation.",
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 5,
+          "default": 3
+        },
+        "cacheStartStep": {
+          "title": "Cache Start Step",
+          "description": "Absolute step number to start caching. Must be less than `cacheEndStep`.",
+          "type": "integer",
+          "minimum": 0
+        },
+        "cacheStartStepPercentage": {
+          "title": "Cache Start Step Percentage",
+          "description": "Percentage of steps to start caching. Alternative to `cacheStartStep`. Must be less than `cacheEndStepPercentage`.",
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 99
+        },
+        "teaCache": {
+          "title": "TeaCache",
+          "description": "TeaCache acceleration for transformer-based models. Estimates step differences to skip redundant computations.",
+          "type": "boolean",
+          "default": false
+        },
+        "teaCacheDistance": {
+          "title": "TeaCache Distance",
+          "description": "Controls the aggressiveness of the TeaCache feature. Lower values prioritize quality, higher values prioritize speed.",
+          "type": "number",
+          "multipleOf": 0.01,
+          "minimum": 0,
+          "maximum": 1,
+          "default": 0.5
+        }
+      },
+      "allOf": [
+        {
+          "not": {
+            "required": [
+              "cacheStartStep",
+              "cacheStartStepPercentage"
+            ]
+          }
+        },
+        {
+          "not": {
+            "required": [
+              "cacheEndStep",
+              "cacheEndStepPercentage"
+            ]
+          }
+        }
+      ],
+      "additionalProperties": false
+    },
+    "advancedFeatures": {
+      "title": "Advanced Features",
+      "description": "Model-specific advanced configuration options.",
+      "type": "object",
+      "properties": {
+        "audioCFGScale": {
+          "type": "number",
+          "title": "Audio CFG Scale",
+          "description": "Classifier-free guidance scale for the audio diffusion process. Higher values increase adherence to the text prompt.",
+          "default": 4,
+          "minimum": 0,
+          "maximum": 10
+        },
+        "audioNegativePrompt": {
+          "type": "string",
+          "title": "Audio Negative Prompt",
+          "description": "Text describing elements to avoid in the generated audio."
+        },
+        "slgLayer": {
+          "type": "integer",
+          "title": "SLG Layer",
+          "description": "Skip-layer guidance layer index. Set to null to disable.",
+          "minimum": 0,
+          "maximum": 30
+        },
+        "videoCFGScale": {
+          "type": "number",
+          "title": "Video CFG Scale",
+          "description": "Classifier-free guidance scale for the video diffusion process. Higher values increase adherence to the text prompt.",
+          "default": 5,
+          "minimum": 0,
+          "maximum": 10
+        },
+        "videoNegativePrompt": {
+          "type": "string",
+          "title": "Video Negative Prompt",
+          "description": "Text describing elements to avoid in the generated video."
+        }
+      },
+      "additionalProperties": false
+    },
+    "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",
+    "inputs",
+    "taskType",
+    "taskUUID",
+    "model"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/requests/models/runware/qwen2-5-vl-7b-age-detector.json

@@ -0,0 +1,131 @@
+{
+  "$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:152@50"
+    },
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "caption"
+    },
+    "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"
+  ]
+}