# Ideogram AI API

> Provider: **Ideogram**
> Source: https://www.pixazo.ai/models/ideogram

Advanced image generation with text rendering capabilities.

## Ideogram Remove Background

### Image to Image (Image Background Removal)

## Base URL

```
https://gateway.pixazo.ai/ideogram-remove-background/v1
```

## Authentication

All requests require an API key passed via header.

Header

Type

Required

Description

Ocp-Apim-Subscription-Key

string

Yes

Your API subscription key

## Ideogram Remove Background generate request - Ideogram Remove Background

## Request Code

HTTP Python JavaScript cURL

```
POST https://gateway.pixazo.ai/ideogram-remove-background/v1/ideogram-remove-background-request
Content-Type: application/json
Cache-Control: no-cache
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY

{
  "image_url": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Image.jpeg"
}
```

```
import requests

url = "https://gateway.pixazo.ai/ideogram-remove-background/v1/ideogram-remove-background-request"
headers = {
    "Content-Type": "application/json",
    "Cache-Control": "no-cache",
    "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}
data = {
    "image_url": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Image.jpeg"
}

response = requests.post(url, json=data, headers=headers)
print(response.json())
```

```
fetch('https://gateway.pixazo.ai/ideogram-remove-background/v1/ideogram-remove-background-request', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Cache-Control': 'no-cache',
    'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
  },
  body: JSON.stringify({
    image_url: 'https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Image.jpeg'
  })
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

```
curl -X POST "https://gateway.pixazo.ai/ideogram-remove-background/v1/ideogram-remove-background-request" \
  -H "Content-Type: application/json" \
  -H "Cache-Control: no-cache" \
  -H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
  --data-raw '{
    "image_url": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Image.jpeg"
  }'
```

## Output

```
{
  "images": [
    {
      "file_name": "nano-banana-pro-edit-output.png",
      "content_type": "image/png",
      "url": "[RESPONSE_URL]"
    }
  ],
  "description": ""
}
```

[Try Now](https://api.pixazo.ai/api-details#api=ideogram-remove-background&operation=ideogram-remove-background-request)

## Request Parameters - Ideogram Remove Background generate request

Field

Type

Required

Default

Description

image\_url

string

Yes

—

Source image URL. Supported formats: JPEG, PNG, WebP. Max file size 10MB.

sync\_mode

boolean

No

false

If true, returns the result as a data URI inline instead of storing it in request history.

## Minimum Request

```
{
  "image_url": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Image.jpeg"
}
```

## Full Request (all options)

```
{
  "image_url": "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/Image.jpeg",
  "sync_mode": false
}
```

## Response

```
{
  "request_id": "ideogram-remove-background_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "QUEUED",
  "polling_url": "https://gateway.pixazo.ai/v2/requests/status/ideogram-remove-background_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```

## Response Fields - Ideogram Remove Background generate request

Field

Type

Description

request\_id

string

Unique identifier for the job submission.

status

string

Current status of the request (QUEUED, PROCESSING, etc.).

polling\_url

string

URL to use for checking the job status.

## Request Headers

Header

Value

Content-Type

application/json

Cache-Control

no-cache

Ocp-Apim-Subscription-Key

Your subscription key

## Response Handling

Common status codes for Ideogram Remove Background generate request.

Code

Meaning

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

## Error Responses

### 400: Bad Request

```
{
  "error": "Invalid image_url",
  "message": "The provided image_url is malformed or unreachable."
}
```

### 401: Unauthorized

```
{
  "error": "Unauthorized",
  "message": "Missing or invalid Ocp-Apim-Subscription-Key header."
}
```

## Status Workflow

Check status of your request using the polling\_url returned in the response.

### Status Values

Status

Description

QUEUED

Request accepted, waiting to be processed

PROCESSING

Being processed by the model

COMPLETED

Done — output contains the result

FAILED

Failed — check error field

ERROR

System error — not charged

### Status Flow

```
Submitted
    ↓
  QUEUED
    ↓
PROCESSING
    ↓
COMPLETED or FAILED or ERROR
```

### Typical Workflow

1.  Submit request to /ideogram-remove-background-request
2.  Receive response with request\_id and polling\_url
3.  Make GET requests to polling\_url every 2–3 seconds
4.  When status is COMPLETED, extract output from the response
5.  Handle FAILED or ERROR states as appropriate

## Ideogram Remove Background check status - Ideogram Remove Background

## Request Code

HTTP Python JavaScript cURL

```
POST https://gateway.pixazo.ai/v2/requests/status/ideogram-remove-background_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY
```

```
import requests

url = "https://gateway.pixazo.ai/v2/requests/status/ideogram-remove-background_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
headers = {
    "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())
```

```
fetch('https://gateway.pixazo.ai/v2/requests/status/ideogram-remove-background_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', {
  method: 'GET',
  headers: {
    'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

```
curl -H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
  "https://gateway.pixazo.ai/v2/requests/status/ideogram-remove-background_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
```

## Output

```
{
  "images": [
    {
      "file_name": "nano-banana-pro-edit-output.png",
      "content_type": "image/png",
      "url": "[RESPONSE_URL]"
    }
  ],
  "description": ""
}
```

[Try Now](https://api.pixazo.ai/api-details#api=ideogram-remove-background&operation=ideogram-remove-background-request-result)

## Request Parameters - Ideogram Remove Background check status

Field

Type

Required

Default

Description

request\_id

string

Yes

—

The unique request ID returned from the initial submission endpoint.

## Minimum Request

```
{
  "request_id": "ideogram-remove-background_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```

## Full Request (all options)

```
{
  "request_id": "ideogram-remove-background_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```

## Response

```
{
  "request_id": "ideogram-remove-background_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "COMPLETED",
  "model_id": "ideogram-remove-background",
  "error": null,
  "output": {
    "media_url": ["https://pub-582b7213209642b9b995c96c95a30381.r2.dev/v1/ideogram-remove-background_019dxxxx/output.png"],
    "media_type": "image/png"
  },
  "created_at": "2026-03-31T10:00:00.000Z",
  "updated_at": "2026-03-31T10:00:15.000Z",
  "completed_at": "2026-03-31T10:00:15.000Z"
}
```

## Response Fields - Ideogram Remove Background check status

Field

Type

Description

request\_id

string

Unique identifier for the request.

status

string

Current status of the job (QUEUED, PROCESSING, COMPLETED, FAILED, ERROR).

model\_id

string

The model used for processing.

error

null|string

null if successful, error details if failed.

output

object

Contains media\_url and media\_type for the generated result.

output.media\_url

array

Array of URLs pointing to the generated media.

output.media\_type

string

MIME type of the output (e.g., image/png).

created\_at

string

Timestamp when the request was received.

updated\_at

string

Timestamp when the request status was last updated.

completed\_at

string

Timestamp when the request was completed.

## Request Headers

Header

Value

Ocp-Apim-Subscription-Key

Your subscription key

## Response Handling

Common status codes for Ideogram Remove Background check status.

Code

Meaning

200

Success

400

Bad Request - Invalid request\_id

401

Unauthorized

404

Not Found - Request ID not found

429

Too Many Requests

500

Internal Server Error

## Notes & Tips

-   Pricing is $0.01 per request.
-   Use `sync_mode: true` if you need the output as a data URI directly in the submission response (not recommended for production).
-   Wait 2–3 seconds between polling requests for optimal performance.
-   Implement exponential backoff for retrying failed or system error responses.
-   Image must be under 10MB and in JPEG, PNG, or WebP format.
-   The output is always a transparent PNG, suitable for compositing.
-   Responses from the polling endpoint are not cached — each poll counts toward your usage limits.
-   Use the polling URL returned in the initial response — do not construct it manually.

## Ideogram v2

### Text to Image

## Create Image - Ideogram Generate API

## Request Code

HTTP Python JavaScript cURL

```
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"
    }
  ]
}
```

[Try Now](https://api.pixazo.ai/api-details#api=ideogram-generate&operation=get-image)

## Request Parameters - Create Image

Parameter

Required

Type

Description

prompt

Yes

string

Text describing the scene or image to be generated.

negative\_prompt

No

string

Specifies elements or features to avoid in the image generation.

model

Yes

string

The version of the model to use. Currently supported value: V\_2.

aspect\_ratio

No

enum

Determines 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

seed

No

integer

Provides a random seed for reproducibility. Allowed range: 1 to 9999999999.

magic\_prompt\_option

No

enum

Controls use of MagicPrompt. Default: AUTO. Other values: ON, OFF.

style\_type

No

enum

Specifies the style type for the image. Default: AUTO. Other values include GENERAL, REALISTIC, DESIGN, RENDER\_3D, ANIME

color\_palette

No

object

Defines 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-Type

application/json

Cache-Control

no-cache

Ocp-Apim-Subscription-Key

YOUR\_SUBSCRIPTION\_KEY

## Response Handling

Common status codes for Create Image.

Code

Meaning

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

### Utility (Image to Text — Captioning)

## Base URL

```
https://gateway.pixazo.ai/ideogram-generate/v1
```

## Describe Image - Ideogram Generate API

## Request Code

HTTP Python JavaScript cURL

```
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..."
  }
}
```

[Try Now](https://api.pixazo.ai/api-details#api=ideogram-generate&operation=describe-image)

## Request Parameters - Describe Image

Parameter

Required

Type

Description

image\_file

Yes

File

The 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-Key

YOUR\_SUBSCRIPTION\_KEY

Content-Type

multipart/form-data

## Response Handling

Common status codes for Describe Image.

Code

Meaning

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

### Image to Image (Image Editing)

## Edit Image - Ideogram Generate API

## Request Code

HTTP Python JavaScript cURL

```
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"
    }
  ]
}
```

[Try Now](https://api.pixazo.ai/api-details#api=ideogram-generate&operation=edit-image)

## Request Parameters - Edit Image

Parameter

Required

Type

Description

image\_file

Yes

File

The image file to be edited.

mask

No

File

A mask file that determines which parts of the image will be affected by the transformation.

prompt

Yes

string

Text description of the transformations to apply to the image.

model

Yes

string

The 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-Key

YOUR\_SUBSCRIPTION\_KEY

Content-Type

multipart/form-data

## Response Handling

Common status codes for Edit Image.

Code

Meaning

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

### Image to Image (Image Editing — Remix)

## Remix Image - Ideogram Generate API

## Request Code

HTTP Python JavaScript cURL

```
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"
    }
  ]
}
```

[Try Now](https://api.pixazo.ai/api-details#api=ideogram-generate&operation=remix-image)

## 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": "{\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-Key

YOUR\_Subscription\_KEY

Content-Type

multipart/form-data

## Response Handling

Common status codes for Remix Image.

Code

Meaning

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

## Ideogram Turbo

### Text to Image

## Create Image - IDEOGRAM IMAGE TURBO API

## Request Code

HTTP Python JavaScript cURL

```
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"
    }
  ]
}
```

[Try Now](https://api.pixazo.ai/api-details#api=ideogram-image-turbo&operation=create-image)

## Request Parameters - Create Image

Parameter

Required

Type

Description

prompt

Yes

string

Text describing the scene or image to be generated.

negative\_prompt

No

string

Specifies elements or features to avoid in the image generation.

model

Yes

string

The version of the model to use. Currently supported value: V\_2\_TURBO.

aspect\_ratio

No

enum

Determines 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

seed

No

integer

Provides a random seed for reproducibility. Allowed range: 1 to 9999999999.

magic\_prompt\_option

No

enum

Controls use of MagicPrompt. Default: AUTO. Other values: ON, OFF.

style\_type

No

enum

Specifies the style type for the image. Default: AUTO. Other values include GENERAL, REALISTIC, DESIGN, RENDER\_3D, ANIME

color\_palette

No

object

Defines 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-Type

application/json

Cache-Control

no-cache

Ocp-Apim-Subscription-Key

YOUR\_SUBSCRIPTION\_KEY

## Response Handling

Common status codes for Create Image.

Code

Meaning

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

### Utility (Image to Text — Captioning)

## Describe Image - Ideogram Image Turbo API

## Request Code

HTTP Python JavaScript cURL

```
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..."
  }
}
```

[Try Now](https://api.pixazo.ai/api-details#api=ideogram-image-turbo&operation=describe-image)

## Request Parameters - Describe Image

Parameter

Required

Type

Description

image\_file

Yes

File

The 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-Key

YOUR\_SUBSCRIPTION\_KEY

Content-Type

multipart/form-data

## Response Handling

Common status codes for Describe Image.

Code

Meaning

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

### Image to Image (Image Editing)

## Edit Image - Ideogram Image Turbo API

## Request Code

HTTP Python JavaScript cURL

```
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"
    }
  ]
}
```

[Try Now](https://api.pixazo.ai/api-details#api=ideogram-image-turbo&operation=edit-image)

## Request Parameters - Edit Image

Parameter

Required

Type

Description

image\_file

Yes

File

The image file to be edited.

mask

No

File

A mask file that determines which parts of the image will be affected by the transformation.

prompt

Yes

string

Text description of the transformations to apply to the image.

model

Yes

string

The 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-Key

YOUR\_SUBSCRIPTION\_KEY

Content-Type

multipart/form-data

## Response Handling

Common status codes for Edit Image.

Code

Meaning

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

### Image to Image (Image Editing — Remix)

## Remix Image - Ideogram Image Turbo API

## Request Code

HTTP Python JavaScript cURL

```
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"
    }
  ]
}
```

[Try Now](https://api.pixazo.ai/api-details#api=ideogram-image-turbo&operation=remix-image)

## 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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error