{"servers":[{"url":"https://api.modellix.ai/api/v1/vidu/template-story"}],"post":{"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":{"content":{"application/json":{"examples":{"love_story":{"summary":"Love story template","value":{"images":["https://example.com/couple.jpg"],"story":"love_story"}},"monkey_king":{"summary":"Monkey King with multiple characters","value":{"images":["https://example.com/hero.jpg","https://example.com/sidekick.jpg","https://example.com/scene.jpg"],"story":"monkey_king"}}},"schema":{"description":"Vidu template story request.","properties":{"images":{"description":"Character or scene images as URLs or base64 data URIs","example":["https://example.com/character.jpg"],"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"},"story":{"description":"Story template type","enum":["love_story","workday_feels","monkey_king","pigsy","monk_tang","one_shot"],"example":"love_story","type":"string"}},"required":["story","images"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"code":0,"data":{"get_result":{"method":"GET","url":"https://api.modellix.ai/api/v1/tasks/task-vidu-story-001"},"model_id":"vidu/template-story","status":"pending","task_id":"task-vidu-story-001"},"message":"success"},"schema":{"properties":{"code":{"description":"Response code, 0 indicates success","example":0,"type":"integer"},"data":{"description":"Detailed data about the submitted asynchronous task.","properties":{"get_result":{"description":"API information to query the task result","properties":{"method":{"example":"GET","type":"string"},"url":{"example":"https://api.modellix.ai/api/v1/tasks/task-abc123","type":"string"}},"type":"object"},"model_id":{"description":"Model ID in `provider/model` format","example":"vidu/viduq3-pro-fast-i2v","type":"string"},"status":{"description":"Task status","enum":["pending","processing"],"example":"pending","type":"string"},"task_id":{"description":"Unique task identifier for polling","example":"task-abc123","type":"string"}},"required":["status","task_id","model_id"],"type":"object"},"message":{"description":"Response message","example":"success","type":"string"}},"required":["code","message","data"],"type":"object"}}},"description":"Task submitted successfully"},"400":{"content":{"application/json":{"example":{"code":400,"message":"Invalid parameters: parameter 'first_frame_image' is required"},"schema":{"properties":{"code":{"example":400,"type":"integer"},"message":{"example":"Invalid parameters: parameter 'first_frame_image' is required","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"example":{"code":401,"message":"Authentication failed: invalid API key"},"schema":{"properties":{"code":{"example":400,"type":"integer"},"message":{"example":"Invalid parameters: parameter 'first_frame_image' is required","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Unauthorized - Invalid or missing API Key"},"429":{"content":{"application/json":{"example":{"code":429,"message":"Rate limit exceeded: 100 requests per minute, retry after 60 seconds"},"schema":{"properties":{"code":{"example":400,"type":"integer"},"message":{"example":"Invalid parameters: parameter 'first_frame_image' is required","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Too many requests - Rate limit exceeded","headers":{"X-RateLimit-Limit":{"description":"Maximum requests per minute","schema":{"example":100,"type":"integer"}},"X-RateLimit-Remaining":{"description":"Remaining quota in current window","schema":{"example":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"Rate limit window reset time (Unix timestamp)","schema":{"example":1704067260,"type":"integer"}}}},"500":{"content":{"application/json":{"example":{"code":500,"message":"Internal server error"},"schema":{"properties":{"code":{"example":400,"type":"integer"},"message":{"example":"Invalid parameters: parameter 'first_frame_image' is required","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Internal server error"}},"summary":"Template Story","x-mint":{"href":"vidu/template-story"}}}