@runware/schemas 0.0.0-20260510231619

package/dist/schemas/requests/models/runware/ace-step-v1-5-turbo.json

@@ -0,0 +1,1005 @@
+{
+  "$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:ace-step@v1.5-turbo"
+    },
+    "inputs": {
+      "title": "Inputs",
+      "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.",
+      "type": "object",
+      "properties": {
+        "audio": {
+          "title": "Audio",
+          "description": "Audio input (UUID or URL).",
+          "type": "string",
+          "anyOf": [
+            {
+              "format": "uuid"
+            },
+            {
+              "format": "uri"
+            }
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
+    "positivePrompt": {
+      "title": "Positive Prompt",
+      "description": "Text prompt describing elements to include in the generated output.",
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 3000
+    },
+    "negativePrompt": {
+      "title": "Negative Prompt",
+      "description": "Prompt to guide what to exclude from generation. Ignored when guidance is disabled (CFGScale ≤ 1).",
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 3000
+    },
+    "duration": {
+      "title": "Duration",
+      "description": "Length of the generated audio track in seconds.",
+      "type": "number",
+      "default": 60,
+      "minimum": 6,
+      "maximum": 300,
+      "multipleOf": 0.1
+    },
+    "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": 2147483647
+    },
+    "steps": {
+      "title": "Steps",
+      "description": "Total number of denoising steps. Higher values generally produce more detailed results but take longer.",
+      "type": "integer",
+      "minimum": 1,
+      "default": 10,
+      "maximum": 20
+    },
+    "CFGScale": {
+      "title": "CFG Scale",
+      "description": "Guidance scale. Higher values follow the prompt more closely at the cost of quality.",
+      "type": "number",
+      "multipleOf": 0.01,
+      "minimum": 1,
+      "default": 10,
+      "maximum": 30
+    },
+    "strength": {
+      "title": "Strength",
+      "description": "Fraction of steps using the input source instead of generated output.",
+      "type": "number",
+      "multipleOf": 0.01,
+      "minimum": 0,
+      "maximum": 1,
+      "default": 0.5
+    },
+    "settings": {
+      "title": "Settings",
+      "description": "Global inference settings.",
+      "type": "object",
+      "properties": {
+        "bpm": {
+          "type": "integer",
+          "title": "BPM",
+          "description": "Beats per minute. If not set, the model decides automatically.",
+          "minimum": 30,
+          "maximum": 300
+        },
+        "coverConditioningScale": {
+          "type": "number",
+          "title": "Cover Conditioning Scale",
+          "description": "Fraction of steps using source-audio conditioning.",
+          "default": 1,
+          "minimum": 0,
+          "maximum": 1,
+          "multipleOf": 0.01
+        },
+        "guidanceType": {
+          "type": "string",
+          "title": "Guidance Type",
+          "description": "Controls how guidance is applied during generation.",
+          "default": "apg",
+          "oneOf": [
+            {
+              "description": "Adaptive Projected Guidance.",
+              "const": "apg"
+            },
+            {
+              "description": "Classifier-Free Guidance.",
+              "const": "cfg"
+            }
+          ]
+        },
+        "keyScale": {
+          "type": "string",
+          "title": "Key Scale",
+          "description": "Musical key and scale in '{Note}{Accidental} {Mode}' format (e.g. 'C major', 'F# minor', 'Bb major')."
+        },
+        "lyrics": {
+          "type": "string",
+          "title": "Lyrics",
+          "description": "Song lyrics, typically formatted like a lyrics website.",
+          "default": "",
+          "minLength": 10,
+          "maxLength": 3000
+        },
+        "repaintingEnd": {
+          "type": "number",
+          "title": "Repainting End",
+          "description": "End time in seconds for repaint region. Requires input audio. Values beyond audio duration append new audio.",
+          "minimum": 0,
+          "maximum": 300
+        },
+        "repaintingStart": {
+          "type": "number",
+          "title": "Repainting Start",
+          "description": "Start time in seconds for repaint region. Requires input audio. Negative values prepend audio before the start.",
+          "minimum": -300,
+          "maximum": 300
+        },
+        "timeSignature": {
+          "type": "integer",
+          "title": "Time Signature",
+          "description": "Beats per measure. If not set, the model decides automatically.",
+          "enum": [
+            2,
+            3,
+            4,
+            6
+          ]
+        },
+        "vocalLanguage": {
+          "type": "string",
+          "title": "Vocal Language",
+          "description": "ISO 639-1 language code for vocals. `unknown` for instrumental or auto detection.",
+          "enum": [
+            "unknown",
+            "ar",
+            "az",
+            "bg",
+            "bn",
+            "ca",
+            "cs",
+            "da",
+            "de",
+            "el",
+            "en",
+            "es",
+            "fa",
+            "fi",
+            "fr",
+            "he",
+            "hi",
+            "hr",
+            "ht",
+            "hu",
+            "id",
+            "is",
+            "it",
+            "ja",
+            "ko",
+            "la",
+            "lt",
+            "ms",
+            "ne",
+            "nl",
+            "no",
+            "pa",
+            "pl",
+            "pt",
+            "ro",
+            "ru",
+            "sa",
+            "sk",
+            "sr",
+            "sv",
+            "sw",
+            "ta",
+            "te",
+            "th",
+            "tl",
+            "tr",
+            "uk",
+            "ur",
+            "vi",
+            "yue",
+            "zh"
+          ],
+          "default": "en"
+        }
+      },
+      "additionalProperties": false
+    },
+    "taskType": {
+      "title": "Task Type",
+      "description": "Identifier for the type of task being performed",
+      "type": "string",
+      "const": "audioInference"
+    },
+    "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": "Audio output type.",
+      "type": "string",
+      "enum": [
+        "URL",
+        "base64Data",
+        "dataURI"
+      ],
+      "default": "URL"
+    },
+    "outputFormat": {
+      "title": "Output Format",
+      "description": "File format for the generated audio.",
+      "type": "string",
+      "enum": [
+        "MP3",
+        "WAV",
+        "FLAC",
+        "OGG"
+      ],
+      "default": "MP3"
+    },
+    "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"
+    },
+    "audioSettings": {
+      "title": "Audio Settings",
+      "description": "Audio encoding settings. Only applicable for lossy formats (MP3, OGG). Available sample rates and valid bitrate ranges depend on the output format and number of channels.",
+      "type": "object",
+      "properties": {
+        "bitrate": {
+          "title": "Bitrate",
+          "description": "Audio bitrate in kbps.",
+          "type": "integer",
+          "minimum": 8
+        },
+        "channels": {
+          "title": "Channels",
+          "description": "Number of audio channels. 1 for mono, 2 for stereo.",
+          "type": "integer",
+          "enum": [
+            1,
+            2
+          ],
+          "default": 2
+        },
+        "sampleRate": {
+          "title": "Sample Rate",
+          "description": "Audio sample rate in Hz.",
+          "type": "integer"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "positivePrompt",
+    "taskType",
+    "taskUUID",
+    "model"
+  ],
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "outputFormat": {
+            "enum": [
+              "WAV",
+              "FLAC"
+            ]
+          }
+        },
+        "required": [
+          "outputFormat"
+        ]
+      },
+      "then": {
+        "not": {
+          "required": [
+            "audioSettings"
+          ]
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "outputFormat": {
+            "const": "MP3"
+          }
+        },
+        "required": [
+          "outputFormat"
+        ]
+      },
+      "then": {
+        "properties": {
+          "audioSettings": {
+            "properties": {
+              "sampleRate": {
+                "enum": [
+                  8000,
+                  11025,
+                  12000,
+                  16000,
+                  22050,
+                  24000,
+                  32000,
+                  44100,
+                  48000
+                ]
+              }
+            }
+          }
+        },
+        "allOf": [
+          {
+            "if": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "sampleRate": {
+                      "enum": [
+                        8000,
+                        11025,
+                        12000
+                      ]
+                    }
+                  },
+                  "required": [
+                    "sampleRate"
+                  ]
+                }
+              },
+              "required": [
+                "audioSettings"
+              ]
+            },
+            "then": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "bitrate": {
+                      "minimum": 8,
+                      "maximum": 64
+                    }
+                  }
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "sampleRate": {
+                      "enum": [
+                        16000,
+                        22050,
+                        24000
+                      ]
+                    }
+                  },
+                  "required": [
+                    "sampleRate"
+                  ]
+                }
+              },
+              "required": [
+                "audioSettings"
+              ]
+            },
+            "then": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "bitrate": {
+                      "minimum": 8,
+                      "maximum": 160
+                    }
+                  }
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "sampleRate": {
+                      "enum": [
+                        32000,
+                        44100,
+                        48000
+                      ]
+                    }
+                  },
+                  "required": [
+                    "sampleRate"
+                  ]
+                }
+              },
+              "required": [
+                "audioSettings"
+              ]
+            },
+            "then": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "bitrate": {
+                      "minimum": 32,
+                      "maximum": 320
+                    }
+                  }
+                }
+              }
+            }
+          }
+        ]
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "outputFormat": {
+            "const": "OGG"
+          }
+        },
+        "required": [
+          "outputFormat"
+        ]
+      },
+      "then": {
+        "properties": {
+          "audioSettings": {
+            "properties": {
+              "sampleRate": {
+                "enum": [
+                  8000,
+                  12000,
+                  16000,
+                  24000,
+                  48000
+                ]
+              }
+            }
+          }
+        },
+        "allOf": [
+          {
+            "if": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "sampleRate": {
+                      "const": 8000
+                    },
+                    "channels": {
+                      "const": 1
+                    }
+                  },
+                  "required": [
+                    "sampleRate",
+                    "channels"
+                  ]
+                }
+              },
+              "required": [
+                "audioSettings"
+              ]
+            },
+            "then": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "bitrate": {
+                      "minimum": 8,
+                      "maximum": 40
+                    }
+                  }
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "sampleRate": {
+                      "const": 8000
+                    },
+                    "channels": {
+                      "const": 2
+                    }
+                  },
+                  "required": [
+                    "sampleRate",
+                    "channels"
+                  ]
+                }
+              },
+              "required": [
+                "audioSettings"
+              ]
+            },
+            "then": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "bitrate": {
+                      "minimum": 16,
+                      "maximum": 80
+                    }
+                  }
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "sampleRate": {
+                      "const": 12000
+                    },
+                    "channels": {
+                      "const": 1
+                    }
+                  },
+                  "required": [
+                    "sampleRate",
+                    "channels"
+                  ]
+                }
+              },
+              "required": [
+                "audioSettings"
+              ]
+            },
+            "then": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "bitrate": {
+                      "minimum": 16,
+                      "maximum": 48
+                    }
+                  }
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "sampleRate": {
+                      "const": 12000
+                    },
+                    "channels": {
+                      "const": 2
+                    }
+                  },
+                  "required": [
+                    "sampleRate",
+                    "channels"
+                  ]
+                }
+              },
+              "required": [
+                "audioSettings"
+              ]
+            },
+            "then": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "bitrate": {
+                      "minimum": 16,
+                      "maximum": 96
+                    }
+                  }
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "sampleRate": {
+                      "const": 16000
+                    },
+                    "channels": {
+                      "const": 1
+                    }
+                  },
+                  "required": [
+                    "sampleRate",
+                    "channels"
+                  ]
+                }
+              },
+              "required": [
+                "audioSettings"
+              ]
+            },
+            "then": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "bitrate": {
+                      "minimum": 16,
+                      "maximum": 96
+                    }
+                  }
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "sampleRate": {
+                      "const": 16000
+                    },
+                    "channels": {
+                      "const": 2
+                    }
+                  },
+                  "required": [
+                    "sampleRate",
+                    "channels"
+                  ]
+                }
+              },
+              "required": [
+                "audioSettings"
+              ]
+            },
+            "then": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "bitrate": {
+                      "minimum": 24,
+                      "maximum": 192
+                    }
+                  }
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "sampleRate": {
+                      "const": 24000
+                    },
+                    "channels": {
+                      "const": 1
+                    }
+                  },
+                  "required": [
+                    "sampleRate",
+                    "channels"
+                  ]
+                }
+              },
+              "required": [
+                "audioSettings"
+              ]
+            },
+            "then": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "bitrate": {
+                      "minimum": 16,
+                      "maximum": 80
+                    }
+                  }
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "sampleRate": {
+                      "const": 24000
+                    },
+                    "channels": {
+                      "const": 2
+                    }
+                  },
+                  "required": [
+                    "sampleRate",
+                    "channels"
+                  ]
+                }
+              },
+              "required": [
+                "audioSettings"
+              ]
+            },
+            "then": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "bitrate": {
+                      "minimum": 32,
+                      "maximum": 160
+                    }
+                  }
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "sampleRate": {
+                      "const": 48000
+                    },
+                    "channels": {
+                      "const": 1
+                    }
+                  },
+                  "required": [
+                    "sampleRate",
+                    "channels"
+                  ]
+                }
+              },
+              "required": [
+                "audioSettings"
+              ]
+            },
+            "then": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "bitrate": {
+                      "minimum": 32,
+                      "maximum": 224
+                    }
+                  }
+                }
+              }
+            }
+          },
+          {
+            "if": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "sampleRate": {
+                      "const": 48000
+                    },
+                    "channels": {
+                      "const": 2
+                    }
+                  },
+                  "required": [
+                    "sampleRate",
+                    "channels"
+                  ]
+                }
+              },
+              "required": [
+                "audioSettings"
+              ]
+            },
+            "then": {
+              "properties": {
+                "audioSettings": {
+                  "properties": {
+                    "bitrate": {
+                      "minimum": 48,
+                      "maximum": 256
+                    }
+                  }
+                }
+              }
+            }
+          }
+        ]
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "inputs": {
+            "required": [
+              "audio"
+            ]
+          }
+        },
+        "required": [
+          "inputs"
+        ]
+      },
+      "then": {
+        "not": {
+          "required": [
+            "duration"
+          ]
+        }
+      }
+    },
+    {
+      "if": {
+        "required": [
+          "strength"
+        ]
+      },
+      "then": {
+        "properties": {
+          "inputs": {
+            "required": [
+              "audio"
+            ]
+          }
+        },
+        "required": [
+          "inputs"
+        ]
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "settings": {
+            "anyOf": [
+              {
+                "required": [
+                  "repaintingStart"
+                ]
+              },
+              {
+                "required": [
+                  "repaintingEnd"
+                ]
+              }
+            ]
+          }
+        },
+        "required": [
+          "settings"
+        ]
+      },
+      "then": {
+        "properties": {
+          "inputs": {
+            "required": [
+              "audio"
+            ]
+          }
+        },
+        "required": [
+          "inputs"
+        ]
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "settings": {
+            "required": [
+              "coverConditioningScale"
+            ]
+          }
+        },
+        "required": [
+          "settings"
+        ]
+      },
+      "then": {
+        "properties": {
+          "inputs": {
+            "required": [
+              "audio"
+            ]
+          }
+        },
+        "required": [
+          "inputs"
+        ]
+      }
+    },
+    {
+      "if": {
+        "required": [
+          "negativePrompt"
+        ]
+      },
+      "then": {
+        "properties": {
+          "CFGScale": {
+            "exclusiveMinimum": 1
+          }
+        }
+      }
+    }
+  ],
+  "additionalProperties": false
+}