How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ideogram subpackage_generate API

The subpackage_generate API from Ideogram — 15 operation(s) for subpackage_generate.

Ideogram subpackage_generate API is one of 4 APIs that Ideogram publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and pricing.

This API exposes 15 operations across 15 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.ideogram.ai.

15 operations 15 paths 35 schemas 15 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.ideogram.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ideogram subpackage_generate API declares 1 security scheme for authenticating requests. An API key is passed in the header as Api-Key (ApiKeyAuth).

  • ApiKeyAuth — API key for access control. Use in the header with the name \"Api-Key\"

Paths & Operations 15

Across 15 paths, the API surfaces 15 operations — 15 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_generate 15
POST
/v1/ideogram-v3/generate
Generate with Ideogram 3.0
post-generate-image-v-3 1 param body → 200400401422429
POST
/v1/ideogram-v3/generate-transparent
Generate with Ideogram 3.0 (Transparent Background)
post-generate-image-v-3-transparent 1 param body → 200400401422429
POST
/v1/ideogram-v3/inpaint
Inpaint with Ideogram 3.0
post-inpaint-image-v-3 1 param body → 200400401422429
POST
/v1/ideogram-v3/remix
Remix with Ideogram 3.0
post-remix-image-v-3 1 param body → 200400403422429
POST
/v1/ideogram-v3/reframe
Reframe with Ideogram 3.0
post-reframe-image-v-3 1 param body → 200400401422429
POST
/v1/ideogram-v3/replace-background
Replace Background with Ideogram 3.0
post-replace-background-v-3 1 param body → 200400401422429
POST
/v1/remove-background
Remove Background
post-remove-background 1 param body → 200400401422429
POST
/v1/ideogram-v3/layerize-text
Layerize Text
post-layerize-text-v-3 1 param body → 200400401429
POST
/v1/edit
Edit images with a prompt
post-v-1-edit-image 1 param body → 200400401402422429503
POST
/upscale
Upscale
post-upscale-image 1 param body → 200400403422429
POST
/generate
Generate (legacy)
post-generate-image 1 param body → 200400401422429
POST
/v1/ideogram-v3/edit
Edit with Ideogram 3.0 (legacy)
post-edit-image-v-3 1 param body → 200400401422429
POST
/edit
Edit (legacy)
post-edit-image 1 param body → 200400401422429
POST
/remix
Remix (legacy)
post-remix-image 1 param body → 200400403422429
POST
/reframe
Reframe (legacy)
post-reframe-image 1 param body → 200400401422429

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are InitialImageRequest (11 properties), ImageRequest (10 properties), ImageGenerationObjectV3 (7 properties), ImageObject (7 properties). Each schema is shown below with its type and property counts.

RemoveBackgroundImageObject
object
2 properties 1 required
LayerizeTextResponse
object
The response containing detected text blocks and a text-erased base image. Image links are available for a limited period of time; if you would like to keep th…
3 properties 2 required
StyleType
string
The style type to generate with; this is only applicable for models V2 and above and should not be specified for model versions V1.
RenderingSpeed
string
The rendering speed to use.
MagicPromptOption
string
Determine if MagicPrompt should be used in generating the request or not.
V1IdeogramV3GenerateTransparentPostRequestBodyContentMultipartFormDataSchemaRenderingSpeed
string
The rendering speed to use. FLASH is not supported for transparent-background generation; requests with renderingspeed=FLASH will return a 400.
ImageGenerationResponseV3
object
The response which contains information about the generated image, including the download link. Images links are available for a limited period of time; if you…
2 properties 2 required
V1EditImagesResponse
object
The response which contains information about the edited image, including the download link. Images links are available for a limited period of time; if you wo…
2 properties 2 required
ColorPalettePresetName
string
A color palette preset value.
UpscaleFactor
string
Upscale the initially generated image by the given factor. Upscale factors other than X1 will incur additional cost.
ResolutionV3
string
The resolutions supported for Ideogram 3.0.
NumImages
integer
The number of images to generate.
AspectRatioV3
string
The aspect ratio to use for image generation, which determines the image's resolution. Cannot be used in conjunction with resolution. Defaults to 1x1.
GenerateImageSafetyError
object
1 property 1 required
ColorPaletteMember
object
A member of a color palette.
2 properties 1 required
GenerateImageResponse
object
The response which contains information about the generated image, including the download link. Images links are available for a limited period of time; if you…
2 properties 2 required
ColorPaletteWithPresetNameOrMembers
A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional…
ColorPaletteWithMembers
object
A color palette represented only via its members. Cannot be used in conjunction with preset name.
1 property 1 required
InitialImageRequest
object
A request to generate a new image using a provided image and a prompt.
11 properties 1 required
UpscaleInitialImageRequest
object
A request to upscale a provided image with the help of an optional prompt.
6 properties
ImageRequest
object
10 properties 1 required
ColorPaletteWithPresetName
object
1 property 1 required
StyleCodes
array
A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with stylereferenceimages or styletype.
ImageGenerationObjectV3
object
7 properties 4 required
GenerateImageRequest
object
1 property 1 required
StyleTypeV3
string
The style type to generate with.
ImageObject
object
7 properties 4 required
Resolution
string
(For modelversion for 2.0 only, cannot be used in conjunction with aspectratio) The resolution to use for image generation, represented in width x height. If n…
V1EditImageObject
object
7 properties 4 required
StyleCode
string
The 8 character hexadecimal representation of the style code.
AspectRatio
string
(Cannot be used in conjunction with resolution) The aspect ratio to use for image generation, which determines the image's resolution. Defaults to ASPECT11.
RemoveBackgroundResponse
object
The response containing the foreground image with the background removed. Image links are available for a limited period of time; if you would like to keep the…
2 properties 2 required
Seed
integer
Random seed. Set for reproducible generation.
ModelEnum
string
The model used to generate an image or edit one. /generate and /remix supports all model types, however, /edit is only supported for V2 and V2TURBO.
StylePresetV3
string
A predefined style preset that applies a specific artistic style to the generated image.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ideogram-subpackage-generate-api-openapi.yml Raw ↑

Other APIs Ideogram publishes across the network.

Ideogram subpackage_datasets API
Ideogram subpackage_models API
Ideogram subpackage_vision API
Where this information came from

This is an independent, third-party profile of Ideogram subpackage_generate API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.