@aigne/ideogram 0.3.15 → 0.4.0-beta

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.4.0-beta](https://github.com/AIGNE-io/aigne-framework/compare/ideogram-v0.3.15...ideogram-v0.4.0-beta) (2025-09-22)
+
+
+### Features
+
+* improve image model architecture and file handling ([#527](https://github.com/AIGNE-io/aigne-framework/issues/527)) ([4db50aa](https://github.com/AIGNE-io/aigne-framework/commit/4db50aa0387a1a0f045ca11aaa61613e36ca7597))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/core bumped to 1.61.0-beta
+
 ## [0.3.15](https://github.com/AIGNE-io/aigne-framework/compare/ideogram-v0.3.14...ideogram-v0.3.15) (2025-09-18)
 
 

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

@@ -1,4 +1,4 @@
-import { ImageModel, type ImageModelInput, type ImageModelOptions, type ImageModelOutput } from "@aigne/core";
+import { type AgentInvokeOptions, ImageModel, type ImageModelInput, type ImageModelOptions, type ImageModelOutput } from "@aigne/core";
 export interface IdeogramImageModelInput extends ImageModelInput {
     seed?: number;
     resolution?: string;
@@ -34,5 +34,5 @@ export declare class IdeogramImageModel extends ImageModel<IdeogramImageModelInp
      * @param input The input to process
      * @returns The generated response
      */
-    process(input: IdeogramImageModelInput): Promise<ImageModelOutput>;
+    process(input: IdeogramImageModelInput, options: AgentInvokeOptions): Promise<ImageModelOutput>;
 }

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

@@ -43,7 +43,7 @@ class IdeogramImageModel extends core_1.ImageModel {
      * @param input The input to process
      * @returns The generated response
      */
-    async process(input) {
+    async process(input, options) {
         const model = input.model || this.credential.model;
         const formData = new FormData();
         if (model !== "ideogram-v3") {
@@ -62,18 +62,28 @@ class IdeogramImageModel extends core_1.ImageModel {
             "styleType",
         ];
         const mergedInput = (0, camelize_js_1.snakelize)((0, type_utils_js_1.pick)({ ...this.modelOptions, ...input }, inputKeys));
-        if (input.n) {
-            formData.append("num_images", input.n.toString());
-        }
         Object.keys(mergedInput).forEach((key) => {
             if (mergedInput[key]) {
                 formData.append(key, mergedInput[key]);
             }
         });
+        if (input.n) {
+            formData.append("num_images", input.n.toString());
+        }
+        const inputImages = (0, type_utils_js_1.flat)(input.image);
+        const image = inputImages.at(0);
+        if (image) {
+            if (inputImages.length > 1) {
+                throw new Error(`${this.name} only support one image for editing`);
+            }
+            const { data } = await this.transformFileOutput(core_1.FileOutputType.file, image, options);
+            formData.append("image", new Blob([Buffer.from(data, "base64")]));
+        }
         const { url, apiKey } = this.credential;
         if (!apiKey)
             throw new Error(`${this.name} requires an API key. Please provide it via \`options.apiKey\`, or set the \`${this.apiKeyEnvName}\` environment variable`);
-        const response = await fetch((0, ufo_1.joinURL)(new URL(url).origin, `/v1/${model}/generate`), {
+        const apiURL = (0, ufo_1.joinURL)(new URL(url).origin, "v1", model, image ? "remix" : "generate");
+        const response = await fetch(apiURL, {
             method: "POST",
             headers: { "api-key": apiKey },
             body: formData,
@@ -84,7 +94,7 @@ class IdeogramImageModel extends core_1.ImageModel {
         }
         const data = await response.json();
         return {
-            images: data.data.map((item) => ({ url: item.url })),
+            images: data.data.map((item) => ({ type: "url", url: item.url, mimeType: "image/png" })),
             usage: {
                 inputTokens: 0,
                 outputTokens: 0,

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

@@ -1,4 +1,4 @@
-import { ImageModel, type ImageModelInput, type ImageModelOptions, type ImageModelOutput } from "@aigne/core";
+import { type AgentInvokeOptions, ImageModel, type ImageModelInput, type ImageModelOptions, type ImageModelOutput } from "@aigne/core";
 export interface IdeogramImageModelInput extends ImageModelInput {
     seed?: number;
     resolution?: string;
@@ -34,5 +34,5 @@ export declare class IdeogramImageModel extends ImageModel<IdeogramImageModelInp
      * @param input The input to process
      * @returns The generated response
      */
-    process(input: IdeogramImageModelInput): Promise<ImageModelOutput>;
+    process(input: IdeogramImageModelInput, options: AgentInvokeOptions): Promise<ImageModelOutput>;
 }

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

@@ -1,4 +1,4 @@
-import { ImageModel, type ImageModelInput, type ImageModelOptions, type ImageModelOutput } from "@aigne/core";
+import { type AgentInvokeOptions, ImageModel, type ImageModelInput, type ImageModelOptions, type ImageModelOutput } from "@aigne/core";
 export interface IdeogramImageModelInput extends ImageModelInput {
     seed?: number;
     resolution?: string;
@@ -34,5 +34,5 @@ export declare class IdeogramImageModel extends ImageModel<IdeogramImageModelInp
      * @param input The input to process
      * @returns The generated response
      */
-    process(input: IdeogramImageModelInput): Promise<ImageModelOutput>;
+    process(input: IdeogramImageModelInput, options: AgentInvokeOptions): Promise<ImageModelOutput>;
 }

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

@@ -1,6 +1,6 @@
-import { ImageModel, imageModelInputSchema, } from "@aigne/core";
+import { FileOutputType, ImageModel, imageModelInputSchema, } from "@aigne/core";
 import { snakelize } from "@aigne/core/utils/camelize.js";
-import { checkArguments, pick } from "@aigne/core/utils/type-utils.js";
+import { checkArguments, flat, pick } from "@aigne/core/utils/type-utils.js";
 import { joinURL } from "ufo";
 import { z } from "zod";
 const IDEOGRAM_BASE_URL = "https://api.ideogram.ai";
@@ -40,7 +40,7 @@ export class IdeogramImageModel extends ImageModel {
      * @param input The input to process
      * @returns The generated response
      */
-    async process(input) {
+    async process(input, options) {
         const model = input.model || this.credential.model;
         const formData = new FormData();
         if (model !== "ideogram-v3") {
@@ -59,18 +59,28 @@ export class IdeogramImageModel extends ImageModel {
             "styleType",
         ];
         const mergedInput = snakelize(pick({ ...this.modelOptions, ...input }, inputKeys));
-        if (input.n) {
-            formData.append("num_images", input.n.toString());
-        }
         Object.keys(mergedInput).forEach((key) => {
             if (mergedInput[key]) {
                 formData.append(key, mergedInput[key]);
             }
         });
+        if (input.n) {
+            formData.append("num_images", input.n.toString());
+        }
+        const inputImages = flat(input.image);
+        const image = inputImages.at(0);
+        if (image) {
+            if (inputImages.length > 1) {
+                throw new Error(`${this.name} only support one image for editing`);
+            }
+            const { data } = await this.transformFileOutput(FileOutputType.file, image, options);
+            formData.append("image", new Blob([Buffer.from(data, "base64")]));
+        }
         const { url, apiKey } = this.credential;
         if (!apiKey)
             throw new Error(`${this.name} requires an API key. Please provide it via \`options.apiKey\`, or set the \`${this.apiKeyEnvName}\` environment variable`);
-        const response = await fetch(joinURL(new URL(url).origin, `/v1/${model}/generate`), {
+        const apiURL = joinURL(new URL(url).origin, "v1", model, image ? "remix" : "generate");
+        const response = await fetch(apiURL, {
             method: "POST",
             headers: { "api-key": apiKey },
             body: formData,
@@ -81,7 +91,7 @@ export class IdeogramImageModel extends ImageModel {
         }
         const data = await response.json();
         return {
-            images: data.data.map((item) => ({ url: item.url })),
+            images: data.data.map((item) => ({ type: "url", url: item.url, mimeType: "image/png" })),
             usage: {
                 inputTokens: 0,
                 outputTokens: 0,

package/package.json

@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "ufo": "^1.6.1",
-    "@aigne/core": "1.60.3"
+    "@aigne/core": "1.61.0-beta"
   },
   "devDependencies": {
     "@types/bun": "^1.2.22",
@@ -47,7 +47,7 @@
     "typescript": "^5.9.2",
     "zod": "3.25.67"
   },
-  "version": "0.3.15",
+  "version": "0.4.0-beta",
   "scripts": {
     "lint": "tsc --noEmit",
     "build": "tsc --build scripts/tsconfig.build.json",