This model provides faster image-to-video rendering with consistently sharp, realistic, and cinematic-quality results. This model also generates videos with synchronized audio. For lip-sync input, you may supply text with a predefined voice.
Setup your API Key
If you don’t have an API key for the AI/ML API yet, feel free to use our Quickstart guide.
How to Make a Call
Step-by-Step Instructions
Generating a video using this model involves sequentially calling two endpoints:
The first one is for creating and sending a video generation task to the server (returns a generation ID).
The second one is for requesting the generated video from the server using the generation ID received from the first endpoint.
Below, you can find both corresponding API schemas.
API Schemas
Now, all of our API schemas for video models use our new universal short URL — https://api.aimlapi.com/v2/video/generations.
However, you can still call this model using the legacy URL that includes the vendor name.
Create a video generation task and send it to the server
You can generate a video using this API. In the basic setup, you only need a reference image and a prompt. This endpoint creates and sends a video generation task to the server — and returns a generation ID. For lip-sync input, you may supply text (lip_sync_tts_content) with a predefined voice (lip_sync_tts_speaker).
post
Body
modelstring · enumRequiredPossible values:
promptstringRequired
The text description of the scene, subject, or action to generate in the video.
image_urlstring · uriRequired
URL of the image to be used as the first frame of the video.
resolutionstring · enumOptional
An enumeration where the short side of the video frame determines the resolution.
Default: 720pPossible values:
durationinteger · enumOptional
The output video length in seconds. The 1080p quality option does not support 8-second videos.
Default: 5Possible values:
negative_promptstringOptional
The description of elements to avoid in the generated video.
stylestring · enumOptional
The style of the generated video.
Possible values:
seedintegerOptional
Varying the seed integer is a way to get different results for the same other request parameters. Using the same value for an identical request will produce similar results. If unspecified, a random number is chosen.
lip_sync_tts_contentstringOptional
The text content to be lip-synced in the video.
lip_sync_tts_speakerstring · enumOptional
A predefined system voice used for generating speech in the video.
Possible values:
Responses
200Success
application/json
post
/v2/video/generations
200Success
Retrieve the generated video from the server
After sending a request for video generation, this task is added to the queue. This endpoint lets you check the status of a video generation task using its id, obtained from the endpoint described above.
If the video generation task status is completed, the response will include the final result — with the generated video URL and additional metadata.
Now let’s test the parameters related to the lip-sync feature. We’ll generate a video with some character and give them a piece of text to speak. The text goes into the lip_sync_tts_content parameter, and the lip_sync_tts_speaker parameter selects one of the predefined voices.
The code below, just like in the first example, creates a video generation task and then automatically polls the server every 15 seconds until it finally receives the video URL.
import requests
import time
# replace <YOUR_AIMLAPI_KEY> with your actual AI/ML API key
api_key = "<YOUR_AIMLAPI_KEY>"
base_url = "https://api.aimlapi.com/v2"
# Creating and sending a video generation task to the server
def generate_video():
url = f"{base_url}/generate/video/pixverse/generation"
headers = {
"Authorization": f"Bearer {api_key}",
}
data = {
"model": "pixverse/v5/image-to-video",
"prompt": "Mona Lisa puts on glasses with her hands.",
"image_url": "https://s2-111386.kwimgs.com/bs2/mmu-aiplatform-temp/kling/20240620/1.jpeg",
"duration": 5
}
response = requests.post(url, json=data, headers=headers)
if response.status_code >= 400:
print(f"Error: {response.status_code} - {response.text}")
else:
response_data = response.json()
print(response_data)
return response_data
# Requesting the result of the task from the server using the generation_id
def get_video(gen_id):
url = f"{base_url}/generate/video/pixverse/generation"
params = {
"generation_id": gen_id,
}
# Insert your AIML API Key instead of <YOUR_AIMLAPI_KEY>:
headers = {
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json"
}
response = requests.get(url, params=params, headers=headers)
# print("Generation:", response.json())
return response.json()
def main():
# Running video generation and getting a task id
gen_response = generate_video()
gen_id = gen_response.get("id")
print("Generation ID: ", gen_id)
# Trying to retrieve the video from the server every 10 sec
if gen_id:
start_time = time.time()
timeout = 600
while time.time() - start_time < timeout:
response_data = get_video(gen_id)
if response_data is None:
print("Error: No response from API")
break
status = response_data.get("status")
print("Status:", status)
if status == "queued" or status == "generating":
print("Still waiting... Checking again in 10 seconds.")
time.sleep(10)
else:
print("Processing complete:\n", response_data)
return response_data
print("Timeout reached. Stopping.")
return None
if __name__ == "__main__":
main()
const https = require("https");
const { URL } = require("url");
// Replace <YOUR_AIMLAPI_KEY> with your actual AI/ML API key
const apiKey = "<YOUR_AIMLAPI_KEY>";
const baseUrl = "https://api.aimlapi.com/v2";
// Creating and sending a video generation task to the server
function generateVideo(callback) {
const data = JSON.stringify({
model: "pixverse/v5/image-to-video",
prompt: "Mona Lisa puts on glasses with her hands.",
image_url: "https://s2-111386.kwimgs.com/bs2/mmu-aiplatform-temp/kling/20240620/1.jpeg",
duration: 5,
});
const url = new URL(`${baseUrl}/generate/video/pixverse/generation`);
const options = {
method: "POST",
headers: {
"Authorization": `Bearer ${apiKey}`,
"Content-Type": "application/json",
"Content-Length": Buffer.byteLength(data),
},
};
const req = https.request(url, options, (res) => {
let body = "";
res.on("data", (chunk) => body += chunk);
res.on("end", () => {
if (res.statusCode >= 400) {
console.error(`Error: ${res.statusCode} - ${body}`);
callback(null);
} else {
const parsed = JSON.parse(body);
callback(parsed);
}
});
});
req.on("error", (err) => console.error("Request error:", err));
req.write(data);
req.end();
}
// Requesting the result of the task from the server using the generation_id
function getVideo(genId, callback) {
const url = new URL(`${baseUrl}/generate/video/pixverse/generation`);
url.searchParams.append("generation_id", genId);
const options = {
method: "GET",
headers: {
"Authorization": `Bearer ${apiKey}`,
"Content-Type": "application/json",
},
};
const req = https.request(url, options, (res) => {
let body = "";
res.on("data", (chunk) => body += chunk);
res.on("end", () => {
const parsed = JSON.parse(body);
callback(parsed);
});
});
req.on("error", (err) => console.error("Request error:", err));
req.end();
}
// Initiates video generation and checks the status every 10 seconds until completion or timeout
function main() {
generateVideo((genResponse) => {
if (!genResponse || !genResponse.id) {
console.error("Failed to start generation");
return;
}
const genId = genResponse.id;
console.log("Gen_ID:", genId);
const startTime = Date.now();
const timeout = 600000;
const checkStatus = () => {
if (Date.now() - startTime > timeout) {
console.log("Timeout reached. Stopping.");
return;
}
getVideo(genId, (responseData) => {
if (!responseData) {
console.error("Error: No response from API");
return;
}
const status = responseData.status;
console.log("Status:", status);
if (["waiting", "active", "queued", "generating"].includes(status)) {
console.log("Still waiting... Checking again in 10 seconds.");
setTimeout(checkStatus, 10000);
} else {
console.log("Processing complete:\n", responseData);
}
});
};
checkStatus();
});
}
main();
{'id': '8ac142d3-7c9f-4071-bdc6-d0f2d3d9b327:pixverse/v5/image-to-video', 'status': 'queued', 'meta': {'usage': {'tokens_used': 420000}}}
Generation ID: 8ac142d3-7c9f-4071-bdc6-d0f2d3d9b327:pixverse/v5/image-to-video
Status: generating
Still waiting... Checking again in 10 seconds.
Status: generating
Still waiting... Checking again in 10 seconds.
Status: generating
Still waiting... Checking again in 10 seconds.
Status: generating
Still waiting... Checking again in 10 seconds.
Status: generating
Still waiting... Checking again in 10 seconds.
Status: completed
Processing complete:\n {'id': '8ac142d3-7c9f-4071-bdc6-d0f2d3d9b327:pixverse/v5/image-to-video', 'status': 'completed', 'video': {'url': 'https://cdn.aimlapi.com/eagle/files/elephant/uCLDKRtL_AeOrRAwiR8UH_output.mp4', 'content_type': 'video/mp4', 'file_name': 'output.mp4', 'file_size': 4259218}}
import requests
import time
# Insert your AI/ML API key instead of <YOUR_AIMLAPI_KEY>:
api_key = "<YOUR_AIMLAPI_KEY>"
# Creating and sending a video generation task to the server
def generate_video():
url = "https://api.aimlapi.com/v2/video/generations"
headers = {
"Authorization": f"Bearer {api_key}",
}
data = {
"model": "pixverse/v5/image-to-video",
"image_url": "https://raw.githubusercontent.com/aimlapi/api-docs/main/reference-files/news-presenter.jpg",
"prompt": "A young news presenter standing in the studio, facing the camera directly, eyes always on the camera, calm and professional, very still posture, minimal head movement, no sudden gestures, with a gentle friendly smile, confident stance, studio lighting, broadcast framing, realistic style, neutral background activity.",
"lip_sync_tts_content": "Hello and welcome. This is our latest news update, and here are the headlines.",
"lip_sync_tts_speaker": "Chloe"
}
response = requests.post(url, json=data, headers=headers)
if response.status_code >= 400:
print(f"Error: {response.status_code} - {response.text}")
else:
response_data = response.json()
# print(response_data)
return response_data
# Requesting the result of the task from the server using the generation_id
def get_video(gen_id):
url = "https://api.aimlapi.com/v2/video/generations"
params = {
"generation_id": gen_id,
}
headers = {
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json"
}
response = requests.get(url, params=params, headers=headers)
return response.json()
def main():
# Running video generation and getting a task id
gen_response = generate_video()
print(gen_response)
gen_id = gen_response.get("id")
print("Generation ID: ", gen_id)
# Try to retrieve the video from the server every 15 sec
if gen_id:
start_time = time.time()
timeout = 1000
while time.time() - start_time < timeout:
response_data = get_video(gen_id)
if response_data is None:
print("Error: No response from API")
break
status = response_data.get("status")
if status in ["queued", "generating"]:
print(f"Status: {status}. Checking again in 15 seconds.")
time.sleep(15)
else:
print("Processing complete:\n", response_data)
return response_data
print("Timeout reached. Stopping.")
return None
if __name__ == "__main__":
main()
// Insert your AIML API Key instead of <YOUR_AIMLAPI_KEY>
const apiKey = '<YOUR_AIMLAPI_KEY>';
// Creating and sending a video generation task to the server
async function generateVideo() {
const url = 'https://api.aimlapi.com/v2/video/generations';
const data = {
model: 'pixverse/v5/image-to-video',
image_url: 'https://raw.githubusercontent.com/aimlapi/api-docs/main/reference-files/news-presenter.jpg',
prompt: 'A young news presenter standing in the studio, facing the camera directly, eyes always on the camera, calm and professional, very still posture, minimal head movement, no sudden gestures, with a gentle friendly smile, confident stance, studio lighting, broadcast framing, realistic style, neutral background activity.',
lip_sync_tts_content: 'Hello and welcome. This is our latest news update, and here are the headlines.',
lip_sync_tts_speaker: 'Chloe'
};
try {
const response = await fetch(url, {
method: 'POST',
headers: {
Authorization: `Bearer ${apiKey}`,
'Content-Type': 'application/json',
},
body: JSON.stringify(data),
});
if (!response.ok) {
const errorText = await response.text();
console.error(`Error: ${response.status} - ${errorText}`);
return null;
}
const responseData = await response.json();
console.log(responseData);
return responseData;
} catch (error) {
console.error('Request failed:', error);
return null;
}
}
// Requesting the result of the task from the server using the generation_id
async function getVideo(genId) {
const url = new URL('https://api.aimlapi.com/v2/video/generations');
url.searchParams.append('generation_id', genId);
try {
const response = await fetch(url, {
method: 'GET',
headers: {
Authorization: `Bearer ${apiKey}`,
'Content-Type': 'application/json',
},
});
return await response.json();
} catch (error) {
console.error('Error fetching video:', error);
return null;
}
}
// Initiates video generation and checks the status every 15 seconds until completion or timeout
async function main() {
const genResponse = await generateVideo();
if (!genResponse || !genResponse.id) {
console.error("No generation ID received.");
return;
}
const genId = genResponse.id;
console.log("Generation ID:", genId);
const timeout = 1000 * 1000; // 1000 sec
const interval = 15 * 1000; // 15 sec
const startTime = Date.now();
const checkStatus = async () => {
if (Date.now() - startTime >= timeout) {
console.log("Timeout reached. Stopping.");
return;
}
const responseData = await getVideo(genId);
if (!responseData) {
console.error("Error: No response from API");
return;
}
const status = responseData.status;
if (["waiting", "queued", "generating"].includes(status)) {
console.log(`Status: ${status}. Checking again in 15 seconds.`);
await new Promise(resolve => setTimeout(resolve, interval));
return checkStatus();
} else {
console.log("Processing complete:\n", responseData);
}
};
await checkStatus();
}
main();
{'id': '3yFHGAkECD5RPnpL11mHe', 'status': 'queued', 'meta': {'usage': {'credits_used': 2000000}}}
Generation ID: 3yFHGAkECD5RPnpL11mHe
Status: queued. Checking again in 15 seconds.
Status: generating. Checking again in 15 seconds.
Status: generating. Checking again in 15 seconds.
Status: generating. Checking again in 15 seconds.
Processing complete:
{'id': '3yFHGAkECD5RPnpL11mHe', 'status': 'succeeded', 'video': {'url': 'https://cdn.aimlapi.com/panda/pixverse%2Fmp4%2Fmedia%2Fweb%2Fori%2FJVT-OZSEbeCvZ2IKlQK6p_seed1592035041.mp4'}}
