Model Router

Routed audio generation

Changed on

Start an audio generation task using a saved Model Router config instead of naming a model. Set input.type to speech to speak promptText verbatim, or audio to generate audio described by promptText.

post/v1/generate/audio

Request

  • Base URL
    https://api.dev.runwayml.com
  • URL
    https://api.dev.runwayml.com/v1/generate/audio
  • Auth
    HTTP bearer

Headers

X-Runway-Version'2024-11-06' required

The version of the RunwayML API being used. You can read more about versioning here.

Request body

configIdstring required

The slug of a saved Model Router config to route this request with.

Example request

{
  "input": {
    "voice": {
      "audioUri": "https://example.com/audio.mp3"
    },
    "referenceAudios": [
      {
        "uri": "https://example.com/audio.mp3"
      }
    ]
  }
}

Response

The routing decision. Includes a task id for real requests; dry runs return the decision only.

idstring uuid required

The ID of the created task. Poll GET /v1/tasks/:id for the result.

Changes

  • 4491b57b5860Revision changes
    • breaking

      removed subschema #1 subschema #3 from the /// request property anyOf list

    • breaking

      removed subschema #1 subschema #3 from the /// request property anyOf list

    • info

      added subschema #1 subschema #3 to the /// request property anyOf list

    • info

      added subschema #1 subschema #3 to the /// request property anyOf list

  • efc9e5abc4d0Revision changes
    • breaking

      added subschema #1: RoutedAudioTaskCreated to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status