Skip to content
youbot
Docs menu
APIFile UploadAccount & Common

Image models

Ideogram Character

On this page

Ideogram Character — fast, high-fidelity AI image generation & editing.

modelIdideogram-character, ideogram-character-edit, ideogram-character-remix
Modalityimage
PricingSee this model on the Pricing page for the current per-call price (with your markup).

Operations

OperationmodelIdEndpointRequired input
Characterideogram-characterPOST /api/v1/generateprompt, reference_image_urls
Character Editideogram-character-editPOST /api/v1/generateprompt, image_url, mask_url, reference_image_urls
Character Remixideogram-character-remixPOST /api/v1/generateprompt, image_url, reference_image_urls
Poll task—GET /api/v1/task/{id}?model=ideogram-character—

Character — ideogram-character

FieldTypeRequiredValues / example
promptstringYesThe prompt to fill the masked part of the image. Max 5000 characters. (default: The same character as a cinematic studio portrait, soft golden rim light, shallow depth of field, clean and tasteful composition.)
reference_image_urlsstring[]YesA 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 (image URL)
rendering_speedstringNoThe rendering speed to use. Default value: "BALANCED" (options: TURBO | BALANCED | QUALITY) (default: BALANCED)
stylestringNoThe style type to generate with. Cannot be used with style_codes. Default value: "AUTO" (options: AUTO | REALISTIC | FICTION) (default: AUTO)
expand_promptbooleanNoDetermine if MagicPrompt should be used in generating the request or not. Default value: true (true/false) (default: true)
num_imagesstringNoSelect description (options: 1 | 2 | 3 | 4) (default: 1)
image_sizestringNoThe resolution of the generated image Default value: square_hd (options: square | square_hd | portrait_4_3 | portrait_16_9 | landscape_4_3 | landscape_16_9) (default: square_hd)
seednumberNoSeed for the random number generator
negative_promptstringNoDescription of what to exclude from an image. Descriptions in the prompt take precedence to descriptions in the negative prompt. Default value: "" Max 5000 characters.
nsfw_checkerbooleanNoA configurable parameter. Defaults to true in the Playground. (true/false) (default: true)
bash
curl -X POST https://you.bot/api/v1/generate \
  -H "Authorization: Bearer $YOUBOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"modelId":"ideogram-character","input":{"prompt":"A photorealistic portrait of a red fox in a snowy forest, soft morning light, shallow depth of field, 85mm.","reference_image_urls":["https://example.com/input.jpg"],"rendering_speed":"BALANCED","style":"AUTO","expand_prompt":true,"num_images":"1","image_size":"square_hd","seed":1,"negative_prompt":"blurry, low quality, distorted, watermark, text","nsfw_checker":true}}'

Character Edit — ideogram-character-edit

FieldTypeRequiredValues / example
promptstringYesThe prompt to fill the masked part of the image. Max 5000 characters. (default: Reimagine the same character as a gentle cloud-shepherd in a sky-blue coat, guiding a flock of fluffy sheep-shaped clouds across a pastel sky, keeping their face and features perfectly consistent.)
image_urlstringYesThe image URL to generate an image from. Needs to match the dimensions of the mask. (image URL)
mask_urlstringYesMust be the SAME pixel dimensions as the input image, or the edit is rejected. (image URL)
reference_image_urlsstring[]YesA 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 (image URL)
rendering_speedstringNoThe rendering speed to use. Default value: "BALANCED" (options: TURBO | BALANCED | QUALITY) (default: BALANCED)
stylestringNoThe style type to generate with. Cannot be used with style_codes. Default value: "AUTO" (options: AUTO | REALISTIC | FICTION) (default: AUTO)
expand_promptbooleanNoDetermine if MagicPrompt should be used in generating the request or not. Default value: true (true/false) (default: true)
num_imagesstringNoSelect description (options: 1 | 2 | 3 | 4) (default: 1)
seednumberNoSeed for the random number generator
nsfw_checkerbooleanNoA configurable parameter. Defaults to true in the Playground. (true/false) (default: true)
bash
curl -X POST https://you.bot/api/v1/generate \
  -H "Authorization: Bearer $YOUBOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"modelId":"ideogram-character-edit","input":{"prompt":"A photorealistic portrait of a red fox in a snowy forest, soft morning light, shallow depth of field, 85mm.","image_url":"https://example.com/input.jpg","mask_url":"https://example.com/input.jpg","reference_image_urls":["https://example.com/input.jpg"],"rendering_speed":"BALANCED","style":"AUTO","expand_prompt":true,"num_images":"1","seed":1,"nsfw_checker":true}}'

Character Remix — ideogram-character-remix

FieldTypeRequiredValues / example
promptstringYesThe prompt to remix the image with Max 5000 characters. (default: Reimagine the same creature as a regal snowy owl perched on a mossy branch, keeping its pose and expression, bathed in soft dawn light with painterly feather detail.)
image_urlstringYesThe image URL to remix (image URL)
reference_image_urlsstring[]YesA 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 (image URL)
rendering_speedstringNoThe rendering speed to use. Default value: "BALANCED" (options: TURBO | BALANCED | QUALITY) (default: BALANCED)
stylestringNoThe style type to generate with. Cannot be used with style_codes. Default value: "AUTO" (options: AUTO | REALISTIC | FICTION) (default: AUTO)
expand_promptbooleanNoDetermine if MagicPrompt should be used in generating the request or not. Default value: true (true/false) (default: true)
image_sizestringNoSelect description (options: square | square_hd | portrait_4_3 | portrait_16_9 | landscape_4_3 | landscape_16_9) (default: square_hd)
num_imagesstringNoSelect description (options: 1 | 2 | 3 | 4) (default: 1)
seednumberNoSeed for the random number generator
strengthnumberNoStrength of the input image in the remix Default value: 0.8 (range 0.1-1) (default: 0.8)
negative_promptstringNoDescription of what to exclude from an image. Descriptions in the prompt take precedence to descriptions in the negative prompt. Default value: "" Max 500 characters.
image_urlsstring[]NoA 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 (image URL)
reference_mask_urlsstringNoA 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 (image URL)
nsfw_checkerbooleanNoA configurable parameter. Defaults to true in the Playground. (true/false) (default: true)
bash
curl -X POST https://you.bot/api/v1/generate \
  -H "Authorization: Bearer $YOUBOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"modelId":"ideogram-character-remix","input":{"prompt":"A photorealistic portrait of a red fox in a snowy forest, soft morning light, shallow depth of field, 85mm.","image_url":"https://example.com/input.jpg","reference_image_urls":["https://example.com/input.jpg"],"rendering_speed":"BALANCED","style":"AUTO","expand_prompt":true,"image_size":"square_hd","num_images":"1","seed":1,"strength":0.8,"negative_prompt":"blurry, low quality, distorted, watermark, text","image_urls":["https://example.com/input.jpg"],"reference_mask_urls":"https://example.com/input.jpg","nsfw_checker":true}}'
Nano Banana ProIdeogram V3