Ideogram V3 Character Edit

POST/v1/run

Ideogram V3 Character Edit by ideogram-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 ideogram-ai/ideogram-v3/character/edit.

Default: ideogram-ai/ideogram-v3/character/edit

stringpromptrequired

The prompt to fill the masked part of the image.

stringimagerequired

The image URL to generate an image from. MUST have the exact same dimensions (width and height) as the mask image.

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

The mask URL to inpaint the image. MUST have the exact same dimensions (width and height) as the input image.

Optional<array<string>>reference_masks

A set of masks to apply to the character references. Currently only 1 mask is supported, rest will be ignored. (maximum total size 10MB across all character references). The masks should be in JPEG, PNG or WebP format

Optional<array<string>>reference_images

A set of images to use as character references. Currently only 1 image is supported, rest will be ignored. (maximum total size 10MB across all character 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

Optional<integer>seed

Seed for the random number generator

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": "ideogram-ai/ideogram-v3/character/edit",
  "prompt": "woman holding bag",
  "image": "https://static.sandbase.ai/examples/ideogram-ai/ideogram-v3/character/edit/output_url_1.png"
}'

# 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": "ideogram-ai/ideogram-v3/character/edit",
  "status": "running"
}