Describe

POST

https://api.ideogram.ai/describe

POST

/describe

1 curl -X POST https://api.ideogram.ai/describe \
2   -H "Api-Key: <apiKey>" \
3   -H "Content-Type: multipart/form-data" \
4   -F image_file=@<file1>

Try it

200Successful

1 {
2   "descriptions": [
3     {
4       "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."
5     },
6     {
7       "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."
8     }
9   ]
10 }

Describe an image. Supported image formats include JPEG, PNG, and WebP.

Request

This endpoint expects a multipart form containing a file.

image_filefileRequired

An image binary (max size 10MB); only JPEG, WebP and PNG formats are supported at this time.

Response

Description(s) created successfully.

descriptionslist of objects or null

A collection of descriptions for given content.

Describe

Headers

Request

Response

Errors