PixVerse Platform Docs(for enterprise)
  1. Swap
PixVerse Platform Docs(for enterprise)
  • Model & Pricing
  • Swap
    • How to use Swap
    • Mask selection generation
      POST
    • Swap generation
      POST
  • Multi-transition
    • How to use multi-transtion
    • Multi-trasition generate
      POST
  • Previous updates
    • Sound_effect
      • How to use Sound effects?
      • Generate Sound Effects
    • Lip sync
      • How to use Lip Sync?
      • Tts speaker list
      • Generate lip sync video
      • Get tts speaker list
    • Fusion(Reference to Video)
      • How to use fusion (reference to video)?
      • Generate Fusion(Reference to Video) video
    • Template for multiple-images
      • How to use multiple-image templates?
    • Extend
      • How to use Extend?
      • Generate Extend video
    • Restyle
      • How to use restyle?
      • Restyle generation
      • Restyle get list
  • Upload media (video&audio)
    POST
  1. Swap

Mask selection generation

POST
/openapi/v2/video/mask/selection

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
curl --location --request POST 'https://app-api.pixverse.ai/openapi/v2/video/mask/selection' \
--header 'API-KEY: your-api-key' \
--header 'Ai-trace-id: your-ai-trace-id' \
--header 'Content-Type: application/json' \
--data-raw '{
    //"source_video_id":0,
    "video_media_id": 0,
    "keyframe_id": 0
}'
Response Response Example
{
    "ErrCode": 0,
    "ErrMsg": "Success",
    "Resp": {
        "keyframe_id": 1,
        "keyframe_url": "https://media.pixverse.ai/xx.png",
        "credits": 2,
        "mask_info": [
            {
                "mask_id": "0",
                "mask_name": "person",
                "mask_url": "https://media.pixverse.ai/xx.png"
            },
            {
                "mask_id": "0",
                "mask_name": "object",
                "mask_url": "https://media.pixverse.ai/xx.png"
            },
            {
                "mask_id": "0",
                "mask_name": "background",
                "mask_url": "https://media.pixverse.ai/xx.png"
            }
        ]
    }
}
Modified at 2025-11-09 07:34:48
Previous
How to use Swap
Next
Swap generation
Built with