{"servers":[{"url":"https://api.modellix.ai/api/v1/kling/kling-v3-omni-image"}],"post":{"description":"[Core Function] Kling V3 Omni Image is a unified multimodal image generation endpoint (POST /images/omni-image). [Strengths] Multi-image reference, up to 4K, and optional series generation via result_type/series_amount. Use <<<image_N>>> placeholders in prompt. [Best For] Character consistency, fusing multiple reference images, and comic/storyboard series. [Limitations] Element library IDs are not exposed. Default aspect_ratio is 1:1 when omitted. [Routing] Prefer for multi-image fusion or series; use kling-v3-t2i/i2i for standard single-shot generation.","operationId":"klingV3OmniImageAsync","requestBody":{"content":{"application/json":{"examples":{"high_resolution":{"summary":"4K generation","value":{"aspect_ratio":"16:9","images":["https://example.com/robot-reference.png"],"n":2,"prompt":"Generate a cinematic portrait of a robot exploring an ancient temple","resolution":"4k"}},"series_generation":{"summary":"Series generation","value":{"aspect_ratio":"16:9","images":["https://example.com/robot-reference.png"],"prompt":"Generate a four-frame comic sequence of a robot exploring an ancient temple","resolution":"4k","result_type":"series","series_amount":4}},"with_reference":{"summary":"Omni image with reference","value":{"aspect_ratio":"1:1","images":["https://example.com/perfume-bottle.png"],"prompt":"Create a luxury perfume campaign visual using the reference bottle image","resolution":"2k"}}},"schema":{"description":"Kling V3 Omni Image (POST /images/omni-image, model_name=kling-v3-omni). Supports result_type/series_amount. Element is not exposed. Default aspect_ratio is 1:1 when omitted.","properties":{"aspect_ratio":{"default":"1:1","description":"Image aspect ratio. When omitted, the platform fills `1:1`.","enum":["16:9","9:16","1:1","4:3","3:4","3:2","2:3","21:9"],"example":"1:1","type":"string"},"images":{"description":"Optional reference image list (URL or Base64). When provided, must contain 1–10 items. Empty array is invalid. Element library IDs are not exposed.","items":{"description":"Reference image URL or Base64 encoded data","example":"https://example.com/perfume-bottle.png","minLength":1,"type":"string"},"maxItems":10,"minItems":1,"type":"array"},"n":{"default":1,"description":"Number of images to generate when `result_type` is `single`. Invalid when `result_type` is `series`.","example":1,"maximum":9,"minimum":1,"type":"integer"},"prompt":{"description":"Image generation prompt, supports Chinese and English. May reference images as <<<image_1>>> style placeholders.","example":"Create a luxury perfume campaign visual using the reference bottle image","maxLength":2500,"minLength":1,"type":"string"},"resolution":{"default":"1k","description":"Output resolution. Kling V3 Omni supports 1K, 2K, and 4K output.","enum":["1k","2k","4k"],"example":"4k","type":"string"},"result_type":{"default":"single","description":"Generate a single image or a series. When `series`, `n` is invalid; when `single`, `series_amount` is invalid.","enum":["single","series"],"example":"single","type":"string"},"series_amount":{"default":4,"description":"Number of images when `result_type` is `series`. Accepts 2–9 or `auto`. Invalid when `result_type` is `single`.","example":4,"oneOf":[{"enum":[2,3,4,5,6,7,8,9],"type":"integer"},{"enum":["auto"],"type":"string"}]}},"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-v3-omni-image-123"},"model_id":"model-123","status":"pending","task_id":"task-v3-omni-image-123"},"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-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-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: parameter 'image' is required"},"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: parameter 'image' is required","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: parameter 'image' is required","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: parameter 'image' is required","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: parameter 'image' is required","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Internal server error"}},"summary":"Kling V3 Omni Image","x-mint":{"href":"kling/kling-v3-omni-image"}}}