Skip to navigation

Describe with Ideogram 3.0

Generate a natural-language description of an image with Ideogram’s 3.0 image captioner (a fine-tune of the Qwen2-VL vision-language model). Upload the image as image using multipart/form-data; the description is returned directly.

Authentication

Api-Keystring

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

Request

A request to describe one image. Send it as multipart/form-data with the image to describe.

imagefileRequired

The image to describe (max 10MB). JPEG, PNG, and WebP are supported. Multipart requests only.

Response

Description(s) generated successfully.

description_idstring

URL-safe base64 ID of the description that was created.

createddatetime
The time the request was created.
descriptionslist of objects

The generated description(s) for the provided image.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error