HiDream Edit API

HiDream O1 image-conditioned editing. Provide a source image and an instruction. Integrate this model via REST with endpoint docs, parameters, and code examples.

Image Generation

Img2Img

Editing

Content moderation disabled

Credit Cost

1 credit

Type

image

Get API Key

Create auth keys for apps and agents

See Usage

Track requests, credits, and logs

Buy Credits

Top up prepaid API capacity

API Endpoint

POST

/api/v1/models/hidream-edit/run

LLM.txt

AI-Ready

For AI assistants

Copy this model's documentation into Claude, GPT, or any AI for instant integration help.

/llm/hidream-edit.txt

OpenAPI Spec

Swagger compatible

Import into Postman, Swagger UI, or generate client SDKs in any language.

/api/openapi

Parameters

Input parameters accepted by this model

Parameter	Type	Description	Default
`prompt` required	string	Edit instruction describing the change to make.	-
`image` required	string	URL of the source image to edit.	-
`model`	enum	HiDream O1 Edit (default) or Edit Dev (faster, distilled). `fal-ai/hidream-o1-image/editfal-ai/hidream-o1-image/dev/edit`	`fal-ai/hidream-o1-image/edit`
`image_size`	enum	Output size preset. Set `keep_original_aspect` to preserve the input image aspect. `square_hdsquarelandscape_4_3landscape_16_9portrait_4_3`+1 more	`square_hd`
`keep_original_aspect`	boolean	When true, preserves the source image aspect ratio.	`true`
`seed`	integer	Random seed for reproducibility.	-

Code Examples

Copy and paste to get started

bash

curl -X POST "https://pixeldojo.ai/api/v1/models/hidream-edit/run" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "A beautiful mountain landscape at golden hour",
    "aspect_ratio": "1:1"
  }'

Response Format

Submit Response (202 Accepted)

json

{
  "jobId": "job_abc123...",
  "status": "pending",
  "statusUrl": "https://pixeldojo.ai/api/v1/jobs/job_abc123...",
  "creditCost": 1,
  "creditsRemaining": 95,
  "expiresAt": "2025-01-23T12:00:00Z"
}

Completed Response