Glm Image

POST/v1/run

Glm Image Edit by zhipu - 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 zhipu/glm-image/edit.

Default: zhipu/glm-image/edit

stringpromptrequired

Text prompt for image generation.

Optional<array<string>>images

URL(s) of the condition image(s) for image-to-image generation. Supports up to 4 URLs for multi-image references.

Optional<number>guidance_scale

Classifier-free guidance scale. Higher values make the model follow the prompt more closely.

Range: 1 to 10

Default: 1.5

Optional<integer>num_inference_steps

Number of diffusion denoising steps. More steps generally produce higher quality images.

Range: 10 to 100

Default: 30

Optional<string>output_format

Output image format.

Allowed values: jpeg, png

Default: jpeg

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

Random seed for reproducibility. The same seed with the same prompt will produce the same image.

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-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": "zhipu/glm-image/edit",
  "prompt": "Make the dress red.",
  "output_format": "jpeg",
  "aspect_ratio": "21:9"
}'

# 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": "zhipu/glm-image/edit",
  "status": "running"
}