HiDream O1 Edit

POST/v1/run

Hidream O1 Edit is hidream-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 hidream-ai/hidream-o1/edit.

Default: hidream-ai/hidream-o1/edit

stringpromptrequired

Text prompt for image generation, editing, or subject-driven personalization.

Optional<array<string>>images

Reference images for image editing or subject-driven personalization.

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 reproducible generation.

Optional<string>output_format

The format of the generated image.

Allowed values: jpeg, png

Default: png

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": "hidream-ai/hidream-o1/edit",
  "prompt": "A cinematic product photo of a ceramic mug on a marble counter with the words \"fal loves HiDream\" printed on the mug.",
  "aspect_ratio": "21:9",
  "output_format": "png"
}'

# 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": "hidream-ai/hidream-o1/edit",
  "status": "running",
  "outputs": []
}