API reference · Ideogram

ideogram-ai/ideogram-v2/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-v2/edit

Input Schema

5 parameters · 2 required · 3 optional

Parameter	Type	Required	Description
`image`	string	Required	The image URL to generate an image from. Needs to match the dimensions of the mask.
`prompt`	string	Required	The prompt to fill the masked part of the image.
`mask`	string	Optional	The mask URL to inpaint the image. Needs to match the dimensions of the input image.
`seed`	integer	Optional	Seed for the random number generator
`style`	string	Optional	The style of the generated image · Options: auto, general, realistic, design, render_3D, anime · Default: "auto" autogeneralrealisticdesignrender_3Danime

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-v2/edit",
  "mask": "https://static.sandbase.ai/examples/ideogram-ai/ideogram-v2/edit/input_mask_1.jpeg",
  "image": "https://static.sandbase.ai/examples/ideogram-ai/ideogram-v2/edit/input_image_0.jpeg",
  "style": "auto",
  "prompt": "A knight in shining armour holding a greatshield with \"FAL\" on it"
}'

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

← Back to Ideogram V2 Edit