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

> [Core Function] Vidu Q3 R2V is a high-quality reference-to-video generation model. [Strengths] It excels at generating detailed, cinematic videos that precisely follow a text prompt while highly preserving the character identity from provided reference images. [Best For] Highly recommended for: professional character-driven storytelling, high-fidelity avatar generation in new scenes, and cinematic films requiring consistent actors. [Limitations] Do NOT use this model if you just want to add motion to an existing image (use I2V). This model creates new scenes based on the prompt while keeping the character. [Routing] Use this by default when the user wants to generate a video of a specific character (provided via image) doing something new (provided via text prompt).



## OpenAPI

````yaml /model-api/vidu/vidu-i2v.json post /vidu/viduq3-r2v
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-r2v:
    post:
      summary: Vidu Q3 R2V
      description: >-
        [Core Function] Vidu Q3 R2V is a high-quality reference-to-video
        generation model. [Strengths] It excels at generating detailed,
        cinematic videos that precisely follow a text prompt while highly
        preserving the character identity from provided reference images. [Best
        For] Highly recommended for: professional character-driven storytelling,
        high-fidelity avatar generation in new scenes, and cinematic films
        requiring consistent actors. [Limitations] Do NOT use this model if you
        just want to add motion to an existing image (use I2V). This model
        creates new scenes based on the prompt while keeping the character.
        [Routing] Use this by default when the user wants to generate a video of
        a specific character (provided via image) doing something new (provided
        via text prompt).
      operationId: viduQ3R2VAsync
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ViduQ3R2VRequest'
            examples:
              basic:
                summary: Single reference image
                value:
                  prompt: >-
                    A musician performs on an outdoor stage, crowd cheering with
                    raised hands
                  reference_images:
                    - https://example.com/musician.jpg
              with_multiple_refs:
                summary: Multiple reference images
                value:
                  prompt: >-
                    A family enjoys a picnic in a sunny park, children playing
                    on the grass
                  reference_images:
                    - https://example.com/parent1.jpg
                    - https://example.com/parent2.jpg
                    - https://example.com/child.jpg
                  duration: 10
              full_options:
                summary: Full options
                value:
                  prompt: >-
                    An explorer discovers a hidden waterfall deep in a jungle,
                    vines draping over ancient stones
                  reference_images:
                    - https://example.com/explorer.jpg
                  duration: 8
                  aspect_ratio: '16:9'
                  resolution: 720p
                  seed: 3333
      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-r2v-003
                  model_id: vidu/viduq3-r2v
                  get_result:
                    method: GET
                    url: https://api.modellix.ai/api/v1/tasks/task-vidu-r2v-003
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ViduQ3R2VRequest:
      type: object
      required:
        - prompt
        - reference_images
      description: Vidu Q3 Turbo and standard R2V request. Duration minimum 3s.
      properties:
        prompt:
          type: string
          minLength: 1
          maxLength: 5000
          description: Video description text
          example: A superhero leaps from a rooftop, cape billowing dramatically
        reference_images:
          type: array
          minItems: 1
          maxItems: 7
          description: >-
            Portrait or subject images (1-7) whose appearance will be preserved
            in the generated video. Accepts URLs or base64 data URIs.
          items:
            type: string
            minLength: 1
          example:
            - https://example.com/hero.jpg
        duration:
          type: integer
          minimum: 3
          maximum: 16
          default: 5
          description: Video duration in seconds (minimum 3)
          example: 6
        aspect_ratio:
          type: string
          enum:
            - '16:9'
            - '9:16'
            - '1:1'
          default: '16:9'
          description: Video aspect ratio
          example: '16:9'
        resolution:
          type: string
          enum:
            - 540p
            - 720p
            - 1080p
          default: 720p
          description: Video resolution
          example: 1080p
        seed:
          type: integer
          description: Random seed for reproducibility
          example: 2222
    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`.'

````