{"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. [Strengths] It supports complex element extraction and character consistency, allowing you to generate series of images with consistent subjects/elements using `<image_N>` syntax. [Best For] Highly recommended for: generating comic books, character design sheets, and maintaining strict visual consistency across multiple generations. [Limitations] Do NOT use this model for simple, single-shot text-to-image tasks. [Routing] Use this model when the user requests 'consistent characters' or needs to fuse multiple image elements into a new scene.","operationId":"klingV3OmniImageAsync","requestBody":{"content":{"application/json":{"examples":{"series_generation":{"summary":"Series generation with elements","value":{"aspect_ratio":"16:9","element_ids":[101,102],"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}},"single_result":{"summary":"Single-result omni image generation","value":{"aspect_ratio":"auto","images":["https://example.com/perfume-bottle.png"],"prompt":"Create a luxury perfume campaign visual using the reference bottle image","resolution":"2k","result_type":"single"}}},"schema":{"description":"Conditional rules: when `result_type=series`, omit `n` and provide `series_amount`; when `result_type=single`, omit `series_amount` and optionally use `n`. The combined count of `images` and `element_ids` must not exceed 10.","properties":{"aspect_ratio":{"default":"auto","description":"Image aspect ratio. `auto` lets the model choose an intelligent aspect ratio.","enum":["16:9","9:16","1:1","4:3","3:4","3:2","2:3","21:9","auto"],"example":"auto","type":"string"},"element_ids":{"description":"Flat element identifier list. The combined count of `images` and `element_ids` must not exceed 10.","items":{"description":"Element identifier returned by Kling element workflows","example":101,"type":"integer"},"maxItems":10,"type":"array"},"images":{"description":"Reference image list. The combined count of `images` and `element_ids` must not exceed 10.","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":{"description":"Number of images to generate when `result_type` is `single`. This field is invalid when `result_type` is `series`.","example":1,"maximum":9,"minimum":1,"type":"integer"},"prompt":{"description":"Image generation prompt, supports Chinese and English","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":"Result mode. Use `single` for one image or `series` for a multi-image sequence.","enum":["single","series"],"example":"series","type":"string"},"series_amount":{"description":"Number of frames/images to generate when `result_type` is `series`. This field is invalid when `result_type` is `single`.","example":4,"maximum":9,"minimum":2,"type":"integer"}},"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"}}}