Skip to main content

Videos

Text-to-video​

POST /v1/videos/text-to-video

Request body json​

  • prompt string required

    A text description of your desired video. The maximum character length is 4000 characters.

  • duration integer optional

    Number between 1-4 for duration of your video in seconds.

  • motion_strength integer optional

    Number between 1-5 for amount of motion in your video.

Returns​

{
	"success": true,
	"generation_id": "[GENERATION ID]"
}

Image-to-video​

POST /v1/videos/image-to-video

Request body json​

  • image_url string required

    A publicly accessible URL to the image you would like to create a video from.

  • duration integer optional

    Number between 1-4 for duration of your video in seconds.

  • motion_strength integer optional

    Number between 1-5 for amount of motion in your video.

Returns​

{
	"success": true,
	"generation_id": "[GENERATION ID]"
}

Get Generation by ID​

GET /v1/generations/[id]

Returns​

{
    "success": true,
    "generation": {
        "org_id": "[ORGANIZATION ID]",
        "created_at": "[CREATION DATE]",
        "type": "[TYPE]",
        "params": {
                
        },
        "status": "[STATUS <in_progress|complete>]",
        "output": {
            "video_url": "[VIDEO URL]"
        }
    }
}