{"servers":[{"url":"https://api.modellix.ai/api/v1/pixverse/c1-r2v"}],"post":{"description":"[Core Function] PixVerse c1 reference-to-video (fusion) generates a video from a prompt while preserving subjects from 1-7 reference images; each reference can be tagged as subject/background and named for @-reference in the prompt. [Strengths] Precise multi-subject composition and identity preservation. [Best For] Putting specific characters/objects into a new scene, multi-character interactions. [Limitations] Do NOT use this for single-image animation (use Image-to-Video), two-frame transitions (use First-Last-Frame), or text-only generation (use Text-to-Video). It requires 1-7 reference images and a required aspect_ratio, and supports up to 1080p and a maximum of 15s. [Routing] Use when the user provides one or more reference images to be fused into the video, especially when distinguishing subject vs background or naming references for the prompt. The v6 and c1 reference-to-video variants accept identical parameters; choose the version the user requests.","operationId":"pixverseC1R2VAsync","requestBody":{"content":{"application/json":{"examples":{"basic":{"summary":"Reference images with role and name","value":{"aspect_ratio":"16:9","duration":5,"prompt":"@hero runs across @forest under the northern lights","quality":"720p","reference_images":[{"ref_name":"hero","type":"subject","url":"https://example.com/hero.png"},{"type":"background","url":"https://example.com/forest.png"}]}}},"schema":{"description":"PixVerse reference-to-video (fusion) request. Fuses 1-7 reference images into a video; each reference image is an OBJECT carrying a url plus optional role (type) and a name (ref_name) referenceable in the prompt via @ref_name. NOTE: unlike xai/vidu (flat URL string arrays), PixVerse reference_images items are objects. Used by both v6 and c1 (the path determines the model version).","properties":{"aspect_ratio":{"description":"Video aspect ratio (required).","enum":["16:9","9:16","1:1","3:4","4:3","2:3","3:2","21:9"],"example":"16:9","type":"string"},"duration":{"description":"Video duration in seconds (required).","example":5,"maximum":15,"minimum":1,"type":"integer"},"generate_audio_switch":{"default":false,"description":"Whether to generate audio.","example":false,"type":"boolean"},"prompt":{"description":"Text prompt; may reference named images via @ref_name (e.g. \"@hero in @forest\").","example":"@hero runs across @forest under the northern lights","maxLength":5000,"minLength":1,"type":"string"},"quality":{"description":"Output resolution (required).","enum":["360p","540p","720p","1080p"],"example":"720p","type":"string"},"reference_images":{"description":"Reference images (1-7) fused into the generated video. Each item is an object: a publicly accessible image URL, plus optional role (type: subject/background) and a name (ref_name) you can reference in the prompt via @ref_name for precise multi-subject control.","example":[{"ref_name":"hero","type":"subject","url":"https://example.com/hero.png"},{"type":"background","url":"https://example.com/forest.png"}],"items":{"properties":{"ref_name":{"description":"Optional name (<=30 chars) for this reference. Reference it in the prompt via @ref_name for precise multi-subject composition, e.g. prompt \"@hero runs through @forest\".","example":"hero","maxLength":30,"type":"string"},"type":{"description":"Role of this reference image: subject (main character/object) or background (scene). Optional.","enum":["subject","background"],"example":"subject","type":"string"},"url":{"description":"Reference image URL (publicly accessible; png/jpeg/jpg/webp).","example":"https://example.com/hero.png","minLength":1,"type":"string"}},"required":["url"],"type":"object"},"maxItems":7,"minItems":1,"type":"array"},"seed":{"description":"Random seed (omit for random).","example":0,"maximum":2147483647,"minimum":0,"type":"integer"}},"required":["reference_images","prompt","duration","quality","aspect_ratio"],"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-pixverse-r2v-002"},"model_id":"pixverse/c1-r2v","status":"pending","task_id":"task-pixverse-r2v-002"},"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":"pixverse/v6-r2v","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 'image' is required"},"schema":{"properties":{"code":{"example":400,"type":"integer"},"message":{"example":"Invalid parameters: parameter '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 '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 '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 'image' is required","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Internal server error"}},"summary":"C1 Reference-to-Video (Fusion)","x-mint":{"href":"pixverse/c1-r2v"}}}