# OmniHuman {% columns %} {% column width="66.66666666666666%" %} {% hint style="info" %} This documentation is valid for the following list of our models: * `bytedance/omnihuman` {% endhint %} {% endcolumn %} {% column width="33.33333333333334%" %} Try in Playground {% endcolumn %} {% endcolumns %} An advanced AI framework from ByteDance that generates realistic lip-sync videos from a single image and motion signals (audio). It supports multiple visual and audio styles and produces videos in any body proportion, with realism enhanced by motion, lighting, and texture details. ## 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":["bytedance/omnihuman"]},"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","format":"uri","description":"The URL of the audio file for lip-sync animation. The model detects spoken parts and syncs the character's mouth to them. Audio must be under 30s long."}},"required":["model","image_url","audio_url"],"title":"bytedance/omnihuman"}}}},"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 `generation_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": "bytedance/omnihuman", "image_url": "https://s2-111386.kwimgs.com/bs2/mmu-aiplatform-temp/kling/20240620/1.jpeg", "audio_url": "https://storage.googleapis.com/falserverless/example_inputs/omnihuman_audio.mp3", } 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") 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() ``` {% 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: "bytedance/omnihuman", image_url: "https://s2-111386.kwimgs.com/bs2/mmu-aiplatform-temp/kling/20240620/1.jpeg", audio_url: "https://storage.googleapis.com/falserverless/example_inputs/omnihuman_audio.mp3", }); 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': '9e730e80-40e2-4461-ba1b-1cc15df10b4f:bytedance/omnihuman', 'status': 'queued', 'meta': {'usage': {'tokens_used': 5880000}}} Generation ID: 9e730e80-40e2-4461-ba1b-1cc15df10b4f:bytedance/omnihuman 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': '9e730e80-40e2-4461-ba1b-1cc15df10b4f:bytedance/omnihuman', 'status': 'completed', 'video': {'url': 'https://v3b.fal.media/files/b/tiger/3q9C4sDWWOX63lEz42Ohb_video.mp4'}} ``` {% endcode %}
**Original (with sound)**: [896x1344](https://drive.google.com/file/d/1WOkEu1iB3kl8UeCcEjFj1Qn29i_LBj5Y/view?usp=sharing) **Low-res GIF preview**:
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.aimlapi.com/api-references/video-models/bytedance/omnihuman.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.