# avatar-standard {% columns %} {% column width="66.66666666666666%" %} {% hint style="info" %} This documentation is valid for the following list of our models: * `klingai/avatar-standard` {% endhint %} {% endcolumn %} {% column width="33.33333333333334%" %} Try in Playground {% endcolumn %} {% endcolumns %} From a single image and a voice track, this model generates expressive character animations aligned with the speech’s rhythm, intonation, and meaning. This version outputs 720p video at 24 fps. ## 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](https://docs.aimlapi.com/quickstart/setting-up). ## 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 ### Create a video generation task and send it to the server You can create a video with this API by providing a reference image of a character and an audio file. The character will deliver the audio with full lip-sync and natural gestures. This POST request creates and submits a video generation task to the server — and returns a generation ID. ## POST /v2/video/generations > ```json {"openapi":"3.0.0","info":{"title":"AIML API","version":"1.0.0"},"servers":[{"url":"https://api.aimlapi.com"}],"paths":{"/v2/video/generations":{"post":{"operationId":"_v2_video_generations","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"model":{"type":"string","enum":["klingai/avatar-standard"]},"image_url":{"type":"string","format":"uri","description":"A direct link to an online image or a Base64-encoded local image that will serve as the visual base or the first frame for the video."},"audio_url":{"type":"string","description":"The URL of the audio file. Supported formats: MP3, WAV, M4A, AAC. Maximum file size: 5 MB."},"prompt":{"type":"string","maxLength":2500,"description":"The text description of the scene, subject, or action to generate in the video."}},"required":["model","image_url","audio_url"],"title":"klingai/avatar-standard"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the generated video."},"status":{"type":"string","enum":["queued","generating","completed","error"],"description":"The current status of the generation task."},"video":{"type":"object","nullable":true,"properties":{"url":{"type":"string","format":"uri","description":"The URL where the file can be downloaded from."}},"required":["url"]},"error":{"type":"object","nullable":true,"properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"],"description":"Description of the error, if any."},"meta":{"type":"object","nullable":true,"properties":{"usage":{"type":"object","nullable":true,"properties":{"credits_used":{"type":"number","description":"The number of tokens consumed during generation."}},"required":["credits_used"]}},"description":"Additional details about the generation."}},"required":["id","status"]}}}}}}}}} ``` ### 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. ## GET /v2/video/generations > ```json {"openapi":"3.0.0","info":{"title":"AIML API","version":"1.0.0"},"servers":[{"url":"https://api.aimlapi.com"}],"security":[{"access-token":[]}],"components":{"securitySchemes":{"access-token":{"scheme":"bearer","bearerFormat":"","type":"http","description":"Bearer key","in":"header"}}},"paths":{"/v2/video/generations":{"get":{"operationId":"_v2_video_generations","parameters":[{"name":"generation_id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the generated video."},"status":{"type":"string","enum":["queued","generating","completed","error"],"description":"The current status of the generation task."},"video":{"type":"object","nullable":true,"properties":{"url":{"type":"string","format":"uri","description":"The URL where the file can be downloaded from."}},"required":["url"]},"error":{"type":"object","nullable":true,"properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"],"description":"Description of the error, if any."},"meta":{"type":"object","nullable":true,"properties":{"usage":{"type":"object","nullable":true,"properties":{"credits_used":{"type":"number","description":"The number of tokens consumed during generation."}},"required":["credits_used"]}},"description":"Additional details about the generation."}},"required":["id","status"]}}}}}}}}} ``` ## Full Example: Generating and Retrieving the Video From the Server The code below creates a video generation task, then automatically polls the server every **10** seconds until it finally receives the video URL. {% tabs %} {% tab title="Python" %} {% code overflow="wrap" %} ```python import requests import time # replace with your actual AI/ML API key api_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}/video/generations" headers = { "Authorization": f"Bearer {api_key}", } data = { "model": "klingai/avatar-standard", "image_url": "https://cdn.aimlapi.com/assets/content/office_man.png", "audio_url": "https://storage.googleapis.com/falserverless/example_inputs/omnihuman_audio.mp3", # "prompt": "A person speaking playfully, laughing frequently and gesturing wildly." } 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}/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() 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 == "waiting" or status == "active" or 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() ``` {% endcode %} {% endtab %} {% tab title="JavaScript" %} {% code overflow="wrap" %} ```javascript const https = require("https"); const { URL } = require("url"); // Replace with your actual AI/ML API key const apiKey = ""; 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: "klingai/avatar-standard", image_url: "https://cdn.aimlapi.com/assets/content/office_man.png", audio_url: "https://storage.googleapis.com/falserverless/example_inputs/omnihuman_audio.mp3", // prompt: 'A person speaking playfully, laughing frequently and gesturing wildly.', }); const url = new URL(`${baseUrl}/video/generations`); 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}/video/generations`); 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(); ``` {% endcode %} {% endtab %} {% endtabs %}
Response {% code overflow="wrap" %} ```json5 {'id': '76a3553b-7c4f-4fe1-9682-72008ef3a0fe:klingai/avatar-standard', 'status': 'queued', 'meta': {'usage': {'tokens_used': 590100}}} Generation ID: 76a3553b-7c4f-4fe1-9682-72008ef3a0fe:klingai/avatar-standard 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: 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: 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: 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: generating Still waiting... Checking again in 10 seconds. Status: completed Processing complete:\n {'id': '76a3553b-7c4f-4fe1-9682-72008ef3a0fe:klingai/avatar-standard', 'status': 'completed', 'video': {'url': 'https://cdn.aimlapi.com/flamingo/files/b/zebra/-pjJHb89XFkYTPOQjb5G2_output.mp4'}} ``` {% endcode %}
**Generation time:** \~ 4 min. **Original** (1280x720, with sound): {% embed url="" %} The following video was generated by adding just one line to our example: {% tabs %} {% tab title="Python" %} {% code overflow="wrap" %} ```python "prompt": "A person speaking playfully, laughing frequently and gesturing wildly." ``` {% endcode %} {% endtab %} {% tab title="JS" %} {% code overflow="wrap" %} ```python prompt: 'A person speaking playfully, laughing frequently and gesturing wildly.', ``` {% endcode %} {% endtab %} {% endtabs %} See how dramatically the `prompt` parameter can change the character’s behavior and mannerisms: {% embed url="" %} `"prompt": "A person speaking playfully, laughing frequently and gesturing wildly."` {% endembed %}