Ideogram V3 Edit
Endpoint
POST /images/generations
Full URL: https://modelfold.ai/v1/images/generations
Authentication: every request must include the
Authorization: Bearer <API_KEY>header.
Send model parameters directly in the JSON body. Do not wrap them in input. This request waits for generation to finish and returns data[].url; supported media models also offer async jobs, polling and callbacks. Replace example media URLs with your own publicly accessible files. See API gateway for billing and errors.
Input parameters for the image editing task.
Request Parameters
Body (application/json)
| Parameter | Type | Required | Description |
|---|---|---|---|
model | string | Yes | The model name used for generation. This field is required. - This endpoint must use the ideogram/v3-edit model Default:"ideogram/v3-edit"。 Allowed values:ideogram/v3-edit。 Example:ideogram/v3-edit。 |
prompt | string | Yes | Prompt required by the ModelFold gateway; at most 2000 characters. The prompt to fill the masked part of the image. Maximum length: 5000 characters. maxLength: 2000. Example:A dog wearing a cowboy hat。 |
image_url | string | Yes | The image URL to generate an image from. Needs to match the dimensions of the mask. - Please provide the URL of the uploaded file, not raw file content - Accepted types: image/jpeg, image/png, image/webp- Max size: 10.0MB Example: https://file.aiquickdraw.com/custom-page/akr/section-images/1755076859801ryyol1du.webp。 |
mask_url | string | Yes | The mask URL to inpaint the image. Needs to match the dimensions of the input image. - Please provide the URL of the uploaded file, not raw file content - Accepted types: image/jpeg, image/png, image/webp- Max size: 10.0MB Example: https://file.aiquickdraw.com/custom-page/akr/section-images/1755076871089hx9uonhc.webp。 |
rendering_speed | string | No | The rendering speed to use. Default value: BALANCED.- TURBO: Turbo- BALANCED: Balanced- QUALITY: Quality Default:"BALANCED"。 Allowed values:TURBO / BALANCED / QUALITY。 Example:BALANCED。 |
expand_prompt | boolean | No | Determine if MagicPrompt should be used in generating the request or not. Default value: true.- Boolean value: true / false Default:true。 Example:true。 |
seed | integer | No | Seed for the random number generator. |
Request Example
bash
curl -X POST "https://modelfold.ai/v1/images/generations" \
-H "Authorization: Bearer $MODELFOLD_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "ideogram/v3-edit",
"prompt": "A dog wearing a cowboy hat",
"image_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/1755076859801ryyol1du.webp",
"mask_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/1755076871089hx9uonhc.webp",
"rendering_speed": "BALANCED",
"expand_prompt": true
}'json
{
"model": "ideogram/v3-edit",
"prompt": "A dog wearing a cowboy hat",
"image_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/1755076859801ryyol1du.webp",
"mask_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/1755076871089hx9uonhc.webp",
"rendering_speed": "BALANCED",
"expand_prompt": true
}Response
200 — Generation completed. usage contains actual billing details; result URLs are illustrative.
json
{
"ok": true,
"created": 1792134000,
"data": [
{
"url": "https://modelfold.ai/uploads/outputs/result.png"
}
],
"usage": {}
}