Start generating

Text to video

Changed on

This endpoint will start a new task to generate a video from a text prompt.

post/v1/text_to_video

Request

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

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "resolution": "2k",
  "references": [
    {
      "uri": "https://example.com/image.jpg"
    }
  ],
  "referenceVideos": [
    {
      "uri": "https://example.com/video.mp4"
    }
  ],
  "referenceAudio": [
    {
      "uri": "https://example.com/audio.mp3"
    }
  ]
}

Response

The task that was created.

idstring uuid required

The ID of the task that was created. Use this to retrieve the task later.

Changes

  • 28f063131307Revision changes
    • breaking

      removed the enum value 16:9 of the request property /

    • breaking

      removed the enum value 1:1 of the request property /

    • breaking

      removed the enum value 21:9 of the request property /

    • breaking

      removed the enum value 9:16 of the request property /

    • breaking

      removed the enum value adaptive of the request property /

    • warning

      removed the request property /

    • info

      added the new 1080:1920 enum value to the request property /

    • info

      added the new 1280:720 enum value to the request property /

    • info

      added the new 1440:1440 enum value to the request property /

    • info

      added the new 1460:624 enum value to the request property /

    • info

      added the new 1920:1080 enum value to the request property /

    • info

      added the new 2200:940 enum value to the request property /

    • info

      added the new 720:1280 enum value to the request property /

    • info

      added the new 940:940 enum value to the request property /

    • info

      added the new auto_1080p enum value to the request property /

    • info

      added the new auto_720p enum value to the request property /

  • aaa9eb23df13Revision changes
    • info

      added subschema #24: kling_4 to the request body oneOf list