Video Edit (Modify)

POST

/openapi/v2/video/modify/generate

Prompt-only full-frame edits need no image or Mask arrays. @imgN references img_ids[N]; @selectionN references the corresponding entry in mask_ids or mask_urls. Do not provide both mask arrays. The mask_ids array requires the matching keyframe_id from the same source-video Mask workflow. Use only IDs referenced by the prompt. 1080p is not supported.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Request processed. ErrCode=0 indicates business success; a nonzero ErrCode indicates failure, even with HTTP 200.

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

Minimal request (replace resource IDs)Complete scenario (replace resource IDs)

curl --location 'https://app-api.pixverse.ai/openapi/v2/video/modify/generate' \
--header 'API-KEY: your-api-key' \
--header 'Ai-trace-id: 550e8400-e29b-41d4-a716-446655440000' \
--header 'Content-Type: application/json' \
--data '{
    "video_media_id": 123456793,
    "prompt": "Change the background to a sunny beach while keeping the person unchanged",
    "quality": "540p"
}'

Response Example

200 - Illustrative accepted task; poll to completion

{
    "ErrCode": 0,
    "ErrMsg": "Success",
    "Resp": {
        "video_id": 123456789,
        "credits": 10
    }
}

Lipsync

Image Avatar