{"servers":[{"url":"https://api.modellix.ai/api/v1/kling/kling-v3-omni-video/async"}],"post":{"description":"Kling V3 Omni video model for advanced prompt-guided video generation with simplified intelligent multi-shot support and flattened media references.","operationId":"klingV3OmniVideoAsync","requestBody":{"content":{"application/json":{"examples":{"multi_shot_intelligence":{"summary":"Intelligent multi-shot generation","value":{"aspect_ratio":"16:9","duration":10,"images":["https://example.com/reference-frame.jpg"],"mode":"pro","multi_shot":true,"prompt":"A woman leaves a subway station and walks into a rainy cyberpunk street, then the camera tracks beside her","shot_type":"intelligence","sound":"off"}},"video_edit":{"summary":"Video editing flow","value":{"mode":"pro","prompt":"Transform the source clip into a cinematic sci-fi sequence with brighter neon lighting","sound":"off","videos":["https://example.com/source-video.mp4"]}}},"schema":{"description":"Conditional rules: when `multi_shot=false`, `prompt` is required and `shot_type` must be omitted. When `multi_shot=true`, `shot_type` must be `intelligence` and `prompt` is still required. When `videos` is provided, `sound` must be `off` and `duration` must be omitted.","properties":{"aspect_ratio":{"description":"Video aspect ratio.","enum":["16:9","9:16","1:1"],"example":"16:9","type":"string"},"duration":{"default":5,"description":"Video duration in seconds. Public API accepts integer values. Valid values are 3-15 when `videos` is not supplied.","enum":[3,4,5,6,7,8,9,10,11,12,13,14,15],"example":8,"type":"integer"},"images":{"description":"Optional reference image list.","items":{"description":"Reference image URL or Base64 string.","example":"https://example.com/reference-frame.jpg","minLength":1,"type":"string"},"minItems":1,"type":"array"},"mode":{"default":"pro","description":"Generation mode.","enum":["std","pro"],"example":"pro","type":"string"},"multi_shot":{"default":false,"description":"Enable intelligent multi-shot generation.","example":false,"type":"boolean"},"prompt":{"description":"Video generation prompt.","example":"Transform the source clip into a cinematic sci-fi sequence","maxLength":2500,"minLength":1,"type":"string"},"shot_type":{"description":"Required when `multi_shot` is true. Only `intelligence` is supported in the public API.","enum":["intelligence"],"example":"intelligence","type":"string"},"sound":{"default":"off","description":"Audio generation switch. Must remain `off` whenever `videos` is provided.","enum":["on","off"],"example":"off","type":"string"},"videos":{"description":"Optional reference video list. When provided, `sound` must be `off` and `duration` must be omitted.","items":{"description":"Reference video URL or Base64 string.","example":"https://example.com/source-video.mp4","minLength":1,"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["prompt"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"code":0,"data":{"get_result":{"method":"GET","url":"https://api.modellix.ai/api/v1/tasks/task-v2v-def456"},"model_id":"model-123","status":"pending","task_id":"task-v2v-def456"},"message":"success"},"schema":{"properties":{"code":{"description":"Response code, 0 indicates success","example":0,"type":"integer"},"data":{"description":"Detailed data about the submitted asynchronous task.","properties":{"get_result":{"description":"API information to query the task result","properties":{"method":{"description":"HTTP method","example":"GET","type":"string"},"url":{"description":"Full URL to query the task result","example":"https://api.modellix.ai/api/v1/tasks/task-v2v-abc123","type":"string"}},"type":"object"},"model_id":{"description":"Model ID","example":"model-123","type":"string"},"status":{"description":"Task status","enum":["pending","processing"],"example":"pending","type":"string"},"task_id":{"description":"Unique task identifier","example":"task-v2v-abc123","type":"string"}},"required":["status","task_id","model_id"],"type":"object"},"message":{"description":"Response message","example":"success","type":"string"}},"required":["code","message","data"],"type":"object"}}},"description":"Task submitted successfully"},"400":{"content":{"application/json":{"example":{"code":400,"message":"Invalid parameters: prompt is required when multi_shot is false"},"schema":{"properties":{"code":{"description":"Error code (equals HTTP status code)","example":400,"type":"integer"},"message":{"description":"Error message in format 'Category: detail'","example":"Invalid parameters: prompt is required when multi_shot is false","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"example":{"code":401,"message":"Authentication failed: invalid API key"},"schema":{"properties":{"code":{"description":"Error code (equals HTTP status code)","example":400,"type":"integer"},"message":{"description":"Error message in format 'Category: detail'","example":"Invalid parameters: prompt is required when multi_shot is false","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Unauthorized - Invalid or missing API Key"},"429":{"content":{"application/json":{"example":{"code":429,"message":"Rate limit exceeded: 100 requests per minute, retry after 60 seconds"},"schema":{"properties":{"code":{"description":"Error code (equals HTTP status code)","example":400,"type":"integer"},"message":{"description":"Error message in format 'Category: detail'","example":"Invalid parameters: prompt is required when multi_shot is false","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Too many requests - Rate limit exceeded","headers":{"X-RateLimit-Limit":{"description":"Maximum requests per minute","schema":{"example":100,"type":"integer"}},"X-RateLimit-Remaining":{"description":"Remaining quota in current window","schema":{"example":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"Rate limit window reset time (Unix timestamp)","schema":{"example":1704067260,"type":"integer"}}}},"500":{"content":{"application/json":{"example":{"code":500,"message":"Internal server error"},"schema":{"properties":{"code":{"description":"Error code (equals HTTP status code)","example":400,"type":"integer"},"message":{"description":"Error message in format 'Category: detail'","example":"Invalid parameters: prompt is required when multi_shot is false","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Internal server error"}},"summary":"Kling V3 Omni Video","x-mint":{"href":"kling/kling-v3-omni-video"}}}