Skip to content
中文
Get API key
☰
Ideogram · Model API

Ideogram V3 API

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

Text to ImageImage to Image

Ideogram V3 API documentation

Integrate Ideogram V3 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/v3-remix

POST/api/v1/jobs/createTask

Model IDs: ideogram/v3-remix

ParameterTypeDescription & constraints
model
required		string

The model name used for generation. This field is required. - This endpoint must use the `ideogram/v3-remix` model

Values: "ideogram/v3-remix"

Default: "ideogram/v3-remix"

callBackUrl
optional		string

Callback URL for task completion notifications. Optional parameter. If provided, the system will send a POST request to this URL when the task completes, whether it succeeds or fails. If omitted, no callback notification will be sent.

input
required		object

Input parameters for the image remix task.

input.prompt
required		string

The prompt to remix the image with. Maximum length: 5000 characters.

maxLength: 5000

input.image_url
required		string

The image URL to remix. - Please provide the URL of the uploaded file, not raw file content - Accepted types: `image/jpeg`, `image/png`, `image/webp` - Max size: 10.0MB

input.rendering_speed
optional		string

The rendering speed to use. - `TURBO`: Turbo - `BALANCED`: Balanced - `QUALITY`: Quality

Values: "TURBO", "BALANCED", "QUALITY"

input.style
optional		string

The style type to generate with. - `AUTO`: Auto - `GENERAL`: General - `REALISTIC`: Realistic - `DESIGN`: Design

Values: "AUTO", "GENERAL", "REALISTIC", "DESIGN"

input.expand_prompt
optional		boolean

Determine if MagicPrompt should be used in generating the request or not. - Boolean value: `true` / `false`

input.image_size
optional		string

The resolution of the generated image. - `square`: Square - `square_hd`: Square HD - `portrait_4_3`: Portrait 3:4 - `portrait_16_9`: Portrait 9:16 - `landscape_4_3`: Landscape 4:3 - `landscape_16_9`: Landscape 16:9

Values: "square", "square_hd", "portrait_4_3", "portrait_16_9", "landscape_4_3", "landscape_16_9"

input.num_images
optional		string

Number of images to generate. - `1`: 1 image - `2`: 2 images - `3`: 3 images - `4`: 4 images

Values: "1", "2", "3", "4"

input.seed
optional		integer

Seed for the random number generator.

input.strength
optional		number

Strength of the input image in the remix. - Minimum: `0.01` - Maximum: `1` - Step: `0.01`

minimum: 0.01

maximum: 1

input.negative_prompt
optional		string

Description of what to exclude from the generated image. If the positive prompt conflicts with the negative prompt, the positive prompt takes precedence. Maximum 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/v3-remix",
  "input": {
    "prompt": "Change the cube into a sphere",
    "image_url": "https://example.com/input.png"
  }
}'
Responses and errors

HTTP 200

Request successful

ParameterTypeDescription & 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.

HTTP 500

Server error.

Ideogram V3 Edit

POST/api/v1/jobs/createTask

Model IDs: ideogram/v3-edit

ParameterTypeDescription & constraints
model
required		string

The model name used for generation. This field is required. - This endpoint must use the `ideogram/v3-edit` model

Values: "ideogram/v3-edit"

Default: "ideogram/v3-edit"

callBackUrl
optional		string

Callback URL for task completion notifications. Optional parameter. If provided, the system will send a POST request to this URL when the task completes, whether it succeeds or fails. If omitted, no callback notification will be sent.

input
required		object

Input parameters for the image editing task.

input.prompt
required		string

The prompt to fill the masked part of the image. Maximum length: 5000 characters.

maxLength: 5000

input.image_url
required		string

The image URL to generate an image from. Needs to match the dimensions of the mask. - Please provide the URL of the uploaded file, not raw 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. Needs to match the dimensions of the input image. - Please provide the URL of the uploaded file, not raw file content - Accepted types: `image/jpeg`, `image/png`, `image/webp` - Max size: 10.0MB

input.rendering_speed
optional		string

The rendering speed to use. Default value: `BALANCED`. - `TURBO`: Turbo - `BALANCED`: Balanced - `QUALITY`: Quality

Values: "TURBO", "BALANCED", "QUALITY"

Default: "BALANCED"

input.expand_prompt
optional		boolean

Determine if MagicPrompt should be used in generating the request or not. Default value: `true`. - Boolean value: `true` / `false`

Default: true

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/v3-edit",
  "input": {
    "prompt": "A dog wearing a cowboy hat",
    "image_url": "https://example.com/input.png",
    "mask_url": "https://example.com/input.png"
  }
}'
Responses and errors

HTTP 200

Request successful

ParameterTypeDescription & 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.

HTTP 500

Server error.

Ideogram V3 Text to Image

POST/api/v1/jobs/createTask

Model IDs: ideogram/v3-text-to-image

ParameterTypeDescription & constraints
model
required		string

The model name used for generation. This field is required. - This endpoint must use the `ideogram/v3-text-to-image` model

Values: "ideogram/v3-text-to-image"

Default: "ideogram/v3-text-to-image"

callBackUrl
optional		string

Callback URL for task completion notifications. Optional parameter. If provided, the system will send a POST request to this URL when the task completes, whether it succeeds or fails. If omitted, no callback notification will be sent.

input
required		object

Input parameters for the generation task.

input.prompt
required		string

Description of the image to generate. Maximum length: 5000 characters.

maxLength: 5000

input.rendering_speed
optional		string

The rendering speed to use. - `TURBO`: Turbo - `BALANCED`: Balanced - `QUALITY`: Quality

Values: "TURBO", "BALANCED", "QUALITY"

input.style
optional		string

The style type to generate with. - `AUTO`: Auto - `GENERAL`: General - `REALISTIC`: Realistic - `DESIGN`: Design

Values: "AUTO", "GENERAL", "REALISTIC", "DESIGN"

input.expand_prompt
optional		boolean

Determines whether MagicPrompt should be used to enhance the generation request. - Boolean value: `true` / `false`

input.image_size
optional		string

The resolution of the generated image. - `square`: Square - `square_hd`: Square HD - `portrait_4_3`: Portrait 3:4 - `portrait_16_9`: Portrait 9:16 - `landscape_4_3`: Landscape 4:3 - `landscape_16_9`: Landscape 16:9

Values: "square", "square_hd", "portrait_4_3", "portrait_16_9", "landscape_4_3", "landscape_16_9"

input.seed
optional		integer

Seed for the random number generator.

input.negative_prompt
optional		string

Description of what to exclude from the generated image. If the positive prompt conflicts with the negative prompt, the positive prompt takes precedence. Maximum 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/v3-text-to-image",
  "input": {
    "prompt": "A cinematic photograph of a tranquil lakeside at twilight, viewed from a slight elevation. In the center, a cluster of softly glowing reeds and water lilies emit a gentle golden light, their reflections shimmering on the calm surface. The elegant neon-style white text '\''Kie.ai'\'' hovers just above the water, subtly illuminated and harmonizing with the natural glow. Surrounding willows and drifting mist frame the scene, creating a serene yet magical atmosphere, with warm highlights contrasting against the cool blues of the evening sky."
  }
}'
Responses and errors

HTTP 200

Request successful

ParameterTypeDescription & 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.

HTTP 500

Server error.

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 →

Ideogram V3 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.

SpecificationCreditsUnitUSD reference
ideogram v3-remix, image-to-image, BALANCED7.0per image$0.07
ideogram v3-remix, image-to-image, QUALITY10.0per image$0.1
ideogram v3-edit, image-to-image, QUALITY10.0per image$0.1
ideogram v3-remix, image-to-image, TURBO3.5per image$0.035
ideogram v3-edit, image-to-image, BALANCED7.0per image$0.07
ideogram v3-edit, image-to-image, TURBO3.5per image$0.035
ideogram v3, text-to-image, QUALITY10.0per image$0.1
ideogram v3, text-to-image, TURBO3.5per image$0.035
ideogram v3, text-to-image, BALANCED7.0per image$0.07