Ideogram subpackage_generate API is one of 4 APIs that Ideogram publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include subpackage_generate. 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.1.0, at version 1.0.0.
Requests are made against a single base URL, https://api.ideogram.ai.
15 operations15 paths35 schemas15 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.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.
The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are InitialImageRequest (11 properties), ImageRequest (10 properties), V1EditImageObject (7 properties), ImageGenerationObjectV3 (7 properties). Each schema is shown below with its type and property counts.
The rendering speed to use. FLASH is not supported for transparent-background generation; requests with renderingspeed=FLASH will return a 400.
UpscaleInitialImageRequest
object
A request to upscale a provided image with the help of an optional prompt.
6 properties
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 properties2 required
ImageObject
object
7 properties4 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 properties2 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…
MagicPromptOption
string
Determine if MagicPrompt should be used in generating the request or not.
ImageGenerationObjectV3
object
7 properties4 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 properties2 required
ColorPaletteWithPresetName
object
1 property1 required
GenerateImageSafetyError
object
1 property1 required
Seed
integer
Random seed. Set for reproducible generation.
StylePresetV3
string
A predefined style preset that applies a specific artistic style to the generated image.
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.
GenerateImageRequest
object
1 property1 required
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.
RemoveBackgroundImageObject
object
2 properties1 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…
ColorPaletteMember
object
A member of a color palette.
2 properties1 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.
ResolutionV3
string
The resolutions supported for Ideogram 3.0.
InitialImageRequest
object
A request to generate a new image using a provided image and a prompt.
11 properties1 required
StyleTypeV3
string
The style type to generate with.
ColorPaletteWithMembers
object
A color palette represented only via its members. Cannot be used in conjunction with preset name.
1 property1 required
V1EditImageObject
object
7 properties4 required
RenderingSpeed
string
The rendering speed to use.
ColorPalettePresetName
string
A color palette preset value.
ImageRequest
object
10 properties1 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.
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 properties2 required
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 properties2 required
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.
UpscaleFactor
string
Upscale the initially generated image by the given factor. Upscale factors other than X1 will incur additional cost.
StyleCode
string
The 8 character hexadecimal representation of the style code.
Specification
The full machine-readable OpenAPI contract behind this narrative.
