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

# Vidu Q3 AD (Keyframe Short Play)

> [Core Function] Vidu Q3 AD is a keyframe-driven short-play (short drama) Image-to-Video model that turns a film-style script plus character, scene, and prop reference images into a complete multi-shot short video, automatically planning shots and compositing them in one pass. [Strengths] It excels at multi-shot narrative coherence and keeping referenced characters, scenes, and props consistent across shots, driven directly from keyframe reference images without manual shot-by-shot prompting. [Best For] Highly recommended for: short ad films and brand stories, scripted short dramas, multi-scene narrative clips generated from a script, and character-driven reels built from a small cast of reference assets. [Limitations] Do NOT use this model to simply animate a single image (use a standard image-to-video model such as Vidu Q3 Pro/Turbo I2V instead); it requires script_content in traditional screenplay format (scene + characters + dialogue) plus 1-14 reference assets each with an image_uri, outputs 1080p in 16:9 or 9:16, and does not expose per-shot duration or style controls (duration is auto-planned). Asset type must be one of character/scene/tool. [Routing] Choose Vidu Q3 AD when the user provides a script and reference images and wants an automatically directed multi-shot short drama from keyframes. For animating a single image into one continuous clip, route to viduq3-pro-i2v / viduq3-turbo-i2v; for the standard short-play flow with placement/quality/duration/style controls, route to Vidu Q3 Drama.



## OpenAPI

````yaml /model-api/vidu/vidu-i2v.json post /vidu/viduq3-ad
openapi: 3.1.0
info:
  description: >-
    The image-to-video models API from Vidu. Includes standard I2V, first-last
    frame, reference-to-video, digital human, multi-frame animation, template
    story, and one-click film/ad generation.
  version: 1.0.0
  contact:
    name: Modellix Support
    email: support@modellix.ai
  title: Vidu Image-to-Video Models API
servers:
  - url: https://api.modellix.ai/api/v1
    description: The image-to-video models API from Vidu.
security:
  - bearerAuth: []
paths:
  /vidu/viduq3-ad:
    post:
      summary: Vidu Q3 AD (Keyframe Short Play)
      description: >-
        [Core Function] Vidu Q3 AD is a keyframe-driven short-play (short drama)
        Image-to-Video model that turns a film-style script plus character,
        scene, and prop reference images into a complete multi-shot short video,
        automatically planning shots and compositing them in one pass.
        [Strengths] It excels at multi-shot narrative coherence and keeping
        referenced characters, scenes, and props consistent across shots, driven
        directly from keyframe reference images without manual shot-by-shot
        prompting. [Best For] Highly recommended for: short ad films and brand
        stories, scripted short dramas, multi-scene narrative clips generated
        from a script, and character-driven reels built from a small cast of
        reference assets. [Limitations] Do NOT use this model to simply animate
        a single image (use a standard image-to-video model such as Vidu Q3
        Pro/Turbo I2V instead); it requires script_content in traditional
        screenplay format (scene + characters + dialogue) plus 1-14 reference
        assets each with an image_uri, outputs 1080p in 16:9 or 9:16, and does
        not expose per-shot duration or style controls (duration is
        auto-planned). Asset type must be one of character/scene/tool. [Routing]
        Choose Vidu Q3 AD when the user provides a script and reference images
        and wants an automatically directed multi-shot short drama from
        keyframes. For animating a single image into one continuous clip, route
        to viduq3-pro-i2v / viduq3-turbo-i2v; for the standard short-play flow
        with placement/quality/duration/style controls, route to Vidu Q3 Drama.
      operationId: viduQ3AdAsync
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ViduQ3AdRequest'
            examples:
              basic:
                summary: Script with a character asset
                value:
                  script_name: City Sunrise
                  script_content: |-
                    Scene 1 INT. LIVING ROOM - DAY
                    @Protagonist stands by the window and smiles.
                    @Protagonist: Today is a good day.
                  assets:
                    - id: asset_001
                      type: character
                      name: Protagonist
                      image_uri: https://example.com/protagonist.png
                  resolution: 1080p
                  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-vidu-ad-001
                  model_id: vidu/viduq3-ad
                  get_result:
                    method: GET
                    url: https://api.modellix.ai/api/v1/tasks/task-vidu-ad-001
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ViduQ3AdRequest:
      type: object
      required:
        - script_name
        - script_content
        - assets
      description: >-
        Vidu Q3 AD keyframe short-play request. Field names are passed through
        to Vidu as-is. Note the asset image field is `image_uri`, not
        `image_url`. Unlike Q3 Drama, this model does NOT support placement,
        quality, duration, or style.
      properties:
        script_name:
          type: string
          minLength: 1
          maxLength: 20
          description: Episode name (max 20 characters)
          example: City Sunrise
        script_content:
          type: string
          minLength: 1
          maxLength: 5000
          description: >-
            Script content in traditional screenplay format (scene heading +
            characters + dialogue). English up to 5000 characters.
          example: |-
            Scene 1 INT. LIVING ROOM - DAY
            @Protagonist stands by the window and smiles.
            @Protagonist: Today is a good day.
        assets:
          type: array
          minItems: 1
          maxItems: 14
          description: >-
            Reference assets (1-14; 3-10 recommended). One asset maps to exactly
            one image.
          items:
            type: object
            required:
              - id
              - type
              - name
              - image_uri
            properties:
              id:
                type: string
                minLength: 1
                description: Asset id (free-form string, e.g. "asset_001")
                example: asset_001
              type:
                type: string
                enum:
                  - character
                  - scene
                  - tool
                description: 'Asset type: character, scene, or prop (tool)'
                example: character
              name:
                type: string
                minLength: 1
                maxLength: 30
                description: Asset name (max 30 characters)
                example: Protagonist
              image_uri:
                type: string
                minLength: 1
                description: >-
                  Reference image as a publicly accessible URL or base64 data
                  URI (png/jpeg/jpg/webp; min 128x128, recommended <=2K, aspect
                  ratio within 1:4-4:1). Field name is image_uri, not image_url.
                example: https://example.com/protagonist.png
        resolution:
          type: string
          enum:
            - 1080p
          default: 1080p
          description: Output resolution (1080p only)
          example: 1080p
        aspect_ratio:
          type: string
          enum:
            - '16:9'
            - '9:16'
          default: '9:16'
          description: Video aspect ratio
          example: '9:16'
    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 for polling
              example: task-abc123
            model_id:
              type: string
              description: Model ID in `provider/model` format
              example: vidu/viduq3-pro-fast-i2v
            get_result:
              type: object
              description: API information to query the task result
              properties:
                method:
                  type: string
                  example: GET
                url:
                  type: string
                  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
          example: 400
        message:
          type: string
          example: 'Invalid parameters: parameter ''first_frame_image'' is required'
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 400
            message: 'Invalid parameters: parameter ''first_frame_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`.'

````