> ## 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 Template Story

> [Core Function] Vidu Template Story is a narrative video generation model. [Strengths] It excels at placing user-provided character images into predefined, structured narrative templates (like 'love_story' or 'monkey_king') to automatically generate a cohesive short film. [Best For] Highly recommended for: creating instant themed short stories, personalized entertainment videos, and viral social media narrative trends. [Limitations] Do NOT use this model if the user wants completely custom motion or a unique storyline not covered by the available templates. It restricts creativity to the predefined story structure. [Routing] Use this only when the user explicitly requests to put their characters into a specific story template.



## OpenAPI

````yaml /model-api/vidu/vidu-i2v.json post /vidu/template-story
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/template-story:
    post:
      summary: Vidu Template Story
      description: >-
        [Core Function] Vidu Template Story is a narrative video generation
        model. [Strengths] It excels at placing user-provided character images
        into predefined, structured narrative templates (like 'love_story' or
        'monkey_king') to automatically generate a cohesive short film. [Best
        For] Highly recommended for: creating instant themed short stories,
        personalized entertainment videos, and viral social media narrative
        trends. [Limitations] Do NOT use this model if the user wants completely
        custom motion or a unique storyline not covered by the available
        templates. It restricts creativity to the predefined story structure.
        [Routing] Use this only when the user explicitly requests to put their
        characters into a specific story template.
      operationId: viduTemplateStoryAsync
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ViduTemplateStoryRequest'
            examples:
              love_story:
                summary: Love story template
                value:
                  story: love_story
                  images:
                    - https://example.com/couple.jpg
              monkey_king:
                summary: Monkey King with multiple characters
                value:
                  story: monkey_king
                  images:
                    - https://example.com/hero.jpg
                    - https://example.com/sidekick.jpg
                    - https://example.com/scene.jpg
      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-story-001
                  model_id: vidu/template-story
                  get_result:
                    method: GET
                    url: https://api.modellix.ai/api/v1/tasks/task-vidu-story-001
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ViduTemplateStoryRequest:
      type: object
      required:
        - story
        - images
      description: Vidu template story request.
      properties:
        story:
          type: string
          enum:
            - love_story
            - workday_feels
            - monkey_king
            - pigsy
            - monk_tang
            - one_shot
          description: Story template type
          example: love_story
        images:
          type: array
          minItems: 1
          description: Character or scene images as URLs or base64 data URIs
          items:
            type: string
            minLength: 1
          example:
            - https://example.com/character.jpg
    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`.'

````