Avatar Videos

Generate avatar video from audio or text

Changed on

Start an asynchronous task to generate a video of an avatar speaking. Provide speech with type: "audio" (audio file) or type: "text" (text script for TTS). Poll GET /v1/tasks/:id to check progress and retrieve the output video URL once complete.

post/v1/avatar_videos

Request

  • Base URL
    https://api.dev.runwayml.com
  • URL
    https://api.dev.runwayml.com/v1/avatar_videos
  • 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

model'gwm1_avatars' required

The model to use for avatar video generation.

Example request

{
  "speech": {
    "audio": "https://example.com/audio.mp3"
  }
}

Response

Success

idstring uuid required

The ID of the avatar video task. Use GET /v1/tasks/:id to poll for status and output.

Changes

  • 4491b57b5860Revision changes
    • breaking

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

    • info

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

  • bb2963960c9bRevision changes
    • info

      the // request property's maxLength was increased from 3000 to 5000