@runware/schemas 0.0.0-20260510231619

package/dist/schemas/requests/models/skywork/skywork-skyreels-v4.json

@@ -0,0 +1,807 @@
+{
+  "$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": "skywork:skyreels@v4"
+    },
+    "inputs": {
+      "title": "Inputs",
+      "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.",
+      "type": "object",
+      "properties": {
+        "referenceImages": {
+          "type": "array",
+          "title": "Reference Images",
+          "description": "Reference image groups for subject, scene, style, or collage-based guidance. All items must share the same type.",
+          "items": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "title": "Type",
+                "description": "Reference mode for this group.",
+                "oneOf": [
+                  {
+                    "description": "Single collage image.",
+                    "const": "grid"
+                  },
+                  {
+                    "description": "Subject, scene, or style reference.",
+                    "const": "image"
+                  }
+                ]
+              },
+              "audio": {
+                "title": "Audio",
+                "description": "Audio input (UUID or URL). Voice timbre reference for lip-sync. Max 15 seconds.",
+                "type": "string",
+                "anyOf": [
+                  {
+                    "format": "uuid"
+                  },
+                  {
+                    "format": "uri"
+                  }
+                ]
+              },
+              "images": {
+                "type": "array",
+                "title": "Images",
+                "description": "Image inputs (UUID, URL, Data URI, or Base64) for this reference group.",
+                "items": {
+                  "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+/=]+$"
+                    }
+                  ]
+                },
+                "minItems": 1,
+                "maxItems": 5
+              },
+              "tag": {
+                "type": "string",
+                "title": "Tag",
+                "description": "Group identifier that links this reference to a mention in the prompt. Must start with @ (e.g. @actor1, @style)."
+              }
+            },
+            "required": [
+              "tag",
+              "type",
+              "images"
+            ],
+            "additionalProperties": false
+          },
+          "minItems": 1
+        },
+        "frameImages": {
+          "title": "Frame Images",
+          "description": "List of frame-specific image inputs. Each item can be either a plain image input (UUID, URL, Data URI, or Base64) or an object with an image and a target frame position.",
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "anyOf": [
+              {
+                "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+/=]+$"
+                  }
+                ]
+              },
+              {
+                "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+/=]+$"
+                      }
+                    ]
+                  },
+                  "frame": {
+                    "title": "Frame",
+                    "description": "Target frame position for the image. Accepts a named position like `first` or `last`, or a zero-based frame index (-1 for the last frame).",
+                    "oneOf": [
+                      {
+                        "title": "Position",
+                        "description": "Named position in the video.",
+                        "type": "string"
+                      },
+                      {
+                        "title": "Index",
+                        "description": "Zero-based frame index. Use -1 for the last frame.",
+                        "type": "integer",
+                        "minimum": -1
+                      }
+                    ]
+                  }
+                },
+                "required": [
+                  "image"
+                ],
+                "additionalProperties": false
+              }
+            ]
+          },
+          "maxItems": 8
+        },
+        "referenceVideos": {
+          "type": "array",
+          "title": "Reference Videos",
+          "description": "Reference video for motion guidance, subject replacement, editing, or video extension.",
+          "items": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "title": "Type",
+                "description": "Reference mode for the video.",
+                "oneOf": [
+                  {
+                    "description": "Motion reference, subject replacement, or editing. Input video audio is carried to output.",
+                    "const": "reference"
+                  },
+                  {
+                    "description": "Video extension.",
+                    "const": "extend"
+                  }
+                ]
+              },
+              "tag": {
+                "type": "string",
+                "title": "Tag",
+                "description": "Video reference identifier that links to a mention in the prompt. Must start with @ (e.g. @video1)."
+              },
+              "video": {
+                "title": "Video",
+                "description": "Video input (UUID or URL). Max 15 seconds. Minimum 1,866,240 total pixels (e.g. 1920×972).",
+                "type": "string",
+                "anyOf": [
+                  {
+                    "format": "uuid"
+                  },
+                  {
+                    "format": "uri"
+                  }
+                ]
+              }
+            },
+            "required": [
+              "tag",
+              "type",
+              "video"
+            ],
+            "additionalProperties": false
+          },
+          "minItems": 1,
+          "maxItems": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "positivePrompt": {
+      "title": "Positive Prompt",
+      "description": "Text prompt describing elements to include in the generated output.",
+      "type": "string",
+      "maxLength": 5120
+    },
+    "width": {
+      "title": "Width",
+      "description": "Width of the generated media in pixels.",
+      "type": "integer"
+    },
+    "height": {
+      "title": "Height",
+      "description": "Height of the generated media in pixels.",
+      "type": "integer"
+    },
+    "resolution": {
+      "title": "Resolution",
+      "description": "Resolution preset for the output. When used with input media, automatically matches the aspect ratio from the input.",
+      "type": "string",
+      "enum": [
+        "480p",
+        "720p",
+        "1080p"
+      ],
+      "default": "1080p"
+    },
+    "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",
+      "default": 5,
+      "minimum": 3,
+      "maximum": 15
+    },
+    "settings": {
+      "title": "Settings",
+      "description": "Global inference settings.",
+      "type": "object",
+      "properties": {
+        "audio": {
+          "type": "boolean",
+          "title": "Audio",
+          "description": "Sound effect generation for the output video.",
+          "default": false
+        },
+        "promptExtend": {
+          "type": "boolean",
+          "title": "Prompt Extend",
+          "description": "Automatic prompt expansion and refinement via LLM for higher visual fidelity and alignment.",
+          "default": true
+        }
+      },
+      "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",
+    "taskType",
+    "taskUUID",
+    "model"
+  ],
+  "allOf": [
+    {
+      "dependentRequired": {
+        "width": [
+          "height"
+        ],
+        "height": [
+          "width"
+        ]
+      }
+    },
+    {
+      "oneOf": [
+        {
+          "title": "480p (16:9)",
+          "properties": {
+            "width": {
+              "const": 848
+            },
+            "height": {
+              "const": 480
+            }
+          }
+        },
+        {
+          "title": "480p (9:16)",
+          "properties": {
+            "width": {
+              "const": 480
+            },
+            "height": {
+              "const": 848
+            }
+          }
+        },
+        {
+          "title": "480p (~4:3)",
+          "properties": {
+            "width": {
+              "const": 736
+            },
+            "height": {
+              "const": 560
+            }
+          }
+        },
+        {
+          "title": "480p (~3:4)",
+          "properties": {
+            "width": {
+              "const": 560
+            },
+            "height": {
+              "const": 736
+            }
+          }
+        },
+        {
+          "title": "480p (1:1)",
+          "properties": {
+            "width": {
+              "const": 640
+            },
+            "height": {
+              "const": 640
+            }
+          }
+        },
+        {
+          "title": "720p (16:9)",
+          "properties": {
+            "width": {
+              "const": 1280
+            },
+            "height": {
+              "const": 720
+            }
+          }
+        },
+        {
+          "title": "720p (9:16)",
+          "properties": {
+            "width": {
+              "const": 720
+            },
+            "height": {
+              "const": 1280
+            }
+          }
+        },
+        {
+          "title": "720p (~4:3)",
+          "properties": {
+            "width": {
+              "const": 1088
+            },
+            "height": {
+              "const": 832
+            }
+          }
+        },
+        {
+          "title": "720p (~3:4)",
+          "properties": {
+            "width": {
+              "const": 832
+            },
+            "height": {
+              "const": 1088
+            }
+          }
+        },
+        {
+          "title": "720p (1:1)",
+          "properties": {
+            "width": {
+              "const": 960
+            },
+            "height": {
+              "const": 960
+            }
+          }
+        },
+        {
+          "title": "1080p (16:9)",
+          "properties": {
+            "width": {
+              "const": 1920
+            },
+            "height": {
+              "const": 1088
+            }
+          }
+        },
+        {
+          "title": "1080p (9:16)",
+          "properties": {
+            "width": {
+              "const": 1088
+            },
+            "height": {
+              "const": 1920
+            }
+          }
+        },
+        {
+          "title": "1080p (~4:3)",
+          "properties": {
+            "width": {
+              "const": 1664
+            },
+            "height": {
+              "const": 1248
+            }
+          }
+        },
+        {
+          "title": "1080p (~3:4)",
+          "properties": {
+            "width": {
+              "const": 1248
+            },
+            "height": {
+              "const": 1664
+            }
+          }
+        },
+        {
+          "title": "1080p (1:1)",
+          "properties": {
+            "width": {
+              "const": 1440
+            },
+            "height": {
+              "const": 1440
+            }
+          }
+        }
+      ]
+    },
+    {
+      "if": {
+        "not": {
+          "properties": {
+            "inputs": {
+              "anyOf": [
+                {
+                  "required": [
+                    "frameImages"
+                  ]
+                },
+                {
+                  "required": [
+                    "referenceVideos"
+                  ]
+                }
+              ]
+            }
+          },
+          "required": [
+            "inputs"
+          ]
+        }
+      },
+      "then": {
+        "anyOf": [
+          {
+            "required": [
+              "width",
+              "height"
+            ]
+          },
+          {
+            "required": [
+              "resolution"
+            ]
+          }
+        ]
+      }
+    },
+    {
+      "not": {
+        "allOf": [
+          {
+            "required": [
+              "resolution"
+            ]
+          },
+          {
+            "anyOf": [
+              {
+                "required": [
+                  "width"
+                ]
+              },
+              {
+                "required": [
+                  "height"
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "inputs": {
+            "properties": {
+              "referenceVideos": {
+                "items": {
+                  "properties": {
+                    "type": {
+                      "const": "extend"
+                    }
+                  }
+                }
+              }
+            },
+            "required": [
+              "referenceVideos"
+            ]
+          }
+        },
+        "required": [
+          "inputs"
+        ]
+      },
+      "then": {
+        "not": {
+          "properties": {
+            "inputs": {
+              "required": [
+                "referenceImages"
+              ]
+            }
+          },
+          "required": [
+            "inputs"
+          ]
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "inputs": {
+            "properties": {
+              "referenceVideos": {
+                "contains": {
+                  "properties": {
+                    "type": {
+                      "const": "reference"
+                    }
+                  }
+                }
+              }
+            },
+            "required": [
+              "referenceVideos"
+            ]
+          }
+        },
+        "required": [
+          "inputs"
+        ]
+      },
+      "then": {
+        "not": {
+          "properties": {
+            "settings": {
+              "required": [
+                "audio"
+              ]
+            }
+          },
+          "required": [
+            "settings"
+          ]
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "inputs": {
+            "properties": {
+              "referenceImages": {
+                "contains": {
+                  "properties": {
+                    "type": {
+                      "const": "grid"
+                    }
+                  }
+                }
+              }
+            },
+            "required": [
+              "referenceImages"
+            ]
+          }
+        },
+        "required": [
+          "inputs"
+        ]
+      },
+      "then": {
+        "properties": {
+          "inputs": {
+            "properties": {
+              "referenceImages": {
+                "items": {
+                  "properties": {
+                    "images": {
+                      "maxItems": 1
+                    }
+                  }
+                },
+                "maxItems": 1
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "inputs": {
+            "properties": {
+              "referenceImages": {
+                "contains": {
+                  "properties": {
+                    "type": {
+                      "const": "image"
+                    }
+                  }
+                }
+              }
+            },
+            "required": [
+              "referenceImages"
+            ]
+          }
+        },
+        "required": [
+          "inputs"
+        ]
+      },
+      "then": {
+        "properties": {
+          "inputs": {
+            "properties": {
+              "referenceImages": {
+                "maxItems": 3
+              }
+            }
+          }
+        }
+      }
+    }
+  ],
+  "additionalProperties": false
+}