@aigne/ideogram 0.3.5 → 0.3.6

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [0.3.6](https://github.com/AIGNE-io/aigne-framework/compare/ideogram-v0.3.5...ideogram-v0.3.6) (2025-09-01)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/core bumped to 1.57.5
+
 ## [0.3.5](https://github.com/AIGNE-io/aigne-framework/compare/ideogram-v0.3.4...ideogram-v0.3.5) (2025-08-30)
 
 

package/README.md

@@ -20,7 +20,6 @@ AIGNE Ideogram SDK for integrating with Ideogram's image generation models and A
 
 `@aigne/ideogram` provides a seamless integration between the AIGNE Framework and Ideogram's powerful image generation models and APIs. This package enables developers to easily leverage Ideogram's advanced image generation capabilities in their AIGNE applications, providing a consistent interface across the framework while taking advantage of Ideogram's state-of-the-art image synthesis technology.
 
-
 ## Installation
 
 ### Using npm
@@ -51,6 +50,7 @@ const model = new IdeogramImageModel({
 });
 
 const result = await model.invoke({
+  model: "ideogram-v3",
   prompt: "A serene mountain landscape at sunset with golden light",
 });
 
@@ -63,12 +63,70 @@ console.log(result);
       }
     ],
     usage: {
-      promptTokens: 0
-      imageCount: 0
-    }
+      inputTokens: 0,
+      outputTokens: 0
+    },
+    model: "ideogram-v3"
   }
   */
 ```
+
+## Input Parameters
+
+The `IdeogramImageModel` supports the following input parameters:
+
+### Required Parameters
+
+- **`prompt`** (string): The text description of the image you want to generate.
+
+### Optional Parameters
+
+- **`model`** (string): only support ideogram-v3
+- **`n`** (number): Number of images to generate (1-8, defaults to 1)
+- **`seed`** (number): Random seed for reproducible generation (0 to 2147483647)
+- **`resolution`** (string): Image resolution (e.g., "1024x1024", "1792x1024")
+- **`aspectRatio`** (string): Aspect ratio for image generation (e.g., "1x1", "16x9")
+- **`renderingSpeed`** (string): Generation speed - "TURBO", "DEFAULT", or "QUALITY"
+- **`magicPrompt`** (string): Enable/disable MagicPrompt - "AUTO", "ON", or "OFF"
+- **`negativePrompt`** (string): Description of what to exclude from the image
+- **`colorPalette`** (object): Color palette for generation
+- **`styleCodes`** (string[]): List of 8-character hexadecimal style codes
+- **`styleType`** (string): Style type - "AUTO", "GENERAL", "REALISTIC", "DESIGN", or "FICTION"
+
+### Reference Parameters
+
+For complete parameter details, supported resolutions, aspect ratios, and advanced features, refer to the [Ideogram API Reference](https://developer.ideogram.ai/api-reference/api-reference/generate-v3).
+
+### Advanced Usage Example
+
+```typescript
+const result = await model.invoke({
+  prompt: "A futuristic cityscape with neon lights and flying cars",
+  model: "ideogram-v3",
+  n: 4,
+  resolution: "1792x1024",
+  renderingSpeed: "TURBO",
+  styleType: "FICTION",
+  negativePrompt: "blurry, low quality, distorted",
+  seed: 12345
+});
+```
+
+## Model Options
+
+You can also set default options when creating the model:
+
+```typescript
+const model = new IdeogramImageModel({
+  apiKey: "your-api-key",
+  modelOptions: {
+    styleType: "REALISTIC",
+    renderingSpeed: "QUALITY",
+    magicPrompt: "ON"
+  }
+});
+```
+
 ## Environment Variables
 
 Set the following environment variable for automatic API key detection:
@@ -77,6 +135,10 @@ Set the following environment variable for automatic API key detection:
 export IDEOGRAM_API_KEY="your-ideogram-api-key"
 ```
 
+## API Reference
+
+For complete parameter details, supported resolutions, aspect ratios, and advanced features, refer to the [Ideogram API Reference](https://developer.ideogram.ai/api-reference/api-reference/generate-v3).
+
 ## License
 
 Elastic-2.0

package/lib/cjs/ideogram-image-model.d.ts

@@ -26,6 +26,7 @@ export declare class IdeogramImageModel extends ImageModel<IdeogramImageModelInp
     get credential(): {
         url: string;
         apiKey: string | undefined;
+        model: string;
     };
     get modelOptions(): Omit<Partial<IdeogramImageModelInput>, "model"> | undefined;
     /**

package/lib/cjs/ideogram-image-model.js

@@ -7,6 +7,7 @@ const type_utils_js_1 = require("@aigne/core/utils/type-utils.js");
 const ufo_1 = require("ufo");
 const zod_1 = require("zod");
 const IDEOGRAM_BASE_URL = "https://api.ideogram.ai";
+const IDEOGRAM_DEFAULT_IMAGE_MODEL = "ideogram-v3";
 const ideogramImageModelInputSchema = core_1.imageModelInputSchema.extend({});
 const ideogramImageModelOptionsSchema = zod_1.z.object({
     apiKey: zod_1.z.string().optional(),
@@ -31,6 +32,7 @@ class IdeogramImageModel extends core_1.ImageModel {
         return {
             url: this.options?.baseURL || process.env.IDEOGRAM_BASE_URL || IDEOGRAM_BASE_URL,
             apiKey: this.options?.apiKey || process.env[this.apiKeyEnvName],
+            model: this.options?.model || IDEOGRAM_DEFAULT_IMAGE_MODEL,
         };
     }
     get modelOptions() {
@@ -42,7 +44,7 @@ class IdeogramImageModel extends core_1.ImageModel {
      * @returns The generated response
      */
     async process(input) {
-        const model = input.model;
+        const model = input.model || this.credential.model;
         const formData = new FormData();
         if (model !== "ideogram-v3") {
             throw new Error(`${this.name} only support ideogram-v3`);

package/lib/dts/ideogram-image-model.d.ts

@@ -26,6 +26,7 @@ export declare class IdeogramImageModel extends ImageModel<IdeogramImageModelInp
     get credential(): {
         url: string;
         apiKey: string | undefined;
+        model: string;
     };
     get modelOptions(): Omit<Partial<IdeogramImageModelInput>, "model"> | undefined;
     /**

package/lib/esm/ideogram-image-model.d.ts

@@ -26,6 +26,7 @@ export declare class IdeogramImageModel extends ImageModel<IdeogramImageModelInp
     get credential(): {
         url: string;
         apiKey: string | undefined;
+        model: string;
     };
     get modelOptions(): Omit<Partial<IdeogramImageModelInput>, "model"> | undefined;
     /**

package/lib/esm/ideogram-image-model.js

@@ -4,6 +4,7 @@ import { checkArguments, pick } from "@aigne/core/utils/type-utils.js";
 import { joinURL } from "ufo";
 import { z } from "zod";
 const IDEOGRAM_BASE_URL = "https://api.ideogram.ai";
+const IDEOGRAM_DEFAULT_IMAGE_MODEL = "ideogram-v3";
 const ideogramImageModelInputSchema = imageModelInputSchema.extend({});
 const ideogramImageModelOptionsSchema = z.object({
     apiKey: z.string().optional(),
@@ -28,6 +29,7 @@ export class IdeogramImageModel extends ImageModel {
         return {
             url: this.options?.baseURL || process.env.IDEOGRAM_BASE_URL || IDEOGRAM_BASE_URL,
             apiKey: this.options?.apiKey || process.env[this.apiKeyEnvName],
+            model: this.options?.model || IDEOGRAM_DEFAULT_IMAGE_MODEL,
         };
     }
     get modelOptions() {
@@ -39,7 +41,7 @@ export class IdeogramImageModel extends ImageModel {
      * @returns The generated response
      */
     async process(input) {
-        const model = input.model;
+        const model = input.model || this.credential.model;
         const formData = new FormData();
         if (model !== "ideogram-v3") {
             throw new Error(`${this.name} only support ideogram-v3`);

package/package.json

@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "ufo": "^1.6.1",
-    "@aigne/core": "1.57.4"
+    "@aigne/core": "1.57.5"
   },
   "devDependencies": {
     "@types/bun": "^1.2.18",
@@ -47,7 +47,7 @@
     "typescript": "^5.8.3",
     "zod": "3.25.67"
   },
-  "version": "0.3.5",
+  "version": "0.3.6",
   "scripts": {
     "lint": "tsc --noEmit",
     "build": "tsc --build scripts/tsconfig.build.json",