PixVerse Swap

POST/v1/run

Swap by PixVerse - animate still images into dynamic videos with AI. Transform photos into cinematic clips with natural motion, camera movement, and optional audio generation.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to pixverse/swap.

Default: pixverse/swap

stringimagerequired

URL of the target image for swapping

Optional<string>video

URL of the external video to swap

Optional<string>resolution

The output resolution (1080p not supported)

Allowed values: 360p, 540p, 720p

Default: 720p

Optional<boolean>original_sound_switch

Whether to keep the original audio

Default: true

Optional<integer>keyframe_id

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).

Minimum: 1

Default: 1

Optional<string>swap_mode

The swap mode to use

Allowed values: person, object, background

Default: person

Optional<integer>seed

Random seed for generation

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

Optional<string>model

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: image-to-video

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async

# 1. Submit a generation request
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -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"
}'

# 2. If the response is still running, poll the returned id
curl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \
  -H "Authorization: Bearer $SANDBASE_API_KEY"

Response202 Accepted

{
  "id": "f3d2e8a1-7c4b-4a12-9d2e-123456789abc",
  "model": "pixverse/swap",
  "status": "running"
}