> ## Documentation Index
> Fetch the complete documentation index at: https://docs.modellix.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Kling V3 Omni Image

> [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.



## OpenAPI

````yaml /model-api/kling/kling-i2i.json post /kling/kling-v3-omni-image
openapi: 3.1.0
info:
  description: The image-to-image models API from Kling AI.
  version: 1.0.0
  contact:
    name: Modellix Support
    email: support@modellix.ai
  title: Kling Image-to-Image Models API
servers:
  - url: https://api.modellix.ai/api/v1
    description: The image-to-image models API from Kling AI.
security:
  - bearerAuth: []
paths:
  /kling/kling-v3-omni-image:
    post:
      summary: Kling V3 Omni Image
      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:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KlingV3OmniImageRequest'
            examples:
              with_reference:
                summary: Omni image with reference
                value:
                  prompt: >-
                    Create a luxury perfume campaign visual using the reference
                    bottle image
                  images:
                    - https://example.com/perfume-bottle.png
                  resolution: 2k
                  aspect_ratio: '1:1'
              high_resolution:
                summary: 4K generation
                value:
                  prompt: >-
                    Generate a cinematic portrait of a robot exploring an
                    ancient temple
                  images:
                    - https://example.com/robot-reference.png
                  resolution: 4k
                  aspect_ratio: '16:9'
                  'n': 2
              series_generation:
                summary: Series generation
                value:
                  prompt: >-
                    Generate a four-frame comic sequence of a robot exploring an
                    ancient temple
                  images:
                    - https://example.com/robot-reference.png
                  resolution: 4k
                  result_type: series
                  series_amount: 4
                  aspect_ratio: '16:9'
      responses:
        '200':
          description: Task submitted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskResponse'
              example:
                code: 0
                message: success
                data:
                  status: pending
                  task_id: task-v3-omni-image-123
                  model_id: model-123
                  get_result:
                    method: GET
                    url: >-
                      https://api.modellix.ai/api/v1/tasks/task-v3-omni-image-123
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    KlingV3OmniImageRequest:
      type: object
      required:
        - prompt
      properties:
        prompt:
          type: string
          description: >-
            Image generation prompt, supports Chinese and English. May reference
            images as <<<image_1>>> style placeholders.
          minLength: 1
          maxLength: 2500
          example: >-
            Create a luxury perfume campaign visual using the reference bottle
            image
        images:
          type: array
          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.
          minItems: 1
          maxItems: 10
          items:
            type: string
            description: Reference image URL or Base64 encoded data
            minLength: 1
            example: https://example.com/perfume-bottle.png
        resolution:
          type: string
          description: Output resolution. Kling V3 Omni supports 1K, 2K, and 4K output.
          default: 1k
          enum:
            - 1k
            - 2k
            - 4k
          example: 4k
        result_type:
          type: string
          description: >-
            Generate a single image or a series. When `series`, `n` is invalid;
            when `single`, `series_amount` is invalid.
          default: single
          enum:
            - single
            - series
          example: single
        'n':
          type: integer
          description: >-
            Number of images to generate when `result_type` is `single`. Invalid
            when `result_type` is `series`.
          default: 1
          minimum: 1
          maximum: 9
          example: 1
        series_amount:
          description: >-
            Number of images when `result_type` is `series`. Accepts 2–9 or
            `auto`. Invalid when `result_type` is `single`.
          default: 4
          oneOf:
            - type: integer
              enum:
                - 2
                - 3
                - 4
                - 5
                - 6
                - 7
                - 8
                - 9
            - type: string
              enum:
                - auto
          example: 4
        aspect_ratio:
          type: string
          description: Image aspect ratio. When omitted, the platform fills `1:1`.
          default: '1:1'
          enum:
            - '16:9'
            - '9:16'
            - '1:1'
            - '4:3'
            - '3:4'
            - '3:2'
            - '2:3'
            - '21:9'
          example: '1:1'
      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.
    AsyncTaskResponse:
      type: object
      required:
        - code
        - message
        - data
      properties:
        code:
          type: integer
          description: Response code, 0 indicates success
          example: 0
        message:
          type: string
          description: Response message
          example: success
        data:
          type: object
          required:
            - status
            - task_id
            - model_id
          properties:
            status:
              type: string
              enum:
                - pending
                - processing
              description: Task status
              example: pending
            task_id:
              type: string
              description: Unique task identifier
              example: task-abc123
            model_id:
              type: string
              description: Model ID
              example: model-123
            get_result:
              type: object
              description: API information to query the task result
              properties:
                method:
                  type: string
                  description: HTTP method
                  example: GET
                url:
                  type: string
                  description: Full URL to query the task result
                  example: https://api.modellix.ai/api/v1/tasks/task-abc123
          description: Detailed data about the submitted asynchronous task.
    ErrorResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          description: Error code (equals HTTP status code)
          example: 400
        message:
          type: string
          description: 'Error message in format ''Category: detail'''
          example: 'Invalid parameters: parameter ''image'' is required'
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 400
            message: 'Invalid parameters: parameter ''image'' is required'
    Unauthorized:
      description: Unauthorized - Invalid or missing API Key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 401
            message: 'Authentication failed: invalid API key'
    TooManyRequests:
      description: Too many requests - Rate limit exceeded
      headers:
        X-RateLimit-Limit:
          description: Maximum requests per minute
          schema:
            type: integer
            example: 100
        X-RateLimit-Remaining:
          description: Remaining quota in current window
          schema:
            type: integer
            example: 0
        X-RateLimit-Reset:
          description: Rate limit window reset time (Unix timestamp)
          schema:
            type: integer
            example: 1704067260
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 429
            message: >-
              Rate limit exceeded: 100 requests per minute, retry after 60
              seconds
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 500
            message: Internal server error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API Key authentication. Format: `Bearer YOUR_API_KEY`.'

````