@runware/schemas 0.0.0-20260510231619

package/dist/schemas/requests/models/elevenlabs/elevenlabs-music-v1.json

@@ -0,0 +1,877 @@
+{
+  "$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": "elevenlabs:1@1"
+    },
+    "positivePrompt": {
+      "title": "Positive Prompt",
+      "description": "Text prompt describing elements to include in the generated output.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2000
+    },
+    "duration": {
+      "title": "Duration",
+      "description": "Length of the generated audio track in seconds.",
+      "type": "integer",
+      "minimum": 10,
+      "maximum": 300
+    },
+    "providerSettings": {
+      "title": "Provider Settings",
+      "description": "Provider-specific configuration settings.",
+      "type": "object",
+      "properties": {
+        "elevenlabs": {
+          "title": "ElevenLabs Settings",
+          "description": "Provider-specific settings for ElevenLabs.",
+          "type": "object",
+          "properties": {
+            "music": {
+              "type": "object",
+              "title": "Music",
+              "description": "Music generation configuration for ElevenLabs.",
+              "properties": {
+                "compositionPlan": {
+                  "type": "object",
+                  "title": "Composition Plan",
+                  "description": "Defines global styles, sections, and timing for the generated track.",
+                  "properties": {
+                    "negativeGlobalStyles": {
+                      "type": "array",
+                      "title": "Negative Global Styles",
+                      "description": "Styles excluded from the entire song.",
+                      "items": {
+                        "type": "string"
+                      }
+                    },
+                    "positiveGlobalStyles": {
+                      "type": "array",
+                      "title": "Positive Global Styles",
+                      "description": "Styles present in the entire song.",
+                      "items": {
+                        "type": "string"
+                      }
+                    },
+                    "sections": {
+                      "type": "array",
+                      "title": "Sections",
+                      "description": "Song sections with specific styling.",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "duration": {
+                            "type": "integer",
+                            "title": "Duration",
+                            "description": "Duration of the section in seconds.",
+                            "minimum": 3,
+                            "maximum": 120
+                          },
+                          "lines": {
+                            "type": "array",
+                            "title": "Lines",
+                            "description": "Lyrics for the section.",
+                            "items": {
+                              "type": "string"
+                            }
+                          },
+                          "negativeLocalStyles": {
+                            "type": "array",
+                            "title": "Negative Local Styles",
+                            "description": "Styles excluded from this section.",
+                            "items": {
+                              "type": "string"
+                            }
+                          },
+                          "positiveLocalStyles": {
+                            "type": "array",
+                            "title": "Positive Local Styles",
+                            "description": "Styles present in this section.",
+                            "items": {
+                              "type": "string"
+                            }
+                          },
+                          "sectionName": {
+                            "type": "string",
+                            "title": "Section Name",
+                            "description": "Name of the section.",
+                            "minLength": 1,
+                            "maxLength": 100
+                          }
+                        },
+                        "required": [
+                          "sectionName",
+                          "positiveLocalStyles",
+                          "negativeLocalStyles",
+                          "duration",
+                          "lines"
+                        ],
+                        "additionalProperties": false
+                      },
+                      "minItems": 1
+                    }
+                  },
+                  "required": [
+                    "positiveGlobalStyles",
+                    "negativeGlobalStyles",
+                    "sections"
+                  ],
+                  "additionalProperties": false
+                },
+                "forceInstrumental": {
+                  "type": "boolean",
+                  "title": "Force Instrumental",
+                  "description": "Generate an instrumental track without vocals."
+                },
+                "respectSectionsDurations": {
+                  "type": "boolean",
+                  "title": "Respect Sections Durations",
+                  "description": "Strictly respect the duration specified for each section."
+                }
+              },
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "music"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "elevenlabs"
+      ],
+      "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
+    }
+  },
+  "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
+                    }
+                  }
+                }
+              }
+            }
+          }
+        ]
+      }
+    },
+    {
+      "not": {
+        "allOf": [
+          {
+            "required": [
+              "duration"
+            ]
+          },
+          {
+            "properties": {
+              "providerSettings": {
+                "properties": {
+                  "elevenlabs": {
+                    "properties": {
+                      "music": {
+                        "required": [
+                          "compositionPlan"
+                        ]
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            "required": [
+              "providerSettings"
+            ]
+          }
+        ]
+      }
+    },
+    {
+      "not": {
+        "allOf": [
+          {
+            "required": [
+              "positivePrompt"
+            ]
+          },
+          {
+            "properties": {
+              "providerSettings": {
+                "properties": {
+                  "elevenlabs": {
+                    "properties": {
+                      "music": {
+                        "required": [
+                          "compositionPlan"
+                        ]
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            "required": [
+              "providerSettings"
+            ]
+          }
+        ]
+      }
+    }
+  ],
+  "additionalProperties": false,
+  "required": [
+    "taskType",
+    "taskUUID",
+    "model"
+  ]
+}