Ideogram

https://docs.ideogram.ai
Admin
Ideogram is a free-to-use AI tool that turns ideas into stunning images with best-in-class...
Tokens:28,256
Snippets:535
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Query Documentation via HTTP GET

Source: https://docs.ideogram.ai/llms.txt

Perform an HTTP GET request to the documentation index to receive a direct answer and relevant excerpts based on a specific question and optional goal.

```http
GET https://docs.ideogram.ai/table-of-content.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### Simple JSON Prompt Example

Source: https://docs.ideogram.ai/using-ideogram/getting-started/prompting-guide/4.-json-prompting-ideogram-4.0

A basic JSON structure for image generation that defines high-level descriptions, style, and compositional elements without bounding boxes.

```json
{
   "high_level_description":"A lone sailboat on calm water at golden hour.",
   "style_description":{
      "aesthetics":"serene, warm, golden hour",
      "lighting":"golden hour backlighting, warm atmospheric haze",
      "photo":"wide angle, f/8, long exposure",
      "medium":"photograph",
      "color_palette":[
         "#FF6B35",
         "#F7C59F",
         "#004E89",
         "#1A659E",
         "#2B2D42"
      ]
   },
   "compositional_deconstruction":{
      "background":"A calm ocean stretching to a low horizon, sky washed in orange and pink with thin wisps of cloud.",
      "elements":[
         {
            "type":"obj",
            "desc":"A single sailboat with a white triangular sail, silhouetted against the setting sun."
         }
      ]
   }
}
```

--------------------------------

### JSON Prompt Structure Example

Source: https://docs.ideogram.ai/using-ideogram/getting-started/prompting-guide/4.-json-prompting-ideogram-4.0

A partial JSON structure defining text elements, their bounding boxes, and descriptive styling for precise layout control.

```json
            "type":"text",
            "bbox":[
               775,
               150,
               860,
               850
            ],
            "text":"The smallest of the British songbirds, measuring around 9 centimetres.",
            "desc":"Small upright serif body text in dark ink, centered beneath the Latin name."
         },
         {
            "type":"text",
            "bbox":[
               868,
               680,
               930,
               940
            ],
            "text":"17 OF 50",
            "desc":"Small serif card number in dark ink, aligned to the bottom-right corner inside the border."
         },
         {
            "type":"text",
            "bbox":[
               930,
               50,
               990,
               950
            ],
            "text":"BRITISH SONGBIRDS",
            "desc":"Bold spaced green serif capitals in a solid footer band spanning the full width at the bottom of the card."
         }
      ]
   }
}
```

--------------------------------

### Define high_level_description field

Source: https://docs.ideogram.ai/using-ideogram/getting-started/prompting-guide/4.-json-prompting-ideogram-4.0

Example of the high_level_description field used to provide a concise summary of the image content.

```json
"high_level_description": "A medium-shot photograph of a barista pouring latte art in a cozy cafe."
```

--------------------------------

### GET /table-of-content.md

Source: https://docs.ideogram.ai/llms.txt

Performs a query against the documentation index to receive a direct answer and relevant excerpts based on a specific question and optional goal.

```APIDOC
## GET /table-of-content.md

### Description
Perform an HTTP GET request on the documentation index to retrieve an answer to a specific question, optionally tailored to a broader end goal.

### Method
GET

### Endpoint
https://docs.ideogram.ai/table-of-content.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate, specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```
Tokens:
Raw