Kolors Image to Image

POST/v1/run

Kolors is KwaiVGI's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion.

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 kwaivgi/kolors/image-to-image.

Default: kwaivgi/kolors/image-to-image

stringpromptrequired

The prompt to generate an image from.

stringimagerequired

URL of image to use for image to image

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: 1 to 10

Default: 5

Optional<integer>num_inference_steps

The number of inference steps to perform.

Range: 1 to 150

Default: 50

Optional<number>strength

The strength to use for image-to-image. 1.0 is completely remakes the image while 0.0 preserves the original.

Range: 0.01 to 1

Default: 0.85

Optional<string>output_format

The format of the generated image.

Allowed values: jpeg, png

Default: png

Optional<string>scheduler

The scheduler to use for the model.

Allowed values: EulerDiscreteScheduler, EulerAncestralDiscreteScheduler, DPMSolverMultistepScheduler, DPMSolverMultistepScheduler_SDE_karras, UniPCMultistepScheduler, DEISMultistepScheduler

Default: EulerDiscreteScheduler

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<integer>seed

Seed

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": "kwaivgi/kolors/image-to-image",
  "prompt": "high quality image of a capybara wearing sunglasses. In the background of the image there are trees, poles, grass and other objects. At the bottom of the object there is the road., 8k, highly detailed.",
  "image": "https://static.sandbase.ai/examples/kwaivgi/kolors/image-to-image/input_image_0.png",
  "output_format": "png",
  "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": "kwaivgi/kolors/image-to-image",
  "status": "running",
  "outputs": []
}