↑↓ Navigateenter Openesc Close
Dashboard
MODEL IDpixverse:modify@0
live

PixVerse Modify

PixVerse
by PixVerse

PixVerse Modify is a video-to-video editing model for changing existing footage with text instructions, optional reference images, and masks. It supports subject swapping, object addition and removal, free-form scene edits such as weather or lighting changes, in-video text replacement, and full-video style transfer while preserving the source clip structure.

PixVerse Modify

API Options

Platform-level options for task execution and delivery.

taskType

stringrequiredvalue: videoInference

Identifier for the type of task being performed

taskUUID

stringrequiredUUID v4

UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.

outputType

stringdefault: URL

Video output type.

Allowed values1 value

outputFormat

stringdefault: MP4

Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities.

  • `MP4`: Widely supported video container (H.264), recommended for general use.
  • `WEBM`: Optimized for web delivery.
  • `MOV`: QuickTime format, common in professional workflows (Apple ecosystem).
Allowed values3 values

outputQuality

integermin: 20max: 99default: 95

Compression quality of the output. Higher values preserve quality but increase file size.

webhookURL

stringURI

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.

Learn more1 resource

deliveryMethod

stringdefault: async

Determines how the API delivers task results.

Allowed values1 value
Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse. Required for long-running tasks like video generation.
Learn more1 resource

uploadEndpoint

stringURI

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.

Common use cases:

  • Cloud storage: Upload directly to S3 buckets, Google Cloud Storage, or Azure Blob Storage using presigned URLs.
  • CDN integration: Upload to content delivery networks for immediate distribution.
// S3 presigned URL for secure upload
https://your-bucket.s3.amazonaws.com/generated/content.mp4?X-Amz-Signature=abc123&X-Amz-Expires=3600

// Google Cloud Storage presigned URL
https://storage.googleapis.com/your-bucket/content.jpg?X-Goog-Signature=xyz789

// Custom storage endpoint
https://storage.example.com/uploads/generated-image.jpg

The content data will be sent as the request body to the specified URL when generation is complete.

safety

object

Content safety checking configuration for video generation.

Properties2 properties
safety » checkContent

checkContent

booleandefault: false

Enable or disable content safety checking.

safety » mode

mode

stringdefault: none

Safety checking mode for video generation.

Allowed values3 values
Disables checking.
Checks key frames.
Checks all frames.

ttl

integermin: 60

Time-to-live (TTL) in seconds for generated content. Only applies when outputType is URL.

includeCost

booleandefault: false

Include task cost in the response.

Inputs

Input resources for the task (images, audio, etc). These must be nested inside the inputs object.

inputs » referenceImages

referenceImages

array of stringsmin items: 1max items: 3

List of reference images (UUID, URL, Data URI, or Base64).

inputs » video

video

stringrequired

Video input (UUID or URL). Max 29.9 seconds.

inputs » masks

masks

array of stringsmax items: 1

Mask identifiers for targeted regions. Auto-generated when keyframe and referenceImages are provided without masks.

Core Parameters

Primary parameters that define the task output.

numberResults

integermin: 1max: 4default: 1

Number of results to generate. Each result uses a different seed, producing variations of the same parameters.

model

stringrequiredvalue: pixverse:modify@0

Identifier of the model to use for generation.

positivePrompt

stringrequiredmin: 1max: 2048

Text prompt describing elements to include in the generated output.

resolution

stringdefault: 360p

Resolution preset for the output. When used with input media, automatically matches the aspect ratio from the input.

Allowed values3 values

seed

integermin: 0max: 2147483647

Random seed for reproducible generation. When not provided, a random seed is generated in the unsigned 32-bit range.

Settings

Technical parameters to fine-tune the inference process. These must be nested inside the settings object.

settings » keyframe

keyframe

integermin: 0

Frame index in the input video used as anchor for editing.

Ask AI
Send feedback