@runware/schemas 0.0.0-20260510231619

package/dist/schemas/requests/types/remove-background-video.json

@@ -0,0 +1,120 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "Video Remove Background Request",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "removeBackground"
+    },
+    "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
+    },
+    "model": {
+      "title": "Model",
+      "description": "Identifier of the model to use for generation.",
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9._-]+(:[a-zA-Z0-9._/@-]+)?$"
+    },
+    "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": "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"
+    },
+    "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"
+    },
+    "inputs": {
+      "title": "Inputs",
+      "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.",
+      "type": "object",
+      "properties": {
+        "video": {
+          "title": "Video",
+          "description": "Video input (UUID or URL).",
+          "type": "string",
+          "anyOf": [
+            {
+              "format": "uuid"
+            },
+            {
+              "format": "uri"
+            }
+          ]
+        }
+      },
+      "required": [
+        "video"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "taskType",
+    "taskUUID",
+    "model",
+    "inputs"
+  ]
+}

package/dist/schemas/requests/types/remove-background.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "Remove Background Request",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "removeBackground"
+    },
+    "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
+    },
+    "model": {
+      "title": "Model",
+      "description": "Identifier of the model to use for generation.",
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9._-]+(:[a-zA-Z0-9._/@-]+)?$"
+    },
+    "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
+    }
+  },
+  "required": [
+    "taskType",
+    "taskUUID",
+    "model"
+  ]
+}

package/dist/schemas/requests/types/text.json

@@ -0,0 +1,126 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "Text Request",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "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
+    },
+    "model": {
+      "title": "Model",
+      "description": "Identifier of the model to use for generation.",
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9._-]+(:[a-zA-Z0-9._/@-]+)?$"
+    },
+    "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
+      }
+    },
+    "outputFormat": {
+      "title": "Output Format",
+      "description": "Output format for the generated text.",
+      "type": "string",
+      "enum": [
+        "TEXT"
+      ],
+      "default": "TEXT"
+    },
+    "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
+    },
+    "settings": {
+      "title": "Settings",
+      "description": "Global inference settings.",
+      "type": "object",
+      "additionalProperties": false
+    },
+    "includeUsage": {
+      "title": "Include Usage",
+      "description": "Include token usage statistics in the response.",
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "required": [
+    "taskType",
+    "taskUUID",
+    "model",
+    "messages"
+  ]
+}

package/dist/schemas/requests/types/training.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "Training Request",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "training"
+    },
+    "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
+    },
+    "model": {
+      "title": "Model",
+      "description": "Identifier of the model to use for generation.",
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9._-]+(:[a-zA-Z0-9._/@-]+)?$"
+    }
+  },
+  "required": [
+    "taskType",
+    "taskUUID",
+    "model"
+  ]
+}

package/dist/schemas/requests/types/upscale-image.json

@@ -0,0 +1,132 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "Image Upscale Request",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "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
+    },
+    "model": {
+      "title": "Model",
+      "description": "Identifier of the model to use for generation.",
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9._-]+(:[a-zA-Z0-9._/@-]+)?$"
+    },
+    "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
+    }
+  },
+  "required": [
+    "taskType",
+    "taskUUID",
+    "model",
+    "inputs"
+  ]
+}

package/dist/schemas/requests/types/upscale-video.json

@@ -0,0 +1,120 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "Video Upscale Request",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "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
+    },
+    "model": {
+      "title": "Model",
+      "description": "Identifier of the model to use for generation.",
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9._-]+(:[a-zA-Z0-9._/@-]+)?$"
+    },
+    "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": "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"
+    },
+    "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"
+    },
+    "inputs": {
+      "title": "Inputs",
+      "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.",
+      "type": "object",
+      "properties": {
+        "video": {
+          "title": "Video",
+          "description": "Video input (UUID or URL).",
+          "type": "string",
+          "anyOf": [
+            {
+              "format": "uuid"
+            },
+            {
+              "format": "uri"
+            }
+          ]
+        }
+      },
+      "required": [
+        "video"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "taskType",
+    "taskUUID",
+    "model",
+    "inputs"
+  ]
+}

package/dist/schemas/requests/types/upscale.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "Upscale Request",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "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
+    },
+    "model": {
+      "title": "Model",
+      "description": "Identifier of the model to use for generation.",
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9._-]+(:[a-zA-Z0-9._/@-]+)?$"
+    },
+    "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
+    }
+  },
+  "required": [
+    "taskType",
+    "taskUUID",
+    "model"
+  ]
+}