API reference · PixVerse

pixverse/swap

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

VIDEOAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDpixverse/swap

Input Schema

7 parameters · 1 required · 6 optional

Parameter	Type	Required	Description
`image`	string	Required	URL of the target image for swapping
`seed`	integer	Optional	Random seed for generation
`video`	string	Optional	URL of the external video to swap
`swap_mode`	string	Optional	The swap mode to use · Options: person, object, background · Default: "person" personobjectbackground
`resolution`	string	Optional	The output resolution (1080p not supported) · Options: 360p, 540p, 720p · Default: "720p" 360p540p720p
`keyframe_id`	integer	Optional	The keyframe ID to use for face/object mapping. The input video is normalized to 24 FPS before processing, so keyframe 1 = first frame, keyframe 24 = 1 second in, etc. Valid range: 1 to (duration_seconds * 24). · Min: 1 · Default: 1
`original_sound_switch`	boolean	Optional	Whether to keep the original audio · Default: true

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

Submit — POST to /v1/run, receive an id
Poll — GET /v1/run/{id} until status is completed, failed, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "pixverse/swap",
  "image": "https://static.sandbase.ai/examples/pixverse/swap/input_image_0.jpg",
  "video": "https://static.sandbase.ai/examples/pixverse/swap/output_url_1.mp4",
  "swap_mode": "person",
  "resolution": "720p",
  "keyframe_id": 1,
  "original_sound_switch": true,
  "prompt": "a beautiful sunset over mountains"
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"

← Back to PixVerse Swap