Build with Ideogram V3 Edit Image
Make your first request
Use your Sorceress API key on your server. The playground uses your signed-in account; your application uses the same model with an API key.
curl -X POST 'https://sorceress.games/api/v1/jobs' \
-H 'Authorization: Bearer $SORCERESS_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"model": "ideogram-v3-edit",
"input": {
"expand_prompt": true,
"rendering_speed": "BALANCED",
"prompt": "<prompt>",
"image_url": "<image_url>",
"mask_url": "<mask_url>"
}
}'Inputs & settings
seedintegerSeed for the random number generator.
promptstringRequiredThe prompt to fill the masked part of the image. Maximum length: 5000 characters.
mask_urlstringRequiredThe mask URL to inpaint the image. Needs to match the dimensions of the input image. Accepted types: `image/jpeg`, `image/png`, `image/webp` Max size: 10.0MB
image_urlstringRequiredThe image URL to generate an image from. Needs to match the dimensions of the mask. Accepted types: `image/jpeg`, `image/png`, `image/webp` Max size: 10.0MB
expand_promptbooleanDetermine if MagicPrompt should be used in generating the request or not. Default value: `true`. Boolean value: `true` / `false`
rendering_speedstringThe rendering speed to use. Default value: `BALANCED`. `TURBO`: Turbo `BALANCED`: Balanced `QUALITY`: Quality
Options: TURBO, BALANCED, QUALITY
Full input schema
{
"type": "object",
"required": [
"prompt",
"image_url",
"mask_url"
],
"properties": {
"seed": {
"type": "integer",
"title": "Seed",
"description": "Seed for the random number generator."
},
"prompt": {
"type": "string",
"title": "Prompt",
"maxLength": 5000,
"description": "The prompt to fill the masked part of the image. Maximum length: 5000 characters."
},
"mask_url": {
"type": "string",
"title": "Mask URL",
"format": "uri",
"x-media": "image",
"description": "The mask URL to inpaint the image. Needs to match the dimensions of the input image. Accepted types: `image/jpeg`, `image/png`, `image/webp` Max size: 10.0MB"
},
"image_url": {
"type": "string",
"title": "Image URL",
"format": "uri",
"x-media": "image",
"description": "The image URL to generate an image from. Needs to match the dimensions of the mask. Accepted types: `image/jpeg`, `image/png`, `image/webp` Max size: 10.0MB"
},
"expand_prompt": {
"type": "boolean",
"title": "Expand prompt",
"default": true,
"description": "Determine if MagicPrompt should be used in generating the request or not. Default value: `true`. Boolean value: `true` / `false`"
},
"rendering_speed": {
"enum": [
"TURBO",
"BALANCED",
"QUALITY"
],
"type": "string",
"title": "Rendering speed",
"default": "BALANCED",
"description": "The rendering speed to use. Default value: `BALANCED`. `TURBO`: Turbo `BALANCED`: Balanced `QUALITY`: Quality"
}
}
}Results, saved runs & billing
Media requests return a job ID. Poll GET /api/v1/jobs/:id until it succeeds or fails; keep the same ID while it is processing. Long chat requests can also return a saved job to poll. Completed outputs are stored in your account, and successful work is billed using your model's current rates.
A multi-step workflow may include separately billed successful actions. If a connection drops, check your saved run before submitting it again.
