try-on

POST/v1/run

Cat Vton by sandbase-ai - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly.

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 sandbase-ai/cat-vton.

Default: sandbase-ai/cat-vton

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<number>guidance_scale

The CFG (Classifier Free Guidance) scale is a measure of how close you want the model to stick to your prompt when looking for a related image to show you.

Range: 0 to 20

Default: 2.5

Optional<integer>num_inference_steps

The number of inference steps to perform.

Range: 1 to 50

Default: 30

Optional<integer>seed

The same seed and the same input given to the same version of the model will output the same image every time.

Optional<string>cloth_type

Type of the Cloth to be tried on. Options: upper: Upper body cloth lower: Lower body cloth overall: Full body cloth inner: Inner cloth, like T-shirt inside a jacket outer: Outer cloth, like a jacket over a T-shirt

Allowed values: upper, lower, overall, inner, outer

Optional<string>garment_image_url

Url to the garment image.

Optional<string>human_image_url

Url for the human image.

Response Schema

The submit endpoint returns an accepted generation task. Poll the result endpoint with the returned id for terminal outputs or errors.

Optional<string>error

Error message if the task failed. Empty on success.

stringidrequired

Unique identifier for the generation task.

Optional<string>model

Model ID used for the prediction.

Optional<array>outputs

Array of generated content. Empty when status is not completed.

stringstatusrequired

Status of the task: pending, running, completed, failed, or timeout.

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

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: image-to-image

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": "sandbase-ai/cat-vton",
  "aspect_ratio": "21:9"
}'

# 2. If the response is still running, poll the returned id
curl https://api.sandbase.ai/v1/run/run_abc123 \
  -H "Authorization: Bearer $SANDBASE_API_KEY"

Response202 Accepted

{
  "id": "run_abc123",
  "model": "sandbase-ai/cat-vton",
  "status": "running",
  "outputs": []
}