@runware/schemas 0.0.0-20260510231619

package/dist/schemas/requests/models/meta/index.json

@@ -0,0 +1,298 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "model": {
+          "title": "Model",
+          "description": "Identifier of the model to use for generation.",
+          "type": "string",
+          "const": "runware:150@2"
+        },
+        "prompt": {
+          "title": "Caption Prompt",
+          "description": "Instructions or questions to guide the image analysis.",
+          "type": "string"
+        },
+        "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"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "model": {
+          "title": "Model",
+          "description": "Identifier of the model to use for generation.",
+          "type": "string",
+          "const": "meta:sam@3d"
+        },
+        "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+/=]+$"
+                }
+              ]
+            },
+            "mask": {
+              "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",
+            "mask"
+          ],
+          "additionalProperties": false
+        },
+        "positivePrompt": {
+          "title": "Positive Prompt",
+          "description": "Text prompt describing elements to include in the generated output.",
+          "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
+        },
+        "taskType": {
+          "title": "Task Type",
+          "description": "Identifier for the type of task being performed",
+          "type": "string",
+          "const": "3dInference"
+        },
+        "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": "3D output type.",
+          "type": "string",
+          "enum": [
+            "URL"
+          ],
+          "default": "URL"
+        },
+        "outputFormat": {
+          "title": "Output Format",
+          "description": "File format for the generated 3D model.",
+          "type": "string",
+          "enum": [
+            "GLB"
+          ],
+          "default": "GLB"
+        },
+        "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": "async"
+        }
+      },
+      "required": [
+        "inputs",
+        "taskType",
+        "taskUUID",
+        "model"
+      ],
+      "additionalProperties": false
+    }
+  ]
+}

package/dist/schemas/requests/models/meta/meta-llava-1-6-mistral-7b.json

@@ -0,0 +1,136 @@
+{
+  "$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:150@2"
+    },
+    "prompt": {
+      "title": "Caption Prompt",
+      "description": "Instructions or questions to guide the image analysis.",
+      "type": "string"
+    },
+    "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/meta/meta-sam-3d-objects.json

@@ -0,0 +1,159 @@
+{
+  "$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": "meta:sam@3d"
+    },
+    "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+/=]+$"
+            }
+          ]
+        },
+        "mask": {
+          "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",
+        "mask"
+      ],
+      "additionalProperties": false
+    },
+    "positivePrompt": {
+      "title": "Positive Prompt",
+      "description": "Text prompt describing elements to include in the generated output.",
+      "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
+    },
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "3dInference"
+    },
+    "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": "3D output type.",
+      "type": "string",
+      "enum": [
+        "URL"
+      ],
+      "default": "URL"
+    },
+    "outputFormat": {
+      "title": "Output Format",
+      "description": "File format for the generated 3D model.",
+      "type": "string",
+      "enum": [
+        "GLB"
+      ],
+      "default": "GLB"
+    },
+    "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": "async"
+    }
+  },
+  "required": [
+    "inputs",
+    "taskType",
+    "taskUUID",
+    "model"
+  ],
+  "additionalProperties": false
+}