Grok Imagine Image Edit

POST/v1/run

Grok Imagine Image Edit is xAI'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 xai/grok-imagine-image/edit.

Default: xai/grok-imagine-image/edit

stringpromptrequired

Text description of the desired image.

Optional<array<string>>images

List of URLs of the images to edit. A maximum of 3 images are supported.

Optional<string>resolution

Resolution of the generated image. `1k` for standard resolution, `2k` for high resolution.

Allowed values: 1k, 2k

Default: 1k

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>output_format

The format of the generated image.

Allowed values: jpeg, png

Default: jpeg

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": "xai/grok-imagine-image/edit",
  "prompt": "Make this scene more realistic but still keep the game vibes",
  "aspect_ratio": "21:9",
  "output_format": "jpeg"
}'

# 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": "xai/grok-imagine-image/edit",
  "status": "running",
  "outputs": []
}