API reference · Ideogram

ideogram-ai/ideogram-v3/character/edit

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

IMAGEAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDideogram-ai/ideogram-v3/character/edit

Input Schema

8 parameters · 2 required · 6 optional

Parameter	Type	Required	Description
`image`	string	Required	The image URL to generate an image from. MUST have the exact same dimensions (width and height) as the mask image.
`prompt`	string	Required	The prompt to fill the masked part of the image.
`mask`	string	Optional	The mask URL to inpaint the image. MUST have the exact same dimensions (width and height) as the input image.
`seed`	integer	Optional	Seed for the random number generator
`images`	string[]	Optional	A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format
`reference_masks`	string[]	Optional	A set of masks to apply to the character references. Currently only 1 mask is supported, rest will be ignored. (maximum total size 10MB across all character references). The masks should be in JPEG, PNG or WebP format
`rendering_speed`	string	Optional	The rendering speed to use. · Options: TURBO, BALANCED, QUALITY · Default: "BALANCED" TURBOBALANCEDQUALITY
`reference_images`	string[]	Optional	A set of images to use as character references. Currently only 1 image is supported, rest will be ignored. (maximum total size 10MB across all character references). The images should be in JPEG, PNG or WebP format

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

Submit — POST to /v1/run, receive an id
Poll — GET /v1/run/{id} until status is completed, failed, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "ideogram-ai/ideogram-v3/character/edit",
  "mask": "https://static.sandbase.ai/examples/ideogram-ai/ideogram-v3/character/edit/input_mask_2.png",
  "image": "https://static.sandbase.ai/examples/ideogram-ai/ideogram-v3/character/edit/output_url_1.png",
  "prompt": "woman holding bag",
  "rendering_speed": "BALANCED",
  "reference_images": [
    "https://static.sandbase.ai/examples/ideogram-ai/ideogram-v3/character/edit/input_reference_image_urls_0.png"
  ]
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"

← Back to Ideogram V3 Character Edit