# o1/video-to-video-reference {% columns %} {% column width="66.66666666666666%" %} {% hint style="info" %} This documentation is valid for the following list of our models: * `klingai/video-o1-video-to-video-reference` {% endhint %} {% endcolumn %} {% column width="33.33333333333334%" %} Try in Playground {% endcolumn %} {% endcolumns %} ## Model Overview The model that performs video-to-video editing by applying a reference style or identity to source footage, enabling appearance transfer across clips while preserving motion and structure from the original video. The model is well-suited for maintaining consistent characters, branding elements, or artistic style over multiple outputs derived from related source videos. ## How to Make a Call
Step-by-Step Instructions :digit\_one: **Setup You Can’t Skip** :black\_small\_square: [**Create an Account**](https://aimlapi.com/app/sign-up): Visit the AI/ML API website and create an account (if you don’t have one yet).\ :black\_small\_square: [**Generate an API Key**](https://aimlapi.com/app/keys): After logging in, navigate to your account dashboard and generate your API key. Ensure the key is enabled on the UI. :digit\_two: **Copy the code example** At the bottom of this page, you'll find a code example that shows how to structure the request. Choose the code snippet in your preferred programming language and copy it into your development environment. :digit\_three: **Modify the code example** :black\_small\_square: Replace `` with your actual AI/ML API key.\ :black\_small\_square: Adjust the input field used by this model (for example, prompt, input text, instructions, media source, or other model-specific input) to match your request. :digit\_four: **(Optional)** **Adjust other optional parameters if needed** Only the required parameters shown in the example are needed to run the request, but you can include optional parameters to fine-tune behavior. Below, you can find the corresponding **API schema**, which lists all available parameters and usage notes. :digit\_five: **Run your modified code** Run your modified code inside your development environment. Response time depends on many factors, but for simple requests it rarely exceeds a few seconds. {% hint style="success" %} If you need a more detailed walkthrough for setting up your development environment and making a request step-by-step, feel free to use our [**Quickstart guide.**](https://docs.aimlapi.com/quickstart/setting-up) {% endhint %}
## API Schemas ### Create a video generation task and send it to the server ## 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/video-o1-video-to-video-reference"]},"prompt":{"type":"string","maxLength":2500,"description":"The text description of the scene, subject, or action to generate in the video."},"video_url":{"type":"string","format":"uri","description":"A HTTPS URL pointing to a video or a data URI containing a video. This video will be used as a reference during generation."},"image_list":{"type":"array","items":{"type":"string","format":"uri"},"minItems":1,"maxItems":4,"description":"Array of image URLs for multi-image-to-video generation."},"aspect_ratio":{"type":"string","enum":["16:9","9:16","1:1"],"default":"16:9","description":"The aspect ratio of the generated video."},"duration":{"type":"integer","description":"The length of the output video in seconds.","enum":[5,10],"default":"5"},"elements":{"type":"array","items":{"type":"object","properties":{"reference_image_urls":{"type":"array","items":{"type":"string","format":"uri"},"minItems":1,"maxItems":4,"description":"Additional reference images from different angles."},"frontal_image_url":{"type":"string","format":"uri","description":"The frontal image of the element (main view)."}},"required":["reference_image_urls","frontal_image_url"]},"maxItems":4,"description":"Elements (characters/objects) to include in the video."},"keep_audio":{"type":"boolean","default":false,"description":"Whether to keep the original audio from the video."}},"required":["model","prompt","video_url"],"title":"klingai/video-o1-video-to-video-reference"}}}},"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"]}}}}}}}}} ``` ## Code Example The code below creates a video generation task, then automatically polls the server every **15** seconds until it finally receives the video URL. {% tabs %} {% tab title="Python" %} {% code overflow="wrap" %} ```python import requests import time # Insert your AIML API Key instead of : 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/video-o1-video-to-video-reference", "prompt":''' Add a small fairy as a rider on the raccoon’s back. She must have a black-and-golden face and a cloak in the colors of a dark emerald tropical butterfly with bright blue shimmering spots. ''', "video_url": "https://raw.githubusercontent.com/aimlapi/api-docs/main/reference-files/racoon-in-the-forest.mp4" } 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() 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) # 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 ["waiting", "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: "klingai/video-o1-video-to-video-reference", prompt: ` Add a small fairy as a rider on the raccoon’s back. She must have a black-and-golden face and a cloak in the colors of a dark emerald tropical butterfly with bright blue shimmering spots.`, video_url: "https://raw.githubusercontent.com/aimlapi/api-docs/main/reference-files/racoon-in-the-forest.mp4", }); 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 15 seconds until completion or timeout function main() { generateVideo((genResponse) => { 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 = () => { 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; if (["waiting", "queued", "generating"].includes(status)) { console.log(`Status: ${status}. Checking again in 15 seconds.`); setTimeout(checkStatus, interval); } else { console.log("Processing complete:\n", responseData); } }); }; checkStatus(); }) } main(); ``` {% endcode %} {% endtab %} {% endtabs %}
Response {% code overflow="wrap" %} ```json5 Generation ID: 6a3ada23-8eb3-4e29-948a-59e5bc2074c5:klingai/video-o1-video-to-video-reference Status: generating. 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. Status: generating. 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. Status: generating. 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. Status: generating. Checking again in 15 seconds. Processing complete: {'id': '6a3ada23-8eb3-4e29-948a-59e5bc2074c5:klingai/video-o1-video-to-video-reference', 'status': 'completed', 'video': {'url': 'https://cdn.aimlapi.com/flamingo/files/b/0a878546/2Wt0iDavlysQHFuP3_8I5_output.mp4'}} ``` {% endcode %}
**Processing time**: \~ 3 min 23 sec. **Generated video** (1920x1080, without sound): {% embed url="" %} --- # 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/kling-ai/video-o1-video-to-video-reference.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.