For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Manage API keysIdeogram
  • Ideogram API
    • API Overview
    • API Setup
    • Account API Page
    • API Pricing
    • API Status
  • Tutorials
    • Custom Model Training
  • API Reference
    • POSTGenerate with Ideogram 4.0
    • POSTRemix with Ideogram 4.0
    • POSTGenerate a Magic Prompt with Ideogram 4.0
    • POSTDescribe with Ideogram 4.0
    • POSTGenerate with Ideogram 3.0
    • POSTGenerate with Ideogram 3.0 (Transparent Background)
    • POSTInpaint with Ideogram 3.0
    • POSTRemix with Ideogram 3.0
    • POSTReframe with Ideogram 3.0
    • POSTReplace Background with Ideogram 3.0
    • POSTRemove Background
    • POSTLayerize Text
    • POSTEdit images with a prompt
    • POSTUpscale
    • POSTDescribe
    • POSTGenerate (legacy)
    • POSTEdit with Ideogram 3.0 (legacy)
    • POSTEdit (legacy)
    • POSTRemix (legacy)
    • POSTReframe (legacy)
  • Custom Model Training
    • GETList datasets
    • POSTCreate a new dataset
    • GETGet a dataset
    • POSTUpload assets to a dataset
    • POSTTrain a custom Ideogram v3 model
    • GETList models
    • GETGet model details
LogoLogo
LogoLogo
Manage API keysIdeogram
API Reference

Remix with Ideogram 4.0

POST
https://api.ideogram.ai/v1/ideogram-v4/remix
POST
/v1/ideogram-v4/remix
$curl -X POST https://api.ideogram.ai/v1/ideogram-v4/remix \
>     -H "Api-Key: <apiKey>" \
>     -H "Content-Type: multipart/form-data" \
>     -F image=@string \
>     -F text_prompt="A photo of a cat"
1{
2  "created": "2000-01-23 04:56:07+00:00",
3  "data": [
4    {
5      "prompt": "prompt",
6      "resolution": "2048x2048",
7      "is_image_safe": true,
8      "seed": 12345,
9      "url": "https://ideogram.ai/api/images/ephemeral/xtdZiqPwRxqY1Y7NExFmzB.png?exp=1743867804&sig=e13e12677633f646d8531a153d20e2d3698dca9ee7661ee5ba4f3b64e7ec3f89"
10    },
11    {
12      "prompt": "prompt",
13      "resolution": "2048x2048",
14      "is_image_safe": true,
15      "seed": 12345,
16      "url": "https://ideogram.ai/api/images/ephemeral/xtdZiqPwRxqY1Y7NExFmzB.png?exp=1743867804&sig=e13e12677633f646d8531a153d20e2d3698dca9ee7661ee5ba4f3b64e7ec3f89"
17    }
18  ],
19  "response_type": "url"
20}
Remix an image synchronously using the Ideogram 4.0 model with an initial image and a prompt. Mirrors `/v1/ideogram-v3/remix` semantics (including `image_weight` for how strongly the output should resemble the input image) but routes the request through the V_4_0 model. Images links are available for a limited period of time; if you would like to keep the image, you must download it.
Was this page helpful?
Previous

Generate a Magic Prompt with Ideogram 4.0

Next
Built with

Remix an image synchronously using the Ideogram 4.0 model with an initial image and a prompt.

Mirrors /v1/ideogram-v3/remix semantics (including image_weight for how strongly the output should resemble the input image) but routes the request through the V_4_0 model.

Images links are available for a limited period of time; if you would like to keep the image, you must download it.

Authentication

Api-Keystring

API key for access control. Use in the header with the name “Api-Key”

Request

A request to remix an image with Ideogram 4.0.
imagefileRequired

The initial image binary (max 10MB); only JPEG, WebP and PNG formats are supported.

text_promptstringRequired
The text prompt that guides the remix.
image_weightintegerOptional1-100

Optional. How strongly the output should resemble the input image. Higher values keep the input image’s structure; lower values allow the prompt to drive the output more. When omitted, the weight is chosen automatically from the edit instruction; supplying a value overrides that automatic choice.

resolutionenumOptional
The 2K resolutions supported for Ideogram 4.0 image generation.
rendering_speedenumOptionalDefaults to DEFAULT
The rendering speed to use.
Allowed values:
enable_copyright_detectionboolean or nullOptional

Optional. Opt this request into post-generation copyright detection (Hive likeness + logo checks). See GenerateImageRequestV3 for details.

Response

Image(s) generated successfully.

createddatetime
The time the request was created.
datalist of objects

A list of ImageObjects that contain the generated image(s).

response_typeenum
Discriminator for the postGenerateDesignV4 oneOf response. Always "url" for this shape.
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
429
Too Many Requests Error