Ideogram · Model API

Ideogram Character API Pricing

Ideogram Character API with VezAPI. Explore model capabilities, credit pricing, request parameters, and integration examples.

Image to Image

Ideogram Character API documentation

Integrate Ideogram Character with your VezAPI key. The operations below share the same authentication and account balance.

Base URL: https://api.vezapi.com
Send Authorization: Bearer YOUR_VEZAPI_KEY. Use a unique Idempotency-Key for each submission; reuse it only when checking the same request.

Ideogram - Character Edit

POST/api/v1/jobs/createTask

Model IDs: ideogram/character-edit

Parameter	Type	Description & constraints
`model` required	`string`	The model name to use for generation. Required field. - Must be `ideogram/character-edit` for this endpoint Values: `"ideogram/character-edit"` Default: `"ideogram/character-edit"`
`callBackUrl` optional	`string`	The URL to receive generation task completion updates. Optional but recommended for production use. - System will POST task status and results to this URL when generation completes - Callback includes generated content URLs and task information - Your callback endpoint should accept POST requests with JSON payload containing results - Alternatively, use the Get Task Details endpoint to poll task status - To ensure callback security, see [Webhook Verification Guide](/common-api/webhook-verification) for signature verification implementation
`input` optional	`object`	Input parameters for the generation task
`input.prompt` required	`string`	The prompt to fill the masked part of the image. (Max length: 5000 characters) `maxLength: 5000`
`input.image_url` required	`string`	The image URL to generate an image from. Should have the same aspect ratio as the mask. (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 10.0MB)
`input.mask_url` required	`string`	The mask URL to inpaint the image. Should have the same aspect ratio as the input image. (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 10.0MB)
`input.reference_image_urls` required	`array`	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 (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 10.0MB) `maxItems: 1`
`input.rendering_speed` optional	`string`	The rendering speed to use. Default value: "BALANCED" Values: `"TURBO", "BALANCED", "QUALITY"` Default: `"BALANCED"`
`input.style` optional	`string`	The style type to generate with. Default value: "AUTO" Values: `"AUTO", "REALISTIC", "FICTION"` Default: `"AUTO"`
`input.expand_prompt` optional	`boolean`	Determine if MagicPrompt should be used in generating the request or not. Default value: true (Boolean value (true/false))
`input.num_images` optional	`string`	Number of images to generate. Values: `"1", "2", "3", "4"` Default: `"1"`
`input.seed` optional	`integer`	Seed for the random number generator

Request example

curl -X POST 'https://api.vezapi.com/api/v1/jobs/createTask' \
  -H 'Authorization: Bearer YOUR_VEZAPI_KEY' \
  -H 'Idempotency-Key: your-unique-request-id' \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "ideogram/character-edit",
  "input": {
    "prompt": "A fabulous look head tilted down, looking forward with a smile\n",
    "image_url": "https://example.com/input.png",
    "mask_url": "https://example.com/input.png",
    "reference_image_urls": [
      "https://example.com/input.png"
    ]
  }
}'

Responses and errors

HTTP 200

Request successful

Parameter	Type	Description & constraints
`code` optional	`integer`	Status code of the request. The HTTP status is 200 even when the request fails, so always check this field: 200 means success; any other value means the request failed and msg describes the reason. Common values: 401 invalid or missing API key; 402 insufficient credits; 429 rate limit exceeded; 422 or 500 the request could not be processed (read msg and check your parameters before retrying). Values: `200, 401, 402, 404, 422, 429, 433, 455, 500, 501, 505`
`msg` optional	`string`	Response message, error description upon failure
`data` required	`object`
`data.taskId` required	`string`	The task ID can be used with the "Get Task Details" endpoint to query the task status.

Ideogram - Character Remix

POST/api/v1/jobs/createTask

Model IDs: ideogram/character-remix

Parameter	Type	Description & constraints
`model` required	`string`	The model name to use for generation. Required field. - Must be `ideogram/character-remix` for this endpoint Values: `"ideogram/character-remix"` Default: `"ideogram/character-remix"`
`callBackUrl` optional	`string`	The URL to receive generation task completion updates. Optional but recommended for production use. - System will POST task status and results to this URL when generation completes - Callback includes generated content URLs and task information - Your callback endpoint should accept POST requests with JSON payload containing results - Alternatively, use the Get Task Details endpoint to poll task status - To ensure callback security, see [Webhook Verification Guide](/common-api/webhook-verification) for signature verification implementation
`input` optional	`object`	Input parameters for the generation task
`input.prompt` required	`string`	The prompt to remix the image with (Max length: 5000 characters) `maxLength: 5000`
`input.image_url` required	`string`	The image URL to remix (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 10.0MB)
`input.reference_image_urls` required	`array`	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 (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 10.0MB) `maxItems: 1`
`input.rendering_speed` optional	`string`	The rendering speed to use. Default value: "BALANCED" Values: `"TURBO", "BALANCED", "QUALITY"` Default: `"BALANCED"`
`input.style` optional	`string`	The style type to generate with. Default value: "AUTO" Values: `"AUTO", "REALISTIC", "FICTION"` Default: `"AUTO"`
`input.expand_prompt` optional	`boolean`	Determine if MagicPrompt should be used in generating the request or not. Default value: true (Boolean value (true/false))
`input.image_size` optional	`string`	Output image size. Values: `"square", "square_hd", "portrait_4_3", "portrait_16_9", "landscape_4_3", "landscape_16_9"` Default: `"square_hd"`
`input.num_images` optional	`string`	Number of images to generate. Values: `"1", "2", "3", "4"` Default: `"1"`
`input.seed` optional	`integer`	Seed for the random number generator
`input.strength` optional	`number`	Strength of the input image in the remix Default value: 0.8 (Min: 0.1, Max: 1, Step: 0.1) (step: 0.1) Default: `0.8` `minimum: 0.1` `maximum: 1`
`input.negative_prompt` optional	`string`	Description of what to exclude from an image. Descriptions in the prompt take precedence to descriptions in the negative prompt. Default value: "" (Max length: 500 characters) `maxLength: 500`
`input.image_urls` optional	`array`	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 (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 10.0MB) `maxItems: 5`
`input.reference_mask_urls` optional	`string`	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 (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 10.0MB)

Request example

curl -X POST 'https://api.vezapi.com/api/v1/jobs/createTask' \
  -H 'Authorization: Bearer YOUR_VEZAPI_KEY' \
  -H 'Idempotency-Key: your-unique-request-id' \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "ideogram/character-remix",
  "input": {
    "prompt": "A fisheye lens selfie photograph taken at night on an urban street. The image is circular with a black border and shows a person wearing dark sunglasses and a black jacket, holding a silver digital camera up to capture the reflection. The background shows a row of shuttered storefronts with red neon lighting visible in the upper portion. The street is empty and dark, with street lights creating a warm glow along the sidewalk. The fisheye effect creates a curved, distorted perspective that bends the straight lines of the street and buildings. The lighting is predominantly red and dark, creating a moody urban atmosphere. The person'\''s reflection shows long dark hair and is positioned in the center of the circular frame. Multiple storefront shutters are visible in the background, creating a repeating pattern of horizontal lines. The overall composition has a cinematic quality with strong contrast between the dark street and the illuminated storefronts above.",
    "image_url": "https://example.com/input.png",
    "reference_image_urls": [
      "https://example.com/input.png"
    ]
  }
}'

Responses and errors

HTTP 200

Request successful

Parameter	Type	Description & constraints
`code` optional	`integer`	Status code of the request. The HTTP status is 200 even when the request fails, so always check this field: 200 means success; any other value means the request failed and msg describes the reason. Common values: 401 invalid or missing API key; 402 insufficient credits; 429 rate limit exceeded; 422 or 500 the request could not be processed (read msg and check your parameters before retrying). Values: `200, 401, 402, 404, 422, 429, 433, 455, 500, 501, 505`
`msg` optional	`string`	Response message, error description upon failure
`data` required	`object`
`data.taskId` required	`string`	The task ID can be used with the "Get Task Details" endpoint to query the task status.

Ideogram - Character

POST/api/v1/jobs/createTask

Model IDs: ideogram/character

Parameter	Type	Description & constraints
`model` required	`string`	The model name to use for generation. Required field. - Must be `ideogram/character` for this endpoint Values: `"ideogram/character"` Default: `"ideogram/character"`
`callBackUrl` optional	`string`	The URL to receive generation task completion updates. Optional but recommended for production use. - System will POST task status and results to this URL when generation completes - Callback includes generated content URLs and task information - Your callback endpoint should accept POST requests with JSON payload containing results - Alternatively, use the Get Task Details endpoint to poll task status - To ensure callback security, see [Webhook Verification Guide](/common-api/webhook-verification) for signature verification implementation
`input` optional	`object`	Input parameters for the generation task
`input.prompt` required	`string`	The prompt describing the scene to generate with the referenced character. (Max length: 5000 characters) `maxLength: 5000`
`input.reference_image_urls` required	`array`	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 (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 10.0MB) `maxItems: 1`
`input.rendering_speed` optional	`string`	The rendering speed to use. Default value: "BALANCED" Values: `"TURBO", "BALANCED", "QUALITY"` Default: `"BALANCED"`
`input.style` optional	`string`	The style type to generate with. Default value: "AUTO" Values: `"AUTO", "REALISTIC", "FICTION"` Default: `"AUTO"`
`input.expand_prompt` optional	`boolean`	Determine if MagicPrompt should be used in generating the request or not. Default value: true (Boolean value (true/false))
`input.num_images` optional	`string`	Number of images to generate. Values: `"1", "2", "3", "4"` Default: `"1"`
`input.image_size` optional	`string`	The resolution of the generated image Default value: square_hd Values: `"square", "square_hd", "portrait_4_3", "portrait_16_9", "landscape_4_3", "landscape_16_9"` Default: `"square_hd"`
`input.seed` optional	`integer`	Seed for the random number generator
`input.negative_prompt` optional	`string`	Description of what to exclude from an image. Descriptions in the prompt take precedence to descriptions in the negative prompt. Default value: "" (Max length: 5000 characters) `maxLength: 5000`

Request example

curl -X POST 'https://api.vezapi.com/api/v1/jobs/createTask' \
  -H 'Authorization: Bearer YOUR_VEZAPI_KEY' \
  -H 'Idempotency-Key: your-unique-request-id' \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "ideogram/character",
  "input": {
    "prompt": "Place the woman from the uploaded portrait, wearing a casual white blouse, in a peaceful garden setting. The scene should feature vibrant green plants and colorful flowers, with soft sunlight filtering through the leaves. She should be sitting on a wooden bench, holding a book and smiling gently. The background should be filled with lush greenery, with a serene, tranquil atmosphere. Golden afternoon light should highlight the woman’s face and create soft shadows on the ground, adding a peaceful, reflective mood to the scene",
    "reference_image_urls": [
      "https://example.com/input.png"
    ]
  }
}'

Responses and errors

HTTP 200

Request successful

Parameter	Type	Description & constraints
`code` optional	`integer`	Status code of the request. The HTTP status is 200 even when the request fails, so always check this field: 200 means success; any other value means the request failed and msg describes the reason. Common values: 401 invalid or missing API key; 402 insufficient credits; 429 rate limit exceeded; 422 or 500 the request could not be processed (read msg and check your parameters before retrying). Values: `200, 401, 402, 404, 422, 429, 433, 455, 500, 501, 505`
`msg` optional	`string`	Response message, error description upon failure
`data` required	`object`
`data.taskId` required	`string`	The task ID can be used with the "Get Task Details" endpoint to query the task status.

Task status and callbacks

For asynchronous tasks, keep the returned taskId. Query GET /api/v1/jobs/recordInfo?taskId=... or provide callBackUrl when creating the task. Only the account that created a task can access it or derive new resources from it.

A timeout can mean the submission was accepted. Inspect the existing request in your dashboard; do not create another task automatically. Callback delivery is retried and may arrive more than once. Deduplicate with X-VezAPI-Event-Id.

Files, logs and billing

Generated media normally follows a 14-day provider lifetime; uploaded files expire after 24 hours. Save the files you need before expiration. VezAPI streams registered files without keeping a permanent media library. Request logs are retained for two calendar months.

Credits are reserved before submission. Final deductions match actual discounted consumption one for one. Unknown usage pauses new paid requests. If available funds cannot cover final usage while protecting other reservations, settlement stays pending until funded; model usage cannot make the wallet negative. Time-based inputs require server-side metadata reads; a failed read prevents submission.

Open full documentation →

Send a request using your VezAPI key. Successful generations use your account credits.

VezAPI API Key

POST/api/v1/jobs/createTask

Request body

{
  "model": "ideogram/character-edit",
  "input": {
    "prompt": "A fabulous look head tilted down, looking forward with a smile\n",
    "image_url": "https://example.com/input.png",
    "mask_url": "https://example.com/input.png",
    "reference_image_urls": [
      "https://example.com/input.png"
    ]
  }
}

Response

Your response will appear here.

Ideogram Character API pricing

Rates below are reference estimates; final deductions equal actual discounted consumption, one for one. At the standard pack rate, 1,000 credits ≈ $10. Larger packs reduce the effective credit price.

Specification	Credits	Unit	USD reference
ideogram character, image-to-image, BALANCED	18.0	per image	$0.18
ideogram character, image-to-image, QUALITY	24.0	per image	$0.24
ideogram character-remix, image-to-image, BALANCED	18.0	per image	$0.18
ideogram character-remix, image-to-image, QUALITY	24.0	per image	$0.24
ideogram character, image-to-image, TURBO	12.0	per image	$0.12
ideogram character-remix, image-to-image, TURBO	12.0	per image	$0.12
ideogram character-edit, image-to-image, QUALITY	24.0	per image	$0.24
ideogram character-edit, image-to-image, TURBO	12.0	per image	$0.12
ideogram character-edit, image-to-image, BALANCED	18.0	per image	$0.18