v4

latestOpenAPI 3.0.22026-08-02109239415.7 KB

vision

Describe with Ideogram 4.0

Describe an image with Ideogram 4.0 and return a structured V4JsonPrompt. The returned json_prompt is a working JSON prompt that can be passed directly as json_prompt to the /v1/ideogram-v4/generate family of endpoints.

Supported image formats include JPEG, PNG, and WebP.

post/v1/ideogram-v4/describe

Response

Structured V4 prompt generated successfully.

Example response

{
  "json_prompt": {
    "high_level_description": "high_level_description",
    "style_description": {
      "photo": "photo",
      "art_style": "art_style",
      "medium": "medium",
      "aesthetics": "aesthetics",
      "lighting": "lighting",
      "color_palette": [
        "#FFD700",
        "#FFD700"
      ]
    },
    "compositional_deconstruction": {
      "background": "background",
      "elements": [
        {
          "bbox": [
            0,
            0,
            1000,
            1000
          ],
          "type": "obj",
          "desc": "desc",
          "color_palette": [
            "#FFD700",
            "#FFD700"
          ]
        },
        {
          "bbox": [
            0,
            0,
            1000,
            1000
          ],
          "type": "obj",
          "desc": "desc",
          "color_palette": [
            "#FFD700",
            "#FFD700"
          ]
        }
      ]
    },
    "tags": [
      "tags",
      "tags"
    ]
  }
}