Vace API Reference

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 alibaba/wan-vace.

Default: alibaba/wan-vace

stringpromptrequired

The text prompt to guide video generation.

Optional<string>aspect_ratio

The aspect ratio of the generated image.

Allowed values: 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16

Optional<string>mask

URL to the guiding mask file. If provided, the model will use this mask as a reference to create masked video. If provided mask video url will be ignored.

Optional<string>video

URL to the source video file. If provided, the model will use this video as a reference.

Optional<string>resolution

Resolution of the generated video (480p,580p, or 720p).

Allowed values: 480p, 580p, 720p

Default: 720p

Optional<integer>num_inference_steps

Number of inference steps for sampling. Higher values give better quality but take longer.

Range: 2 to 40

Default: 30

Optional<integer>seed

Random seed for reproducibility. If None, a random seed is chosen.

Optional<boolean>preprocess

Whether to preprocess the input video.

Default: false

Optional<number>shift

Shift parameter for video generation.

Range: 1 to 10

Default: 5

Optional<string>mask_video_url

URL to the source mask file. If provided, the model will use this mask as a reference.

Optional<integer>num_frames

Number of frames to generate. Must be between 81 to 100 (inclusive). Works only with only reference images as input if source video or mask video is provided output len would be same as source up to 241 frames

Range: 81 to 240

Default: 81

Optional<string>task

Task type for the model.

Allowed values: depth, inpainting

Default: depth

Optional<array<string>>ref_image_urls

Urls to source reference image. If provided, the model will use this image as reference.

Optional<integer>frames_per_second

Frames per second of the generated video. Must be between 5 to 24.

Range: 5 to 24

Default: 16

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: video-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": "alibaba/wan-vace", "prompt": "The video shows a man riding a horse on a vast grassland. He has long lavender hair and wears a traditional dress of a white top and black pants. The animation style makes him look like he is doing some kind of outdoor activity or performing. The background is a spectacular mountain range and cloud sky, giving a sense of tranquility and vastness. The entire video is shot from a fixed angle, focusing on the rider and his horse.", "aspect_ratio": "21:9", "video": "https://static.sandbase.ai/examples/alibaba/wan-vace/input_video_0.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"