Generate with Ideogram 3.0

Request

Header Params

Content-Type

string

optional

Example:

multipart/form-data

Body Params multipart/form-data

prompt

string

required

The prompt to use to generate the image.

seed

integer

optional

Random seed. Set for reproducible generation.

resolution

string

optional

The resolutions supported for Ideogram 3.0.

aspect_ratio

string

optional

The aspect ratio to use for image generation, which determines the image’s resolution. Cannot be used in conjunction with resolution. Defaults to 1x1.

rendering_speed

string

optional

The rendering speed to use.

magic_prompt

string

optional

Determine if MagicPrompt should be used in generating the request or not.

num_images

integer

optional

Number of images to generate.

color_palette

string

optional

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 weights (members). Not supported by V_1, V_1_TURBO, V_2A and V_2A_TURBO models.

style_codes

string

optional

A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style_type.

style_type

string

optional

The style type to generate with.

style_reference_images

string

optional

A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/ideogram/v1/ideogram-v3/generate' \
--header 'Content-Type: multipart/form-data' \
--form 'prompt=""' \
--form 'seed="";type=false' \
--form 'resolution=""' \
--form 'aspect_ratio=""' \
--form 'rendering_speed=""' \
--form 'magic_prompt=""' \
--form 'num_images=""' \
--form 'color_palette=""' \
--form 'style_codes=""' \
--form 'style_type=""' \
--form 'style_reference_images=""'

Responses

🟢200Successful

application/json

Body

created

string

required

data

array [object {6}]

required

prompt

string

optional

resolution

string

optional

is_image_safe

boolean

optional

seed

integer

optional

url

string

optional

style_type

string

optional

Example

curl -X POST https://api.yescale.io/ideogram/v1/ideogram-v3/generate \
  -H "Api-Key: <apiKey>" \
  -H "Content-Type: multipart/form-data" \
  -F prompt="A photo of a cat sleeping on a couch." \
  -F rendering_speed="TURBO"