Sign in
image-describe

Describe with Ideogram 3.0

Generate a natural-language description of an image using Ideogram's 3.0-generation image captioner (a fine-tune of the Qwen2-VL vision-language model).

Supply the source either as an image_asset_identifier reference (an image already stored with Ideogram) or as raw image bytes (multipart requests only). Provide exactly one of the two forms; supplying both, or neither, is rejected with a 400.

Supported image formats include JPEG, PNG, and WebP.

post/v2/image/describe/ideogram-3

Request body

imagestring binary

The image to describe (max size 10MB), as raw bytes; only JPEG, PNG, and WebP formats are supported. Multipart requests only. Provide exactly one of image_asset_identifier or image.

Example request

{
  "image_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  }
}

Response

Description(s) generated successfully.

description_idstring required

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

createdstring date-time required

The time the request was created.

Example response

{
  "description_id": "description_id",
  "created": "2000-01-23T04:56:07+00:00",
  "descriptions": [
    {
      "text": "text"
    },
    {
      "text": "text"
    }
  ]
}

Changes

Changed in 2 of the 33 revisions of this API.5

  • 987f73fc82de4See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • cb077a6ff5801See the full diff
    • ○

      endpoint added

      endpoint-added