Describe（Description）

Method: POSTEndpoint: /ideogram/describe

Describe an image This section contains endpoint-specific behavior, parameters, or usage notes for this API. For full parameters, see the official documentation: https://developer.ideogram.ai/api-reference/generate/post-generate-image

Request Parameters

Header Parameters

accept
string
Required
Example:
application/json
Authorization
string
Optional
Default Value:
Bearer {{YOUR_API_KEY}}

Body Parameters multipart/form-data

image_file
file
Required
Example:
file://E:\Downloads\flux.png

Example Request

Shell

curl --location --request POST '/ideogram/describe' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {{YOUR_API_KEY}}' \
--form 'image_file=@"E:\\Downloads\\flux.png"'

Response

🟢 200 Success

Content Type: application/json

Response Schema

created
string
Required
data
array
[object]
Required
is_image_safe
boolean
Optional
prompt
string
Optional
resolution
string
Optional
seed
integer
Optional
url
string
Optional

Example

{
    "descriptions": [
        {
            "text": "A meticulously illustrated cat with striped patterns, sitting upright. The cat's eyes are a captivating shade of yellow, and it appears to be gazing intently at something. The background consists of abstract, swirling patterns in shades of black, white, and beige, creating an almost fluid or wavy appearance. The cat is positioned in the foreground, with the background elements fading into the distance, giving a sense of depth to the image."
        },
        {
            "text": "A meticulously illustrated cat with striped patterns, sitting upright. The cat's eyes are a captivating shade of yellow, and it appears to be gazing intently at something. The background consists of abstract, swirling patterns in shades of black, white, and beige, creating an almost fluid or wavy appearance. The cat is positioned in the foreground, with the background elements fading into the distance, giving a sense of depth to the image."
        }
    ]
}