Ideogram V3 Reframe

POST/v1/run

Ideogram V3 Reframe is ideogram-ai'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 ideogram-ai/ideogram-v3/reframe.

Default: ideogram-ai/ideogram-v3/reframe

stringimagerequired

The image URL to reframe

Optional<array<string>>images

A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format

Optional<string>rendering_speed

The rendering speed to use.

Allowed values: TURBO, BALANCED, QUALITY

Default: BALANCED

stringaspect_ratiorequired

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 for the random number generator

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": "ideogram-ai/ideogram-v3/reframe",
  "image": "https://static.sandbase.ai/examples/ideogram-ai/ideogram-v3/reframe/input_image_0.png",
  "aspect_ratio": "square_hd"
}'

# 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": "ideogram-ai/ideogram-v3/reframe",
  "status": "running",
  "outputs": []
}