{ "openapi": "3.1.0", "info": { "title": "Runware API - PixVerse V4", "summary": "PixVerse V4 AI text to video with pro camera control", "description": "PixVerse V4 is a generative video model for text prompts or source images. It improves motion quality and complex camera movement. It adds motion modes, sound effect sync, and style transfer. Ideal for short cinematic clips and rapid creative iteration in production pipelines.", "version": "1.0.0", "x-model-id": "pixverse-v4", "x-air-id": "pixverse:1@2", "x-status": "live", "x-creator": { "id": "pixverse", "name": "PixVerse", "logo": "https://assets.runware.ai/e728689d-1295-4501-9cdd-0fa919afcc06.png" }, "x-capabilities": [ "text-to-video", "image-to-video", "video-to-video" ], "x-released-at": "2025-02-24T00:00:00Z", "x-cover-image": "https://assets.runware.ai/5e81f199-076a-4dd9-88d0-06e5b6bc3323.jpg", "x-pricing": { "overview": "Each generation will cost $0.0598/s for 1080p.", "examples": [ { "configuration": "1080p · 5s", "price": "$0.299" } ] } }, "servers": [ { "url": "https://api.runware.ai/v1", "description": "Runware REST API" } ], "components": { "securitySchemes": { "apiKeyAuth": { "type": "http", "scheme": "bearer", "description": "Runware API Key (e.g., Bearer )" } }, "schemas": { "AuthenticationTask": { "title": "Authentication", "description": "Authenticates a connection using an API key. Can be sent as the first element of the request array as an alternative to using the Authorization header.", "type": "object", "x-response-schema": "https://schemas.runware.ai/responses/utilities/authentication.json", "properties": { "taskType": { "const": "authentication", "title": "Task Type", "description": "The type of task to perform." }, "apiKey": { "title": "API Key", "description": "Your Runware API key.", "type": "string" }, "connectionSessionUUID": { "title": "Connection Session UUID", "description": "Optional session UUID to resume a previous connection and receive any buffered results.", "type": "string", "format": "uuid" } }, "required": [ "taskType", "apiKey" ], "additionalProperties": false }, "RequestBody": { "type": "array", "items": { "type": "object", "properties": { "model": { "title": "Model", "description": "Identifier of the model to use for generation.", "type": "string", "const": "pixverse:1@2" }, "inputs": { "title": "Inputs", "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.", "type": "object", "properties": { "frameImages": { "title": "Frame Images", "description": "An array of frame-specific image inputs to guide video generation. Each item can be either a plain image input (UUID, URL, Data URI, or Base64) or an object that pairs an image with a target frame position.\n\nThe `frameImages` parameter allows you to constrain specific frames within the video sequence, ensuring that particular visual content appears at designated points. This is different from `referenceImages`, which provide overall visual guidance without constraining specific timeline positions.\n\nWhen the `frame` parameter is omitted, automatic distribution rules apply:\n\n- **1 image**: Used as the first frame.\n- **2 images**: First and last frames.\n- **3+ images**: First and last frames, with intermediate images evenly spaced between.\n\n**Examples**:\n\n**Shorthand format:** When you don't need to specify a frame position, you can pass a plain image input directly.\n\n```json\n\"frameImages\": [\n \"aac49721-1964-481a-ae78-8a4e29b91402\"\n]\n```\n\n**Object format:** When you need to specify a frame position, use an object with `image` and `frame`.\n\n```json\n\"frameImages\": [\n {\n \"image\": \"aac49721-1964-481a-ae78-8a4e29b91402\",\n \"frame\": \"first\"\n }\n]\n```\n\n**First and last frames:** With two images, they automatically become the first and last frames of the video sequence. You can mix shorthand and object formats.\n\n```json\n\"frameImages\": [\n \"aac49721-1964-481a-ae78-8a4e29b91402\",\n {\n \"image\": \"3ad204c3-a9de-4963-8a1a-c3911e3afafe\",\n \"frame\": \"last\"\n }\n]\n```\n\n**Multiple frames:** With three or more images, the first and last are anchored while intermediate frames are evenly distributed across the timeline.\n\n```json\n\"frameImages\": [\n {\n \"image\": \"aac49721-1964-481a-ae78-8a4e29b91402\",\n \"frame\": \"first\"\n },\n \"c00abf5f-6cdb-4642-a01d-1bfff7bc3cf7\",\n {\n \"image\": \"3ad204c3-a9de-4963-8a1a-c3911e3afafe\",\n \"frame\": \"last\"\n }\n]\n```\n\n[Read full documentation](https://runware.ai/docs/models/pixverse-v4#frameImages)", "type": "array", "minItems": 1, "items": { "anyOf": [ { "$id": "https://schemas.runware.ai/parameters/inputs/image.json", "title": "Image", "description": "Image input (UUID, URL, Data URI, or Base64).", "type": "string", "anyOf": [ { "format": "uuid" }, { "format": "uri" }, { "pattern": "^data:image\\/[a-zA-Z]+;base64,[a-zA-Z0-9+/=]+$" }, { "pattern": "^[a-zA-Z0-9+/=]+$" } ] }, { "type": "object", "properties": { "image": { "$id": "https://schemas.runware.ai/parameters/inputs/image.json", "title": "Image", "description": "Image input (UUID, URL, Data URI, or Base64).", "type": "string", "anyOf": [ { "format": "uuid" }, { "format": "uri" }, { "pattern": "^data:image\\/[a-zA-Z]+;base64,[a-zA-Z0-9+/=]+$" }, { "pattern": "^[a-zA-Z0-9+/=]+$" } ] }, "frame": { "title": "Frame", "description": "Target frame position for the image. Supports first and last frame.", "oneOf": [ { "const": "first", "description": "First frame of the video." }, { "const": "last", "description": "Last frame of the video." }, { "const": 0, "description": "Frame index 0 (first frame)." }, { "const": -1, "description": "Frame index -1 (last frame)." } ], "$id": "https://schemas.runware.ai/parameters/inputs/frame-images/frame.json?def=firstLast" } }, "required": [ "image" ], "additionalProperties": false } ] }, "maxItems": 2 } }, "additionalProperties": false }, "positivePrompt": { "title": "Positive Prompt", "description": "Text prompt describing elements to include in the generated output.", "type": "string", "minLength": 2, "maxLength": 2048 }, "negativePrompt": { "title": "Negative Prompt", "description": "Prompt to guide what to exclude from generation. Ignored when guidance is disabled (CFGScale ≤ 1).", "type": "string", "minLength": 2, "maxLength": 2048 }, "width": { "title": "Width", "description": "Width of the generated media in pixels.", "type": "integer" }, "height": { "title": "Height", "description": "Height of the generated media in pixels.", "type": "integer" }, "resolution": { "title": "Resolution", "description": "Resolution preset for the output. When used with input media, automatically matches the aspect ratio from the input.", "type": "string", "enum": [ "360p", "540p", "720p", "1080p" ], "default": "720p" }, "duration": { "title": "Duration", "description": "Length of the generated video in seconds. The total number of frames produced is determined by duration multiplied by the model's frame rate (fps).", "type": "number", "enum": [ 5, 8 ] }, "seed": { "title": "Seed", "description": "Random seed for reproducible generation. When not provided, a random seed is generated in the unsigned 32-bit range.", "type": "integer", "minimum": 0, "maximum": 2147483647 }, "providerSettings": { "title": "Provider Settings", "description": "Provider-specific configuration settings.", "type": "object", "properties": { "pixverse": { "title": "Pixverse Settings", "description": "Provider-specific settings for PixVerse.", "type": "object", "properties": { "cameraMovement": { "title": "Camera Movement", "description": "Cinematic camera movement.", "type": "string", "oneOf": [ { "const": "horizontal_left", "description": "Horizontal pan to the left." }, { "const": "horizontal_right", "description": "Horizontal pan to the right." }, { "const": "vertical_up", "description": "Upward vertical movement." }, { "const": "vertical_down", "description": "Downward vertical movement." }, { "const": "zoom_in", "description": "Gradual zoom into the subject." }, { "const": "zoom_out", "description": "Gradual zoom away from the subject." }, { "const": "auto_camera", "description": "Automatic camera movement based on scene content." }, { "const": "crane_up", "description": "Upward crane shot movement." }, { "const": "quickly_zoom_in", "description": "Fast zoom into the subject." }, { "const": "quickly_zoom_out", "description": "Fast zoom away from the subject." }, { "const": "smooth_zoom_in", "description": "Gentle, smooth zoom into the subject." }, { "const": "camera_rotation", "description": "Rotating camera movement around the axis." }, { "const": "robo_arm", "description": "Mechanical, precise camera movement." }, { "const": "super_dolly_out", "description": "Dramatic outward dolly movement." }, { "const": "whip_pan", "description": "Quick, dynamic pan movement." }, { "const": "hitchcock", "description": "Classic Hitchcock-style dolly zoom effect." }, { "const": "left_follow", "description": "Camera follows subject moving left." }, { "const": "right_follow", "description": "Camera follows subject moving right." }, { "const": "pan_left", "description": "Horizontal pan to the left." }, { "const": "pan_right", "description": "Horizontal pan to the right." }, { "const": "fix_bg", "description": "Fixed background with foreground movement." } ] }, "effect": { "title": "Effect", "description": "Visual effect template.", "type": "string", "oneOf": [ { "const": "bikini up", "description": "Body transformation effect." }, { "const": "the tigers touch", "description": "Animal-themed transformation." }, { "const": "jiggle jiggle", "description": "Rhythmic movement effect." }, { "const": "hug your love", "description": "Romantic interaction template." }, { "const": "kiss me ai", "description": "Kiss interaction effect." }, { "const": "subject 3 fever", "description": "Energetic movement template." }, { "const": "fin-tastic mermaid", "description": "Mermaid transformation." }, { "const": "lets ymca", "description": "Dance movement template." }, { "const": "skeleton dance", "description": "Spooky dance effect." }, { "const": "kungfu club", "description": "Martial arts action template." }, { "const": "boom drop", "description": "Explosive impact effect." }, { "const": "vroom vroom step", "description": "Vehicle-themed movement." }, { "const": "creepy devil smile", "description": "Horror-themed facial effect." }, { "const": "pubg winner hit", "description": "Gaming victory celebration." }, { "const": "360 microwave", "description": "Spinning rotation effect." }, { "const": "eye zoom challenge", "description": "Close-up eye effect." }, { "const": "muscle surge", "description": "Body enhancement effect." }, { "const": "punch face", "description": "Impact reaction template." }, { "const": "balloon belly", "description": "Body inflation effect." }, { "const": "kiss kiss", "description": "Multiple kiss interaction." } ] }, "motionMode": { "title": "Motion Mode", "description": "Motion intensity in the generated video.", "type": "string", "oneOf": [ { "const": "normal", "description": "Standard motion intensity and pacing." }, { "const": "fast", "description": "Increased motion speed." } ], "default": "normal" }, "style": { "title": "Style", "description": "Artistic style aesthetic for video generation.", "type": "string", "oneOf": [ { "const": "anime", "description": "Japanese animation aesthetic." }, { "const": "3d_animation", "description": "Three-dimensional animated style with depth." }, { "const": "clay", "description": "Stop-motion clay animation appearance." }, { "const": "comic", "description": "Comic book or graphic novel visual style." }, { "const": "cyberpunk", "description": "Futuristic, neon-lit dystopian aesthetic." } ] } }, "additionalProperties": false } }, "additionalProperties": false }, "taskType": { "title": "Task Type", "description": "Identifier for the type of task being performed", "type": "string", "const": "videoInference" }, "taskUUID": { "title": "Task UUID", "description": "UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.", "type": "string", "format": "uuid" }, "webhookURL": { "title": "Webhook URL", "description": "Specifies a webhook URL where JSON responses will be sent via HTTP POST when generation tasks complete. For batch requests with multiple results, each completed item triggers a separate webhook call as it becomes available.", "type": "string", "format": "uri" }, "includeCost": { "title": "Include Cost", "description": "Include task cost in the response.", "type": "boolean", "default": false }, "numberResults": { "title": "Number of Results", "description": "Number of results to generate. Each result uses a different seed, producing variations of the same parameters.", "type": "integer", "minimum": 1, "default": 1, "maximum": 4 }, "uploadEndpoint": { "title": "Upload Endpoint", "description": "Specifies a URL where the generated content will be automatically uploaded using the HTTP PUT method. The raw binary data of the media file is sent directly as the request body. For secure uploads to cloud storage, use presigned URLs that include temporary authentication credentials.\n\n**Common use cases:**\n\n- **Cloud storage**: Upload directly to S3 buckets, Google Cloud Storage, or Azure Blob Storage using presigned URLs.\n- **CDN integration**: Upload to content delivery networks for immediate distribution.\n\n```text\n// S3 presigned URL for secure upload\nhttps://your-bucket.s3.amazonaws.com/generated/content.mp4?X-Amz-Signature=abc123&X-Amz-Expires=3600\n\n// Google Cloud Storage presigned URL\nhttps://storage.googleapis.com/your-bucket/content.jpg?X-Goog-Signature=xyz789\n\n// Custom storage endpoint\nhttps://storage.example.com/uploads/generated-image.jpg\n```\n\nThe content data will be sent as the request body to the specified URL when generation is complete.\n\n[Read full documentation](https://runware.ai/docs/models/pixverse-v4#uploadEndpoint)", "type": "string", "format": "uri" }, "ttl": { "title": "TTL", "description": "Time-to-live (TTL) in seconds for generated content. Only applies when `outputType` is `URL`.", "type": "integer", "minimum": 60 }, "outputType": { "title": "Output Type", "description": "Video output type.", "type": "string", "enum": [ "URL" ], "default": "URL" }, "outputFormat": { "title": "Output Format", "description": "Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities.\n\n- \\`JPG\\`: Best for photorealistic images with smaller file sizes (no transparency).\n- \\`PNG\\`: Lossless compression, supports high quality and transparency (alpha channel).\n- \\`WEBP\\`: Modern format providing superior compression and transparency support.\n- \\`MP4\\`: Widely supported video container (H.264), recommended for general use.\n- \\`WEBM\\`: Optimized for web delivery.\n- \\`MOV\\`: QuickTime format, common in professional workflows (Apple ecosystem).\n- \\`GIF\\`: Animated image format (no audio), suitable for short loops or previews.\n- \\`MP3\\`: Compressed audio, smaller file size.\n- \\`WAV\\`: Uncompressed, high-quality audio.\n- \\`FLAC\\`: Lossless compression.\n- \\`OGG\\`: Open-source compressed audio format (Vorbis codec).\n- \\`SVG\\`: Scalable Vector Graphics.\n- \\`TIFF\\`: High-quality output supporting layers.\n\n> [!NOTE]\n> \\*\\*Transparency\\*\\*: If you are using features like background removal or LayerDiffuse that require transparency, you must select a format that supports an alpha channel (e.g., \\`PNG\\`, \\`WEBP\\`, \\`TIFF\\`). \\`JPG\\` does not support transparency.\n\n[Read full documentation](https://runware.ai/docs/models/pixverse-v4#outputFormat)", "type": "string", "enum": [ "MP4", "WEBM", "MOV" ], "default": "MP4" }, "outputQuality": { "title": "Output Quality", "description": "Compression quality of the output. Higher values preserve quality but increase file size.", "type": "integer", "minimum": 20, "maximum": 99, "default": 95 }, "deliveryMethod": { "title": "Delivery Method", "description": "Determines how the API delivers task results.", "type": "string", "oneOf": [ { "const": "async", "description": "Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse. Required for long-running tasks like video generation." } ], "default": "async" }, "safety": { "type": "object", "title": "Safety Settings", "description": "Content safety checking configuration for video generation.", "properties": { "checkContent": { "title": "Check Content", "description": "Enable or disable content safety checking. When enabled, defaults to `fast` mode.", "type": "boolean", "default": false }, "mode": { "description": "Safety checking mode for video generation.", "type": "string", "oneOf": [ { "const": "none", "title": "None", "description": "Disables checking." }, { "const": "fast", "title": "Fast", "description": "Checks key frames." }, { "const": "full", "title": "Full", "description": "Checks all frames." } ], "default": "none" } }, "additionalProperties": false } }, "required": [ "positivePrompt", "taskType", "taskUUID", "model" ], "allOf": [ { "dependentRequired": { "width": [ "height" ], "height": [ "width" ] } }, { "oneOf": [ { "title": "360p (16:9)", "properties": { "width": { "const": 640 }, "height": { "const": 360 } } }, { "title": "360p (4:3)", "properties": { "width": { "const": 480 }, "height": { "const": 360 } } }, { "title": "360p (1:1)", "properties": { "width": { "const": 360 }, "height": { "const": 360 } } }, { "title": "360p (3:4)", "properties": { "width": { "const": 360 }, "height": { "const": 480 } } }, { "title": "360p (9:16)", "properties": { "width": { "const": 360 }, "height": { "const": 640 } } }, { "title": "540p (16:9)", "properties": { "width": { "const": 960 }, "height": { "const": 540 } } }, { "title": "540p (4:3)", "properties": { "width": { "const": 720 }, "height": { "const": 540 } } }, { "title": "540p (1:1)", "properties": { "width": { "const": 540 }, "height": { "const": 540 } } }, { "title": "540p (3:4)", "properties": { "width": { "const": 540 }, "height": { "const": 720 } } }, { "title": "540p (9:16)", "properties": { "width": { "const": 540 }, "height": { "const": 960 } } }, { "title": "720p (16:9)", "properties": { "width": { "const": 1280 }, "height": { "const": 720 } } }, { "title": "720p (4:3)", "properties": { "width": { "const": 960 }, "height": { "const": 720 } } }, { "title": "720p (1:1)", "properties": { "width": { "const": 720 }, "height": { "const": 720 } } }, { "title": "720p (3:4)", "properties": { "width": { "const": 720 }, "height": { "const": 960 } } }, { "title": "720p (9:16)", "properties": { "width": { "const": 720 }, "height": { "const": 1280 } } }, { "title": "1080p (16:9)", "properties": { "width": { "const": 1920 }, "height": { "const": 1080 } } }, { "title": "1080p (4:3)", "properties": { "width": { "const": 1440 }, "height": { "const": 1080 } } }, { "title": "1080p (1:1)", "properties": { "width": { "const": 1080 }, "height": { "const": 1080 } } }, { "title": "1080p (3:4)", "properties": { "width": { "const": 1080 }, "height": { "const": 1440 } } }, { "title": "1080p (9:16)", "properties": { "width": { "const": 1080 }, "height": { "const": 1920 } } } ] }, { "if": { "properties": { "inputs": { "properties": { "frameImages": { "minItems": 1 } }, "required": [ "frameImages" ] } }, "required": [ "inputs" ] }, "then": { "not": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } }, "else": { "required": [ "width", "height" ] } }, { "not": { "allOf": [ { "required": [ "resolution" ] }, { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } ] } }, { "not": { "allOf": [ { "properties": { "providerSettings": { "properties": { "pixverse": { "required": [ "cameraMovement" ] } } } }, "required": [ "providerSettings" ] }, { "properties": { "providerSettings": { "properties": { "pixverse": { "required": [ "effect" ] } } } }, "required": [ "providerSettings" ] } ] } }, { "if": { "properties": { "providerSettings": { "properties": { "pixverse": { "properties": { "motionMode": { "const": "fast" } }, "required": [ "motionMode" ] } } } }, "required": [ "providerSettings" ] }, "then": { "properties": { "duration": { "enum": [ 5 ] } }, "oneOf": [ { "properties": { "width": { "const": 640 }, "height": { "const": 360 } } }, { "properties": { "width": { "const": 480 }, "height": { "const": 360 } } }, { "properties": { "width": { "const": 360 }, "height": { "const": 360 } } }, { "properties": { "width": { "const": 360 }, "height": { "const": 480 } } }, { "properties": { "width": { "const": 360 }, "height": { "const": 640 } } }, { "properties": { "width": { "const": 960 }, "height": { "const": 540 } } }, { "properties": { "width": { "const": 720 }, "height": { "const": 540 } } }, { "properties": { "width": { "const": 540 }, "height": { "const": 540 } } }, { "properties": { "width": { "const": 540 }, "height": { "const": 720 } } }, { "properties": { "width": { "const": 540 }, "height": { "const": 960 } } }, { "properties": { "width": { "const": 1280 }, "height": { "const": 720 } } }, { "properties": { "width": { "const": 960 }, "height": { "const": 720 } } }, { "properties": { "width": { "const": 720 }, "height": { "const": 720 } } }, { "properties": { "width": { "const": 720 }, "height": { "const": 960 } } }, { "properties": { "width": { "const": 720 }, "height": { "const": 1280 } } } ] } } ], "additionalProperties": false }, "description": "You must always POST an array of task objects." }, "ResponseBody": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "description": "Unknown response structure" } } } }, "ErrorResponse": { "title": "Error Response", "description": "Standard error response returned by the Runware API.", "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "code", "message" ], "additionalProperties": true, "properties": { "code": { "type": "string", "description": "A short identifier for the error (e.g., invalidApiKey, timeoutProvider)." }, "message": { "type": "string", "description": "A human-readable explanation of what went wrong." }, "parameter": { "type": "string", "description": "The request parameter related to the error, if applicable." }, "taskType": { "type": "string", "description": "The task type of the request that failed." }, "taskUUID": { "type": "string", "description": "The unique identifier of the failed request." }, "documentation": { "type": "string", "description": "A link to relevant documentation." } } } } }, "required": [ "errors" ], "additionalProperties": false } } }, "paths": { "/": { "post": { "summary": "Run PixVerse V4", "description": "PixVerse V4 is a generative video model for text prompts or source images. It improves motion quality and complex camera movement. It adds motion modes, sound effect sync, and style transfer. Ideal for short cinematic clips and rapid creative iteration in production pipelines.", "operationId": "run_pixverse_v4", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBody" } } } }, "400": { "description": "Bad Request — Missing or invalid parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized — No valid API key provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "Payment Required — Insufficient account balance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden — The API key lacks permissions for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests — Rate limit exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server Error — Something went wrong on Runware's end.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Service Unavailable — Temporarily unavailable (maintenance or capacity).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } }, "security": [ { "apiKeyAuth": [] } ] }