Text to Video Endpoint

Overview

Text to Video endpoint generates and returns a video based on a text description.

Request

--request POST 'https://modelslab.com/api/v6/video/text2video' \

Make a POST request to https://modelslab.com/api/v6/video/text2video endpoint and pass the required parameters in the request body.

Body Attributes

Parameter	Description	Values
key	Your API Key used for request authorization.	key
model_id	The ID of the model to use. The allowed model IDs are `cogvideox` .	Allowed values:`cogvideox` .
prompt	Text prompt with a description of the things you want in the video to be generated.	string
negative_prompt	Items you don't want in the video.	string
seed	Seed is used to reproduce results. The same seed will give you the same image again. Pass null for a random number.	INTEGER
height	The height of the video.	The maximum is 512 pixels.
width	The width of the video.	The maximum is 512 pixels.
num_frames	Number of frames in the generated video.	The maximum is 25. The default is 16.
num_inference_steps	Number of denoising steps.	The maximum is 50. The default is 20.
guidance_scale	Scale for classifier-free guidance.	min: 0, max: 8
clip_skip	Number of CLIP layers to skip. 2 leads to more aesthetic results.	The default is null.
upscale_height	Can be specified to upscale the height of the video generated by the zeroscope model.	1024
upscale_width	Can be specified to upscale the width of the video generated by the zeroscope model.	1024
upscale_strength	Higher strength can lead to more differences between the generated video and the upscaled video when using the zeroscope model.	0-1
upscale_guidance_scale	Guidance scale to be used for upscaling the video when using the zeroscope model.	0-8
upscale_num_inference_steps	Number of denoising steps for upscaling the video when using the zeroscope model.	The maximum is 50. The default is 20.
use_improved_sampling	Whether to use an improved sampling technique. Leads to better results with higher temporal consistency at the cost of being slow.	boolean
improved_sampling_seed	Seed for consistent video generation when using the improved sampling technique.	INTEGER
fps	Frames per second rate of the generated video.	Max 16
output_type	The output type.	`mp4` or `gif`
instant_response	`true` if you'd like a response with future links for queued requests instantly instead of waiting for a fixed amount of time.	The default is `false`. (`TRUE` or `FALSE`)
temp	`true` if you want to store your generations on our temporary storage. Temporary files are cleaned every 24 hours.	The default is `false`. (`TRUE` or `FALSE`)
webhook	Set a URL to get a POST API call once the video generation is complete.	URL
track_id	This ID is returned in the response to the webhook API call. This will be used to identify the webhook request.	string

Example

Body

When the model_id is cogvideox, the request json looks like so,

Body
{
    "key":"",
    "model_id":"cogvideox",
    "prompt":"An astronaut riding a horse",
    "negative_prompt":"low quality",
    "height":512,
    "width":512,
    "num_frames":16,
    "num_inference_steps":20,
    "guidance_scale":7,
    "upscale_height":640,
    "upscale_width":1024,
    "upscale_strength":0.6,
    "upscale_guidance_scale":12,
    "upscale_num_inference_steps":20,
    "output_type":"gif",
    "webhook":null,
    "track_id":null
}

Request

JS
PHP
NODE
PYTHON
JAVA

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
    "key":"",
    "model_id":"cogvideox",
    "prompt":"An astronaut riding a horse",
    "negative_prompt":"low quality",
    "height":512,
    "width":512,
    "num_frames":16,
    "num_inference_steps":20,
    "guidance_scale":7,
    "upscale_height":640,
    "upscale_width":1024,
    "upscale_strength":0.6,
    "upscale_guidance_scale":12,
    "upscale_num_inference_steps":20,
    "output_type":"gif",
    "webhook":null,
    "track_id":null
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://modelslab.com/api/v6/video/text2video", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

<?php

$payload = [
    "key" => "",
    "model_id" => "cogvideox",
    "prompt" => "An astronaut riding a horse",
    "negative_prompt" => "low quality",
    "height" =>512,
    "width" => 512,
    "num_frames" => 16,
    "num_inference_steps" =>20,
    "guidance_scale" => 7,
    "upscale_height" => 640,
    "upscale_width" => 1024,
    "upscale_strength" => 0.6,
    "upscale_guidance_scale" => 12,
    "upscale_num_inference_steps" => 20,
    "output_type" => "gif",
    "webhook" => null,
    "track_id" => null 
];

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://modelslab.com/api/v6/video/text2video',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => json_encode($payload),
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://modelslab.com/api/v6/video/text2video',
  'headers': {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "key":"",
    "model_id":"cogvideox",
    "prompt":"An astronaut riding a horse",
    "negative_prompt":"low quality",
    "height":512,
    "width":512,
    "num_frames":16,
    "num_inference_steps":20,
    "guidance_scale":7,
    "upscale_height":640,
    "upscale_width":1024,
    "upscale_strength":0.6,
    "upscale_guidance_scale":12,
    "upscale_num_inference_steps":20,
    "output_type":"gif",
    "webhook":null,
    "track_id":null
  })
};

request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests
import json

url = "https://modelslab.com/api/v6/video/text2video"

payload = json.dumps({
  "key":"",
    "model_id":"cogvideox",
    "prompt":"An astronaut riding a horse",
    "negative_prompt":"low quality",
    "height":512,
    "width":512,
    "num_frames":16,
    "num_inference_steps":20,
    "guidance_scale":7,
    "upscale_height":640,
    "upscale_width":1024,
    "upscale_strength":0.6,
    "upscale_guidance_scale":12,
    "upscale_num_inference_steps":20,
    "output_type":"gif",
    "webhook":None,
    "track_id":None
})

headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"key\":\"\",\n    \"model_id\":\"cogvideox\",\n    \"prompt\":\"An astronaut riding a horse\",\n    \"negative_prompt\":\"low quality\",\n    \"height\":\512,\n    \"width\":512,\n    \"num_frames\":16,\n    \"num_inference_steps\":20,\n    \"guidance_scale\":7,\n    \"upscale_height\":640,\n    \"upscale_width\":1024,\n    \"upscale_strength\":0.6,\n    \"upscale_guidance_scale\":12,\n    \"upscale_num_inference_steps\":20,\n    \"output_type\":\"gif\",\n    \"webhook\":null,\n    \"track_id\":null\n}");
Request request = new Request.Builder()
  .url("https://modelslab.com/api/v6/video/text2video")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

Response

Example Response

{
    "status": "success",
    "generationTime": 8.49,
    "id": 147,
    "output": [
        "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/generations/2be1702e-3a1f-46ee-811c-350cee84b66e.gif"
    ],
    "proxy_links": [
        "https://cdn2.stablediffusionapi.com/generations/2be1702e-3a1f-46ee-811c-350cee84b66e.gif"
    ],
    "meta": {
        "clip_skip": null,
        "file_prefix": "2be1702e-3a1f-46ee-811c-350cee84b66e",
        "fps": 7,
        "guidance_scale": 7,
        "height": 512,
        "improved_sampling_seed": 42,
        "instant_response": "no",
        "model_id": "cogvideox",
        "negative_prompt": "low quality",
        "num_frames": 16,
        "num_inference_steps": 20,
        "output_type": "gif",
        "prompt": "An astronaut riding a horse",
        "seed": 3848624113,
        "temp": "no",
        "upscale_guidance_scale": 15,
        "upscale_height": null,
        "upscale_num_inference_steps": 20,
        "upscale_strength": 0.6,
        "upscale_width": null,
        "use_improved_sampling": "no",
        "width": 512
    }
}

Overview​

Request​

Body Attributes​

Example​

Body​

Request​

Response​

Overview

Request

Body Attributes

Example

Body

Request

Response