Describe | Ideogram | Documentation

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

Api-Keystring

API key for access control. Use in the header with the name “Api-Key”

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.

describe_model_versionenumOptionalDefaults to V_3

The model version to use for describing images. Defaults to V_3.

Allowed values:

Description(s) created successfully.

descriptionslist of objects

A collection of descriptions for given content.

400

Bad Request Error

422

Unprocessable Entity Error

429

Too Many Requests Error

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

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

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	}