Sign in
Avatar Videos

Generate avatar video from audio or text

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

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

Changed in 4 of the 54 revisions of this API.13

  • bb2963960c9b1See the full diff
    • ○

      the speech/oneOf[subschema #2: TextInput]/text request property's maxLength was increased from 3000 to 5000

      request-property-max-length-increased

  • 1d3bb312672a1See the full diff
    • ○

      the speech/oneOf[subschema #2: TextInput]/text request property's maxLength was increased from 1000 to 3000

      request-property-max-length-increased

  • 6f5bc53a0d361See the full diff
    • ●

      changed the pattern of the request property speech/oneOf[subschema #1: AudioInput]/audio/anyOf[subschema #1]/ from ^https://.* to ^https:\/\/.*

      request-property-pattern-changed

  • ee023fb84f0e1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog