Generate images with Ideogram 2a from a text prompt
Generate one or more images from a text prompt with Ideogram 2a, a fast, lower-cost model, with an optional style type. Set rendering_speed to turbo for even faster generation.
By default the request blocks until the images are ready and returns them in data. Set async to true to return immediately after the request is accepted, then poll for completion and results with GET /v1/generations/{generation_id} using the returned generation_id.
Supplying a webhook_url makes the request asynchronous whatever async says: the response returns as soon as the request is accepted, and the finished result is POSTed to that URL.
Query parameters
When true, the request is validated and priced but not run: nothing is generated, stored, or billed, and no safety review is performed. The response is a PriceQuote object instead of the usual response for this endpoint. Send exactly the request you would send to generate, so the quote reflects the same options.
Request body
Example request
{
"magic_prompt": "",
"aspect_ratio": null,
"async": false,
"style_type": "realistic",
"private": true,
"seed": 12345,
"rendering_speed": "default",
"webhook_url": "https://api.example.com/webhooks/ideogram",
"enable_copyright_detection": true,
"target_collection_id": "target_collection_id",
"prompt": "prompt",
"num_images": 1
}Response
The generated images (synchronous requests), or an acknowledgement to poll with GET /v1/generations/{generation_id} (async requests).
Example response
{
"data": [
{
"seed": 12345,
"prompt": "prompt",
"resolution": "1024x1024",
"url": "https://openapi-generator.tech",
"is_image_safe": true
},
{
"seed": 12345,
"prompt": "prompt",
"resolution": "1024x1024",
"url": "https://openapi-generator.tech",
"is_image_safe": true
}
],
"seed": 12345,
"generation_id": "generation_id"
}Changes
Changed in 4 of the 33 revisions of this API.10117
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
- ○
added the new
autoenum value to the request propertyrequest-property-enum-value-added
- ○
- ▲
added to the
request propertyallOflistrequest-property-all-of-added
- ▲
removed the enum value
ANIMEof the request propertyrequest-property-enum-value-removed
- ▲
removed the enum value
AUTOof the request propertyrequest-property-enum-value-removed
- ▲
removed the enum value
DEFAULTof the request propertyrequest-property-enum-value-removed
- ▲
removed the enum value
DESIGNof the request propertyrequest-property-enum-value-removed
- ▲
removed the enum value
GENERALof the request propertyrequest-property-enum-value-removed
- ▲
removed the enum value
QUALITYof the request propertyrequest-property-enum-value-removed
- ▲
removed the enum value
REALISTICof the request propertyrequest-property-enum-value-removed
- ▲
removed the enum value
RENDER_3Dof the request propertyrequest-property-enum-value-removed
- ▲
removed the enum value
TURBOof the request propertyrequest-property-enum-value-removed
- ●
removed from the
request propertyallOflistrequest-property-all-of-removed
- ○
the
request property default value changed fromAUTOtoautorequest-property-default-value-changed
- ○
the
request property default value changed fromDEFAULTtodefaultrequest-property-default-value-changed
- ○
added the new
animeenum value to the request propertyrequest-property-enum-value-added
- ○
added the new
autoenum value to the request propertyrequest-property-enum-value-added
- ○
added the new
defaultenum value to the request propertyrequest-property-enum-value-added
- ○
added the new
designenum value to the request propertyrequest-property-enum-value-added
- ○
added the new
generalenum value to the request propertyrequest-property-enum-value-added
- ○
added the new
qualityenum value to the request propertyrequest-property-enum-value-added
- ○
added the new
realisticenum value to the request propertyrequest-property-enum-value-added
- ○
added the new
render_3denum value to the request propertyrequest-property-enum-value-added
- ○
added the new
turboenum value to the request propertyrequest-property-enum-value-added
This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ○
endpoint added
endpoint-added
- ○