Docs
  1. Ideogram
Docs
  • Introduction
  • Quick Start Guide
  • Make a request
  • Chat Models
    • ChatGpt
      • ChatGPT (Audio)
        • Create a voice
        • Create a transcript
        • Create translation
      • ChatGPT (Chat)
        • Chat completion object
        • Create chat completion (streaming)
        • Create chat completion (non-streaming)
        • Create chat image recognition (streaming)
        • Create chat image recognition (streaming) base64
        • Create chat image recognition (non-streaming)
        • Function calling
        • N choices
        • Create chat function call (only non-streaming)
        • Create structured output
      • ChatGPT (Completions)
        • Completion object
        • Creation completed
      • ChatGPT（Embeddings）
        • Embedded Object
        • Create embed
    • Anthropic Claude
      • Create chat completion (streaming)
      • Create chat completion (non-streaming)
      • Create chat image recognition (streaming)
      • Create chat image recognition (non-streaming)
    • Gemini
      • Gemini Image creation interface (gemini-2.0-flash-exp-image-generation)
      • Chat interface
      • Image recognition interface
  • Image Models
    • MJ
      • Submit Imagine task (mj_imagine)
      • Submit Blend task (mj_blend)
      • Submit Describe task (mj_describe)
      • Submit Change task (mj_variation, mj_upscale,mj_reroll)
      • Query task status based on task ID
    • Ideogram
      • Generate with Ideogram 3.0
        POST
      • Edit with Ideogram 3.0
        POST
      • Remix with Ideogram 3.0
        POST
    • Kling Image
      • Submit Image Generation
      • Get Image by Task ID
      • Submit Kolors Virtual Try On
      • Get Kolors Virtual Try On by Task ID
    • DALL·E 3
      POST
    • Flux (OpenAI dall-e-3 format)
      POST
  • Video Models
    • Kling Video
      • Create Video by Text
      • Get Video by Task ID(text2video)
      • Create Video by Image
      • Get Video by Task ID(image2video)
    • Runway ML Video
      • Create Video by Runway
      • Get Video by Task ID
    • Luma Video
      • Create Video by Luma
      • Get Video by Task ID
    • Pika Video
      • Create Video by Pika
      • Get Video by Task ID
  • Music Model - Suno
    • Illustrate
    • Parameter
    • Task submission
      • Generate songs (inspiration, customization, continuation)
      • Generate lyrics
    • Query interface
      • Query a single task
  • Python Samples
    • python openai official library (using AutoGPT, langchain, etc.)
    • Python uses speech to text
    • Python uses text to speech
    • Python uses Embeddings
    • python calls DALL·E
    • python simple call openai function-calling demo
    • python langchain
    • python llama_index
    • Python uses gpt-4o to identify pictures-local pictures
    • python library streaming output
    • Python uses gpt-4o to identify images
  • Plug-in/software usage tutorials
    • Setting HTTP for Make.com with Yescale
    • Sample Code for gpt-4o-audio/gpt-4o-mini-audio
  • Help Center
    • HTTP status codes
  1. Ideogram

Generate with Ideogram 3.0

POST
/ideogram/v1/ideogram-v3/generate
Generates images synchronously based on a given prompt and optional parameters using the Ideogram 3.0 model.
Images links are available for a limited period of time; if you would like to keep the image, you must download it.
More details: https://developer.ideogram.ai/api-reference/api-reference/generate-v3

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
Request Request Example
Shell
JavaScript
Java
Swift
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"
Previous
Query task status based on task ID
Next
Edit with Ideogram 3.0
Built with