HiDream I1 Full Edit

POST/v1/run

Hidream I1 Full Edit by hidream-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 hidream-ai/hidream-i1/full/edit.

Default: hidream-ai/hidream-i1/full/edit

stringpromptrequired

The prompt to generate an image from.

stringimagerequired

The image URL to generate an image from.

Optional<number>strength

Denoising strength for image-to-image generation.

Range: 0 to 1

Default: 0.75

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: 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": "hidream-ai/hidream-i1/full/edit",
  "prompt": "An old man",
  "image": "https://static.sandbase.ai/examples/hidream-ai/hidream-i1/full/edit/input_image_0.png",
  "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": "hidream-ai/hidream-i1/full/edit",
  "status": "running",
  "outputs": []
}