Pixazo APIModelsIdeogram
Pixazo APIModelsIdeogram

Ideogram 2.0 API, Ideogram Turbo API - AI Image Generation APIs

by Ideogram

Ideogram 2.0 API, developers can create images containing logos, signs, typography, and text elements that render correctly. The API offers both standard and turbo variants, plus features like image editing, remixing, and description generation.

Get API Key
Ideogram AI API

Models Version

LIMITED TIME OFFER

Get $5 Free Credit on First Payment

No strings attached — add funds and get $5 bonus instantly

Claim Your $5 →

Ideogram v2 Text to Image API Documentation

Request Code

POST https://gateway.pixazo.ai/ideogramV_2/v1/generate
Content-Type: application/json
Cache-Control: no-cache
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY

{
    "image_request": {
        "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
        "negative_prompt": "blur",
        "model": "V_2",
        "aspect_ratio": "ASPECT_10_16",
        "magic_prompt_option": "AUTO",
        "seed": 212,
        "style_type": "AUTO",
        "color_palette": {
            "name": "JUNGLE"
        }
    }
}
import requests
import json

url = "https://gateway.pixazo.ai/ideogramV_2/v1/generate"
headers = {
    "Content-Type": "application/json",
    "Cache-Control": "no-cache",
    "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}
data = {
    "image_request": {
        "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
        "negative_prompt": "blur",
        "model": "V_2",
        "aspect_ratio": "ASPECT_10_16",
        "magic_prompt_option": "AUTO",
        "seed": 212,
        "style_type": "AUTO",
        "color_palette": {
            "name": "JUNGLE"
        }
    }
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const url = 'https://gateway.pixazo.ai/ideogramV_2/v1/generate';
const headers = {
  'Content-Type': 'application/json',
  'Cache-Control': 'no-cache',
  'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
};

const data = {
  image_request: {
    prompt: 'A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.',
    negative_prompt: 'blur',
    model: 'V_2',
    aspect_ratio: 'ASPECT_10_16',
    magic_prompt_option: 'AUTO',
    seed: 212,
    style_type: 'AUTO',
    color_palette: {
      name: 'JUNGLE'
    }
  }
};

fetch(url, {
  method: 'POST',
  headers: headers,
  body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
curl -v -X POST "https://gateway.pixazo.ai/ideogramV_2/v1/generate" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--data-raw '{
    "image_request": {
        "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
        "negative_prompt": "blur",
        "model": "V_2",
        "aspect_ratio": "ASPECT_10_16",
        "magic_prompt_option": "AUTO",
        "seed": 212,
        "style_type": "AUTO",
        "color_palette": {
            "name": "JUNGLE"
        }
    }
}'

Output

{
  "created": "2024-11-01T10:06:14.744267+00:00",
  "data": [
    {
      "is_image_safe": true,
      "prompt": "A serene tropical beach scene...",
      "resolution": "800x1280",
      "seed": 212,
      "style_type": "REALISTIC",
      "url": "https://ideogram.ai/api/images/ephemeral/4p6cIwykSjaWcUUavtwuMw.png?exp=1730541994&sig=ef2b2872a29327783454a41061d1e890361cb6a5c77c358c6190793095428b59"
    }
  ]
}

Request Parameters - Create Image

Parameter Required Type Description
promptYesstringText describing the scene or image to be generated.
negative_promptNostringSpecifies elements or features to avoid in the image generation.
modelYesstringThe version of the model to use. Currently supported value: V_2.
aspect_ratioNoenumDetermines the image resolution. Default: ASPECT_1_1. Other values: ASPECT_10_16, ASPECT_16_10, ASPECT_9_16, ASPECT_16_9, ASPECT_3_2, ASPECT_2_3, ASPECT_4_3, ASPECT_3_4, ASPECT_1_1, ASPECT_1_3, ASPECT_3_1
seedNointegerProvides a random seed for reproducibility. Allowed range: 1 to 9999999999.
magic_prompt_optionNoenumControls use of MagicPrompt. Default: AUTO. Other values: ON, OFF.
style_typeNoenumSpecifies the style type for the image. Default: AUTO. Other values include GENERAL, REALISTIC, DESIGN, RENDER_3D, ANIME
color_paletteNoobjectDefines a color palette using a preset name. Available presets: EMBER, FRESH, JUNGLE, MAGIC, MELON, MOSAIC, PASTEL, ULTRAMARINE

Example Request

{
    "image_request": {
        "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
        "negative_prompt": "blur",
        "model": "V_2",
        "aspect_ratio": "ASPECT_10_16",
        "magic_prompt_option": "AUTO",
        "seed": 212,
        "style_type": "AUTO",
        "color_palette": {
            "name": "JUNGLE"
        }
    }
}

Response

{
    "created": "2024-11-01T10:06:14.744267+00:00",
    "data": [
        {
            "is_image_safe": true,
            "prompt": "A serene tropical beach scene with tall palm trees, a sandy beach, and azure waters...",
            "resolution": "800x1280",
            "seed": 212,
            "style_type": "REALISTIC",
            "url": "https://ideogram.ai/api/images/ephemeral/4p6cIwykSjaWcUUavtwuMw.png?exp=1730541994&sig=ef2b2872a29327783454a41061d1e890361cb6a5c77c358c6190793095428b59"
        }
    ]
}

Request Headers

Header Value
Content-Typeapplication/json
Cache-Controlno-cache
Ocp-Apim-Subscription-KeyYOUR_SUBSCRIPTION_KEY

Response Handling

Common status codes for Create Image.

Code Meaning
200 Success
Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
Too Many Requests
500 Internal Server Error

Ideogram v2 Text to Image API Pricing

ResolutionPrice (USD)
All Resolution$0.2

Ideogram v2 Utility (Image to Text — Captioning) API Documentation

Request Code

POST https://gateway.pixazo.ai/ideogramV_2/v1/describe
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY
Content-Type: multipart/form-data

import requests

url = "https://gateway.pixazo.ai/ideogramV_2/v1/describe"
headers = {
    "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}

with open("/path/to/your/image.png", "rb") as image_file:
    files = {"image_file": image_file}
    response = requests.post(url, headers=headers, files=files)

print(response.json())
const formData = new FormData();
formData.append('image_file', fileInput.files[0]);

fetch('https://gateway.pixazo.ai/ideogramV_2/v1/describe', {
  method: 'POST',
  headers: {
    'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
  },
  body: formData
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
curl -X POST "https://gateway.pixazo.ai/ideogramV_2/v1/describe" \
-H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
-H "Content-Type: multipart/form-data" \
--form 'image_file=@/path/to/your/image.png'

Output

{
  "created": "2024-11-01T10:06:14.744267+00:00",
  "data": {
    "description": "The image depicts a serene tropical beach..."
  }
}

Request Parameters - Describe Image

Parameter Required Type Description
image_fileYesFileThe image file for which a description is needed.

Example Request

--form 'image_file=@/path/to/your/image.png'

Response

{
  "created": "2024-11-01T10:06:14.744267+00:00",
  "data": {
    "description": "The image depicts a serene tropical beach scene with tall palm trees and azure waters."
  }
}

Request Headers

Header Value
Ocp-Apim-Subscription-KeyYOUR_SUBSCRIPTION_KEY
Content-Typemultipart/form-data

Response Handling

Common status codes for Describe Image.

Code Meaning
200 Success
Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
Too Many Requests
500 Internal Server Error

Ideogram v2 Utility (Image to Text — Captioning) API Pricing

ResolutionPrice (USD)
All Resolution$0.2

Ideogram v2 Image to Image (Image Editing) API Documentation

Request Code

POST https://gateway.pixazo.ai/ideogramV_2/v1/edit
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY
Content-Type: multipart/form-data

import requests

url = "https://gateway.pixazo.ai/ideogramV_2/v1/edit"
headers = {
    "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}
files = {
    "image_file": open("path/to/your/image.png", "rb"),
    "mask": open("path/to/your/mask.png", "rb"),
    "prompt": (None, "Enhance brightness and remove text"),
    "model": (None, "V_2")
}

response = requests.post(url, headers=headers, files=files)
print(response.json())
const formData = new FormData();
formData.append('image_file', document.getElementById('imageFile').files[0]);
formData.append('mask', document.getElementById('maskFile').files[0]);
formData.append('prompt', 'Enhance brightness and remove text');
formData.append('model', 'V_2');

fetch('https://gateway.pixazo.ai/ideogramV_2/v1/edit', {
  method: 'POST',
  headers: {
    'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
  },
  body: formData
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
curl -X POST "https://gateway.pixazo.ai/ideogramV_2/v1/edit" \
-H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
-H "Content-Type: multipart/form-data" \
--form 'image_file=@/path/to/your/image.png' \
--form 'mask=@/path/to/your/mask.png' \
--form 'prompt="Enhance brightness and remove text"' \
--form 'model="V_2"'

Output

{
  "created": "2024-11-01T10:06:14.744267+00:00",
  "data": [
    {
      "is_image_safe": true,
      "prompt": "Enhance brightness and remove text",
      "edited_image": "https://ideogram.ai/api/images/ephemeral/iSkGI5XfQ-ObReWhAiw_iA.png?exp=1730547982&sig=dabe41c3e4caa3ef788f32acc842cccfb2816686aab3e1a35d69d9139183fdc7"
    }
  ]
}

Request Parameters - Edit Image

Parameter Required Type Description
image_fileYesFileThe image file to be edited.
maskNoFileA mask file that determines which parts of the image will be affected by the transformation.
promptYesstringText description of the transformations to apply to the image.
modelYesstringThe version of the model to use for processing. Example: V_2.

Example Request

POST https://gateway.pixazo.ai/ideogramV_2/v1/edit
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY
Content-Type: multipart/form-data

--boundary
Content-Disposition: form-data; name="image_file"; filename="image.png"
Content-Type: image/png

[File content]
--boundary
Content-Disposition: form-data; name="mask"; filename="mask.png"
Content-Type: image/png

[File content]
--boundary
Content-Disposition: form-data; name="prompt"
Content-Type: text/plain

Enhance brightness and remove text
--boundary
Content-Disposition: form-data; name="model"
Content-Type: text/plain

V_2
--boundary--

Response

{
  "created": "2024-11-01T10:06:14.744267+00:00",
  "data": [
    {
      "is_image_safe": true,
      "prompt": "Enhance brightness and remove text",
      "original_image": "url_to_original_image",
      "edited_image": "https://ideogram.ai/api/images/ephemeral/iSkGI5XfQ-ObReWhAiw_iA.png?exp=1730547982&sig=dabe41c3e4caa3ef788f32acc842cccfb2816686aab3e1a35d69d9139183fdc7",
      "model_used": "V_2"
    }
  ]
}

Request Headers

Header Value
Ocp-Apim-Subscription-KeyYOUR_SUBSCRIPTION_KEY
Content-Typemultipart/form-data

Response Handling

Common status codes for Edit Image.

Code Meaning
200 Success
Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
Too Many Requests
500 Internal Server Error

Ideogram v2 Image to Image (Image Editing) API Pricing

ResolutionPrice (USD)
All Resolution$0.2

Ideogram v2 Image to Image (Image Editing — Remix) API Documentation

Request Code

POST https://gateway.pixazo.ai/ideogramV_2/v1/remix
Ocp-Apim-Subscription-Key: YOUR_Subscription_KEY
Content-Type: multipart/form-data

--boundary
Content-Disposition: form-data; name="image_request"

{"prompt":"A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.","aspect_ratio":"ASPECT_10_16","image_weight":50,"magic_prompt_option":"ON","model":"V_2"}
--boundary
Content-Disposition: form-data; name="image_file"; filename="image.png"
Content-Type: image/png

[Binary image data]
--boundary--
import requests

url = "https://gateway.pixazo.ai/ideogramV_2/v1/remix"
headers = {
    "Ocp-Apim-Subscription-Key": "YOUR_Subscription_KEY"
}

files = {
    "image_request": (None, '{"prompt":"A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.","aspect_ratio":"ASPECT_10_16","image_weight":50,"magic_prompt_option":"ON","model":"V_2"}'),
    "image_file": ("image.png", open("/path/to/your/image.png", "rb"), "image/png")
}

response = requests.post(url, headers=headers, files=files)
print(response.json())
const formData = new FormData();
formData.append('image_request', '{"prompt":"A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.","aspect_ratio":"ASPECT_10_16","image_weight":50,"magic_prompt_option":"ON","model":"V_2"}');
formData.append('image_file', document.getElementById('imageInput').files[0]);

fetch('https://gateway.pixazo.ai/ideogramV_2/v1/remix', {
  method: 'POST',
  headers: {
    'Ocp-Apim-Subscription-Key': 'YOUR_Subscription_KEY'
  },
  body: formData
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
curl -X POST "https://gateway.pixazo.ai/ideogramV_2/v1/remix" \
-H "Ocp-Apim-Subscription-Key: YOUR_Subscription_KEY" \
-H "Content-Type: multipart/form-data" \
--form 'image_request={
  "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
  "aspect_ratio": "ASPECT_10_16",
  "image_weight": 50,
  "magic_prompt_option": "ON",
  "model": "V_2"
}' \
--form 'image_file=@/path/to/your/image.png'

Output

{
  "created": "2024-11-01T10:06:14.744267+00:00",
  "data": [
    {
      "is_image_safe": true,
      "prompt": "A serene tropical beach scene...",
      "resolution": "800x1280",
      "image_url": "https://ideogram.ai/api/images/ephemeral/iSkGI5XfQ-ObReWhAiw_iA.png?exp=1730547982&sig=dabe41c3e4caa3ef788f32acc842cccfb2816686aab3e1a35d69d9139183fdc7"
    }
  ]
}

Request Parameters - Remix Image

Parameter Required Type Description
image_requestYesJSONA JSON string that includes details like prompt, aspect ratio, image weight, and model.
image_fileYesFileThe image file to be remixed with the textual description provided in `image_request`.

Example Request

{
  "image_request": "{\n  \"prompt\": \"A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.\",\n  \"aspect_ratio\": \"ASPECT_10_16\",\n  \"image_weight\": 50,\n  \"magic_prompt_option\": \"ON\",\n  \"model\": \"V_2\"\n}",
  "image_file": "[binary data]"
}

Response

{
  "created": "2024-11-01T10:06:14.744267+00:00",
  "data": [
    {
      "is_image_safe": true,
      "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
      "resolution": "800x1280",
      "image_weight": 50,
      "image_url": "https://ideogram.ai/api/images/ephemeral/iSkGI5XfQ-ObReWhAiw_iA.png?exp=1730547982&sig=dabe41c3e4caa3ef788f32acc842cccfb2816686aab3e1a35d69d9139183fdc7",
      "model_used": "V_2"
    }
  ]
}

Request Headers

Header Value
Ocp-Apim-Subscription-KeyYOUR_Subscription_KEY
Content-Typemultipart/form-data

Response Handling

Common status codes for Remix Image.

Code Meaning
200 Success
Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
Too Many Requests
500 Internal Server Error

Ideogram v2 Image to Image (Image Editing — Remix) API Pricing

ResolutionPrice (USD)
All Resolution$0.2
2. Ideogram Turbo

Ideogram Turbo Text to Image API Documentation

Request Code

POST https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/generate
Content-Type: application/json
Cache-Control: no-cache
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY

{
    "image_request": {
        "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
        "negative_prompt": "blur",
        "model": "V_2_TURBO",
        "aspect_ratio": "ASPECT_10_16",
        "magic_prompt_option": "AUTO",
        "seed": 212,
        "style_type": "AUTO",
        "color_palette": {
            "name": "JUNGLE"
        }
    }
}
import requests

url = "https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/generate"
headers = {
    "Content-Type": "application/json",
    "Cache-Control": "no-cache",
    "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}
data = {
    "image_request": {
        "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
        "negative_prompt": "blur",
        "model": "V_2_TURBO",
        "aspect_ratio": "ASPECT_10_16",
        "magic_prompt_option": "AUTO",
        "seed": 212,
        "style_type": "AUTO",
        "color_palette": {
            "name": "JUNGLE"
        }
    }
}

response = requests.post(url, json=data, headers=headers)
print(response.json())
const url = 'https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/generate';
const headers = {
  'Content-Type': 'application/json',
  'Cache-Control': 'no-cache',
  'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
};
const data = {
  image_request: {
    prompt: 'A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.',
    negative_prompt: 'blur',
    model: 'V_2_TURBO',
    aspect_ratio: 'ASPECT_10_16',
    magic_prompt_option: 'AUTO',
    seed: 212,
    style_type: 'AUTO',
    color_palette: {
      name: 'JUNGLE'
    }
  }
};

fetch(url, {
  method: 'POST',
  headers: headers,
  body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
curl -v -X POST "https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/generate" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--data-raw '{
    "image_request": {
        "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
        "negative_prompt": "blur",
        "model": "V_2_TURBO",
        "aspect_ratio": "ASPECT_10_16",
        "magic_prompt_option": "AUTO",
        "seed": 212,
        "style_type": "AUTO",
        "color_palette": {
            "name": "JUNGLE"
        }
    }
}'

Output

{
  "created": "2024-11-01T10:06:14.744267+00:00",
  "data": [
    {
      "is_image_safe": true,
      "prompt": "A serene tropical beach scene...",
      "resolution": "800x1280",
      "url": "https://ideogram.ai/api/images/ephemeral/4p6cIwykSjaWcUUavtwuMw.png?exp=1730541994&sig=ef2b2872a29327783454a41061d1e890361cb6a5c77c358c6190793095428b59"
    }
  ]
}

Request Parameters - Create Image

Parameter Required Type Description
promptYesstringText describing the scene or image to be generated.
negative_promptNostringSpecifies elements or features to avoid in the image generation.
modelYesstringThe version of the model to use. Currently supported value: V_2_TURBO.
aspect_ratioNoenumDetermines the image resolution. Default: ASPECT_1_1. Other values: ASPECT_10_16, ASPECT_16_10, ASPECT_9_16, ASPECT_16_9, ASPECT_3_2, ASPECT_2_3, ASPECT_4_3, ASPECT_3_4, ASPECT_1_1, ASPECT_1_3, ASPECT_3_1
seedNointegerProvides a random seed for reproducibility. Allowed range: 1 to 9999999999.
magic_prompt_optionNoenumControls use of MagicPrompt. Default: AUTO. Other values: ON, OFF.
style_typeNoenumSpecifies the style type for the image. Default: AUTO. Other values include GENERAL, REALISTIC, DESIGN, RENDER_3D, ANIME
color_paletteNoobjectDefines a color palette using a preset name. Available presets: EMBER, FRESH, JUNGLE, MAGIC, MELON, MOSAIC, PASTEL, ULTRAMARINE

Example Request

{
    "image_request": {
        "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
        "negative_prompt": "blur",
        "model": "V_2_TURBO",
        "aspect_ratio": "ASPECT_10_16",
        "magic_prompt_option": "AUTO",
        "seed": 212,
        "style_type": "AUTO",
        "color_palette": {
            "name": "JUNGLE"
        }
    }
}

Response

{
    "created": "2024-11-01T10:06:14.744267+00:00",
    "data": [
        {
            "is_image_safe": true,
            "prompt": "A serene tropical beach scene with tall palm trees, a sandy beach, and azure waters...",
            "resolution": "800x1280",
            "seed": 212,
            "style_type": "REALISTIC",
            "url": "https://ideogram.ai/api/images/ephemeral/4p6cIwykSjaWcUUavtwuMw.png?exp=1730541994&sig=ef2b2872a29327783454a41061d1e890361cb6a5c77c358c6190793095428b59"
        }
    ]
}

Request Headers

Header Value
Content-Typeapplication/json
Cache-Controlno-cache
Ocp-Apim-Subscription-KeyYOUR_SUBSCRIPTION_KEY

Response Handling

Common status codes for Create Image.

Code Meaning
200 Success
Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
Too Many Requests
500 Internal Server Error

Ideogram Turbo Text to Image API Pricing

ResolutionPrice (USD)
All Resolution$0.2

Ideogram Turbo Utility (Image to Text — Captioning) API Documentation

Request Code

POST https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/describe
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY
Content-Type: multipart/form-data

import requests

url = "https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/describe"
headers = {
    "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}

with open("/path/to/your/image.png", "rb") as image_file:
    files = {"image_file": image_file}
    response = requests.post(url, headers=headers, files=files)

print(response.json())
const formData = new FormData();
formData.append('image_file', fileInput.files[0]);

fetch('https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/describe', {
  method: 'POST',
  headers: {
    'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
  },
  body: formData
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
curl -X POST "https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/describe" \
-H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
-H "Content-Type: multipart/form-data" \
--form 'image_file=@/path/to/your/image.png'

Output

{
  "created": "2024-11-01T10:06:14.744267+00:00",
  "data": {
    "description": "The image depicts a serene tropical beach scene..."
  }
}

Request Parameters - Describe Image

Parameter Required Type Description
image_fileYesFileThe image file for which a description is needed.

Example Request

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="image_file"; filename="image.png"
Content-Type: image/png

<binary image data>
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Response

{
  "created": "2024-11-01T10:06:14.744267+00:00",
  "data": {
    "description": "The image depicts a serene tropical beach scene with tall palm trees and azure waters."
  }
}

Request Headers

Header Value
Ocp-Apim-Subscription-KeyYOUR_SUBSCRIPTION_KEY
Content-Typemultipart/form-data

Response Handling

Common status codes for Describe Image.

Code Meaning
200 Success
Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
Too Many Requests
500 Internal Server Error

Ideogram Turbo Utility (Image to Text — Captioning) API Pricing

ResolutionPrice (USD)
All Resolution$0.2

Ideogram Turbo Image to Image (Image Editing) API Documentation

Request Code

POST https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/edit
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY
Content-Type: multipart/form-data

[form data]
import requests

url = "https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/edit"
headers = {
    "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}

files = {
    "image_file": open("image.png", "rb"),
    "mask": open("mask.png", "rb"),
    "prompt": (None, "Enhance brightness and remove text"),
    "model": (None, "V_2")
}

response = requests.post(url, headers=headers, files=files)
print(response.json())
const formData = new FormData();
formData.append('image_file', imageFileInput.files[0]);
formData.append('mask', maskFileInput.files[0]);
formData.append('prompt', 'Enhance brightness and remove text');
formData.append('model', 'V_2');

fetch('https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/edit', {
  method: 'POST',
  headers: {
    'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
  },
  body: formData
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
curl -X POST "https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/edit" \
-H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
-H "Content-Type: multipart/form-data" \
--form 'image_file=@/path/to/your/image.png' \
--form 'mask=@/path/to/your/mask.png' \
--form 'prompt="Enhance brightness and remove text"' \
--form 'model="V_2"'

Output

{
  "created": "2024-11-01T11:46:02.294543+00:00",
  "data": [
    {
      "is_image_safe": true,
      "prompt": "replace some text",
      "url": "https://ideogram.ai/api/images/ephemeral/...png"
    }
  ]
}

Request Parameters - Edit Image

Parameter Required Type Description
image_fileYesFileThe image file to be edited.
maskNoFileA mask file that determines which parts of the image will be affected by the transformation.
promptYesstringText description of the transformations to apply to the image.
modelYesstringThe version of the model to use for processing. Example: V_2.

Example Request

{}

Response

{
  "created": "2024-11-01T11:46:02.294543+00:00",
  "data": [
    {
      "is_image_safe": true,
      "prompt": "replace some text",
      "resolution": "1216x704",
      "seed": 875575135,
      "style_type": "GENERAL",
      "url": "https://ideogram.ai/api/images/ephemeral/iSkGI5XfQ-ObReWhAiw_iA.png?exp=1730547982&sig=dabe41c3e4caa3ef788f32acc842cccfb2816686aab3e1a35d69d9139183fdc7"
    }
  ]
}

Request Headers

Header Value
Ocp-Apim-Subscription-KeyYOUR_SUBSCRIPTION_KEY
Content-Typemultipart/form-data

Response Handling

Common status codes for Edit Image.

Code Meaning
200 Success
Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
Too Many Requests
500 Internal Server Error

Ideogram Turbo Image to Image (Image Editing) API Pricing

ResolutionPrice (USD)
All Resolution$0.2

Ideogram Turbo Image to Image (Image Editing — Remix) API Documentation

Request Code

POST https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/remix
Ocp-Apim-Subscription-Key: YOUR_Subscription_KEY
Content-Type: multipart/form-data

--boundary
Content-Disposition: form-data; name="image_request"

{"prompt":"A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.","aspect_ratio":"ASPECT_10_16","image_weight":50,"magic_prompt_option":"ON","model":"V_2_TURBO"}
--boundary
Content-Disposition: form-data; name="image_file"; filename="image.png"
Content-Type: image/png

[binary data]
--boundary--
import requests

url = "https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/remix"
headers = {
    "Ocp-Apim-Subscription-Key": "YOUR_Subscription_KEY"
}

files = {
    "image_request": (None, '{"prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.", "aspect_ratio": "ASPECT_10_16", "image_weight": 50, "magic_prompt_option": "ON", "model": "V_2_TURBO"}'),
    "image_file": ("image.png", open("/path/to/your/image.png", "rb"), "image/png")
}

response = requests.post(url, headers=headers, files=files)
print(response.json())
const formData = new FormData();
formData.append('image_request', JSON.stringify({
  prompt: "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
  aspect_ratio: "ASPECT_10_16",
  image_weight: 50,
  magic_prompt_option: "ON",
  model: "V_2_TURBO"
}));
formData.append('image_file', document.getElementById('imageInput').files[0]);

fetch('https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/remix', {
  method: 'POST',
  headers: {
    'Ocp-Apim-Subscription-Key': 'YOUR_Subscription_KEY'
  },
  body: formData
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
curl -X POST "https://gateway.pixazo.ai/ideogramV_2_Turbo/v1/remix" \
-H "Ocp-Apim-Subscription-Key: YOUR_Subscription_KEY" \
-H "Content-Type: multipart/form-data" \
--form 'image_request={
  "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
  "aspect_ratio": "ASPECT_10_16",
  "image_weight": 50,
  "magic_prompt_option": "ON",
  "model": "V_2_TURBO"
}' \
--form 'image_file=@/path/to/your/image.png'

Output

{
  "created": "2000-01-23T04:56:07Z",
  "data": [
    {
      "prompt": "A serene tropical beach scene...",
      "resolution": "1024x1024",
      "is_image_safe": true,
      "url": "https://ideogram.ai/api/images/direct/8YEpFzHuS-S6xXEGmCsf7g"
    }
  ]
}

Request Parameters - Remix Image

Parameter Required Type Description
image_request Yes JSON A JSON string that includes details like prompt, aspect ratio, image weight, and model.
image_file Yes File The image file to be remixed with the textual description provided in `image_request`.

Example Request

{
  "image_request": "{\"prompt\": \"A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there is an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.\", \"aspect_ratio\": \"ASPECT_10_16\", \"image_weight\": 50, \"magic_prompt_option\": \"ON\", \"model\": \"V_2_TURBO\"}",
  "image_file": "[binary image data]"
}

Response

{
  "created": "2000-01-23T04:56:07Z",
  "data": [
    {
      "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there's an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
      "resolution": "1024x1024",
      "is_image_safe": true,
      "seed": 12345,
      "url": "https://ideogram.ai/api/images/direct/8YEpFzHuS-S6xXEGmCsf7g",
      "style_type": "REALISTIC"
    }
  ]
}

Request Headers

Header Value
Ocp-Apim-Subscription-Key YOUR_Subscription_KEY
Content-Type multipart/form-data

Response Handling

Common status codes for Remix Image.

Code Meaning
200 Success
Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
Too Many Requests
500 Internal Server Error

Ideogram Turbo Image to Image (Image Editing — Remix) API Pricing

ResolutionPrice (USD)
All Resolution$0.2