API reference
🇺🇸 English
  • 🇨🇳 Chinese
  • 🇺🇸 English
  1. Ideogram
API reference
🇺🇸 English
  • 🇨🇳 Chinese
  • 🇺🇸 English
  • Chat Models
    • Chat
      • Create chat completion
      • vision
    • OpenAI-Realtime
    • Completions
      • Instruct
    • Audio
      • Transcriptions
      • Translations
      • Speech
    • Image generation
      • DALL·E 3
    • Embeddings
      • Create
    • Models
      • model list
    • Help
      • 常见问题及解决办法
  • Anthropic
    • Anthropic Claude
      POST
  • Suno
    • Generate music
      POST
    • Generate lyrics
      POST
    • Upload music
      POST
    • Music concat
      POST
    • Fetch task
      GET
    • Fetch batch tasks
      POST
  • Udio
    • Generate music
      POST
    • Fetch task
      GET
  • Midjourney API
    • Quick
    • Task Submit
      • Imagine
      • Action
      • Modal
      • Blend
      • Describe
      • Shorten
      • Upload discord
    • Get Task
      • Fetch task by ids
      • Fetch task by id
      • Get seed
  • Flux
    • Official
      • Generate
      • Finetune
      • Fetch task
    • OpenAI Dalle3
  • Recraft
    • Official
      • Generate Image
      • Vectorize Image
      • Remove Background
      • Clarity Upscale
      • Generative Upscale
      • Create style
    • OpenAI Dalle3
  • Ideogram
    • Generate
      POST
    • Remix
      POST
    • Edit
      POST
    • Upscale
      POST
    • Describe
      POST
  • Luma
    • Official
      • Generate
      • Fetch task
    • Own format
      • Submit
        • Generate
        • Get video of no mark
        • 扩展视频
      • Get task
        • Get task
        • Get batch task
  • Runway
    • Official
      • image to video
      • get task
    • reverse
      • text to video
      • image to video
      • video2video
      • Act-one
      • Get task
  • Kling-API
    • Callback
    • Generate image
    • Text 2 Video
    • Image 2 Video
    • Video extend
    • Get task
    • lip-sync
    • kolors-virtual-try-on
  • Replicate
    • Generate
    • Get
  • MiniMax
    • Generate video
    • Get task
    • Get file
  1. Ideogram

Upscale

POST
/ideogram/upscale
Last modified:2025-02-05 11:29:08
Upscale provided images synchronously with an optional prompt.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
Authorization
string 
optional
Default:
{{YOUR_API_KEY}}
Body Params multipart/form-data
image_file
file 
required
An image binary; only JPEG, WEBPs and PNGs are supported at this time
图像二进制;目前仅支持 JPEG、WEBP 和 PNG 格式
image_request
string 
required
A request to generate a new image using a provided image and a prompt.
请求生成一张新图像,使用提供的图像和提示。大致和Generate相同。
Example:
{"resemblance":50,"magic_prompt_option":"AUTO","prompt":"A%20serene%20tropical%20beach%20","seed":12345,"detail":50}

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 -g --request POST '/ideogram/upscale' \
--header 'Authorization: ' \
--form 'image_file=@""' \
--form 'image_request=""'

Responses

🟢200成功
application/json
Body
data
array [object {5}] 
required
A list of ImageObjects that contain the generated image(s).
包含生成图像的图像对象列表。
seed
integer 
required
0 to 2147483647
prompt
string 
required
The prompt used for the generation. This may be different from the original prompt.
用于生成的提示。这可能与原始提示不同。
resolution
string 
required
The resolution of the final image.
最终图像的分辨率。
url
string  | null 
required
The direct link to the image generated.
生成的图像的直接链接。
is_image_safe
boolean 
required
Whether this request passes safety checks. If false, the url field will be empty.
该请求是否通过安全检查。如果为假,网址字段将为空。
created
string 
required
The time the request was created.
请求创建的时间。
Example
{
  "data": [
    {
      "seed": 12345,
      "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there's an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
      "resolution": "1024x1024",
      "url": "https://ideogram.ai/api/images/direct/8YEpFzHuS-S6xXEGmCsf7g",
      "is_image_safe": true
    },
    {
      "seed": 12345,
      "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there's an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
      "resolution": "1024x1024",
      "url": "https://ideogram.ai/api/images/direct/8YEpFzHuS-S6xXEGmCsf7g",
      "is_image_safe": true
    }
  ],
  "created": "2000-01-23T04:56:07.000Z"
}
Previous
Edit
Next
Describe
Built with