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

# SkyReels Reference-to-Video (Multiobject)

> **[Core Function]** SkyReels Reference-to-Video (multiobject) generates a video from a prompt while preserving the subjects from 1-4 reference images. **[Strengths]** Multi-subject identity preservation, placing specific characters or objects into a newly generated scene. **[Best For]** Putting given characters/products into a new scene, multi-subject composition from reference photos. **[Limitations]** Do NOT use this to animate a single fixed frame (use skyreels-i2v) or for text-only generation (use skyreels-t2v). It requires 1-4 reference images and produces clips up to 5s. **[Routing]** Provide 1-4 subject reference images in ref_images; set aspect_ratio and duration (1-5s) as needed.



## OpenAPI

````yaml /model-api/skywork/skyreels-i2v.json post /skywork/skyreels-r2v
openapi: 3.1.0
info:
  description: >-
    The image-to-video models API from SkyReels (Skywork). Includes keyframe
    image-to-video, multi-subject reference-to-video, and audio-driven
    talking-avatar generation. Tasks are asynchronous: submit, then poll the
    task endpoint for the result.
  version: 1.0.0
  contact:
    name: Modellix Support
    email: support@modellix.ai
  title: SkyReels Image-to-Video Models API
servers:
  - url: https://api.modellix.ai/api/v1
    description: The image-to-video models API from SkyReels (Skywork).
security:
  - bearerAuth: []
paths:
  /skywork/skyreels-r2v:
    post:
      summary: SkyReels Reference-to-Video (Multiobject)
      description: >-
        **[Core Function]** SkyReels Reference-to-Video (multiobject) generates
        a video from a prompt while preserving the subjects from 1-4 reference
        images. **[Strengths]** Multi-subject identity preservation, placing
        specific characters or objects into a newly generated scene. **[Best
        For]** Putting given characters/products into a new scene, multi-subject
        composition from reference photos. **[Limitations]** Do NOT use this to
        animate a single fixed frame (use skyreels-i2v) or for text-only
        generation (use skyreels-t2v). It requires 1-4 reference images and
        produces clips up to 5s. **[Routing]** Provide 1-4 subject reference
        images in ref_images; set aspect_ratio and duration (1-5s) as needed.
      operationId: skyreelsR2VAsync
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SkyreelsR2VRequest'
            examples:
              basic:
                summary: Two subject references
                value:
                  prompt: The two characters walk together through a neon-lit city
                  ref_images:
                    - https://example.com/subject_a.png
                    - https://example.com/subject_b.png
                  duration: 5
                  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-skyreels-r2v-001
                  model_id: skyreels/skyreels-r2v
                  get_result:
                    method: GET
                    url: https://api.modellix.ai/api/v1/tasks/task-skyreels-r2v-001
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    SkyreelsR2VRequest:
      type: object
      required:
        - prompt
        - ref_images
      description: >-
        SkyReels reference-to-video (multiobject) request. Preserves subjects
        from 1-4 reference images.
      properties:
        prompt:
          type: string
          minLength: 1
          description: Text description of the video to generate (max 512 tokens).
          example: The two characters walk together through a neon-lit city
        ref_images:
          type: array
          minItems: 1
          maxItems: 4
          description: 1-4 subject reference image URLs (jpg/jpeg/png/gif/bmp).
          items:
            type: string
            minLength: 1
          example:
            - https://example.com/subject_a.png
            - https://example.com/subject_b.png
        duration:
          type: integer
          minimum: 1
          maximum: 5
          default: 5
          description: Video duration in seconds.
          example: 5
        aspect_ratio:
          type: string
          enum:
            - '16:9'
            - '4:3'
            - '1:1'
            - '9:16'
            - '3:4'
          default: '16:9'
          description: Video aspect ratio.
          example: '16:9'
    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: skyreels/skyreels-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 ''prompt'' is required'
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 400
            message: 'Invalid parameters: parameter ''prompt'' 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`.'

````