img-processing · RolandoAndrade · Mar 23, 2025 · Mar 23, 2025 · Mar 23, 2025
diff --git a/package.json b/package.json
@@ -1,13 +1,8 @@
 {
   "name": "img-processing-sdk",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "SDK for image processing",
-  "keywords": [
-    "img processing",
-    "image processing",
-    "api",
-    "sdk"
-  ],
+  "keywords": ["img processing", "image processing", "api", "sdk"],
   "homepage": "https://img-processing.com",
   "license": "MIT",
   "main": "dist/index.js",
@@ -27,9 +22,7 @@
     "type": "git",
     "url": "git+https://github.com/img-processing/node-sdk.git"
   },
-  "files": [
-    "dist"
-  ],
+  "files": ["dist"],
   "type": "module",
   "devDependencies": {
     "@biomejs/biome": "1.8.3",

diff --git a/src/api-client.ts b/src/api-client.ts
@@ -209,6 +209,24 @@ export class IMGProcessingClient {
     );
   }
 
+  /**
+   * Extracts the text from an image and returns its content in the `format` specified in the request.
+   *
+   * **Note:** This method is not available in test mode, since test watermarks prevent accurate text extraction. If you want to test the capabilities of this endpoint, please switch to live mode to use this feature, or contact support to temporarily upgrade your account.
+   */
+  async extractFormattedText({
+    image_id,
+    format,
+  }: IMGProcessingClient.extractFormattedText.Params): Promise<IMGProcessingClient.extractFormattedText.Response> {
+    return this.request(() =>
+      this.client.post(`v1/images/${image_id}/extract-formatted-text`, {
+        json: {
+          format,
+        },
+      }),
+    );
+  }
+
   /**
    * Visualize an image using a pre-trained model and generate an answer based on the prompt.
    * The prompt can be a question, statement, or any text that you want to ask about the image. The API will analyze the content of the image and generate a response based on the prompt
@@ -311,7 +329,7 @@ export class IMGProcessingClient {
     negative_prompt,
     name,
     seed,
-    model
+    model,
   }: IMGProcessingClient.imagine.Params): Promise<ImageObject> {
     return this.imageRequest(() =>
       this.client.post<ImageObject>("v1/images/imagine", {
@@ -320,7 +338,7 @@ export class IMGProcessingClient {
           negative_prompt,
           name,
           seed,
-          model
+          model,
         },
       }),
     );
@@ -622,7 +640,7 @@ export declare namespace IMGProcessingClient {
       /** The seed to use for the generation. */
       seed?: number;
       /** The model to use for the generation. */
-      model?: "sdxl" | "flux"
+      model?: "sdxl" | "flux";
     };
   }
 
@@ -881,4 +899,19 @@ export declare namespace IMGProcessingClient {
       lines: string[];
     };
   }
+
+  export namespace extractFormattedText {
+    export type Params = {
+      /** The ID of the image to extract text. */
+      image_id: ImageId;
+      /** The format of the text to extract. */
+      format?: "plain" | "markdown";
+    };
+    export type Response = {
+      /** The format of the response. Default is `plain`. */
+      format: "plain" | "markdown";
+      /** The content extracted from the image. */
+      content: string;
+    };
+  }
 }
diff --git a/src/image-object.ts b/src/image-object.ts
@@ -105,6 +105,20 @@ export class ImageObject<
     return await this.client.extractText({ image_id: this.id });
   }
 
+  /**
+   * Extracts the text from the current image and returns its content in the `format` specified.
+   *
+   * **Note:** This method is not available in test mode, since test watermarks prevent accurate text extraction. If you want to test the capabilities of this endpoint, please switch to live mode to use this feature, or contact support to temporarily upgrade your account.
+   */
+  async extractFormattedText({
+    format,
+  }: ImageObject.extractFormattedText.Params = {}): Promise<ImageObject.extractFormattedText.Response> {
+    return await this.client.extractFormattedText({
+      image_id: this.id,
+      format,
+    });
+  }
+
   /**
    * Visualize an image using a pre-trained model and generate an answer based on the prompt.
    * The prompt can be a question, statement, or any text that you want to ask about the image. The API will analyze the content of the image and generate a response based on the prompt
@@ -404,4 +418,9 @@ export declare namespace ImageObject {
   export namespace extractText {
     export type Response = IMGProcessingClient.extractText.Response;
   }
+  export namespace extractFormattedText {
+    export type Params =
+      WithoutImageId<IMGProcessingClient.extractFormattedText.Params>;
+    export type Response = IMGProcessingClient.extractFormattedText.Response;
+  }
 }
diff --git a/test/analysis/extract-formatted-text.test.ts b/test/analysis/extract-formatted-text.test.ts
@@ -0,0 +1,27 @@
+import { beforeAll, describe, expect, test } from "vitest";
+import {
+  IMGProcessingAPIError,
+  IMGProcessingClient,
+  type ImageObject,
+} from "../../src/index.js";
+import { getApiKey, getAsset } from "../test-helpers.js";
+
+describe("extract formatted text", () => {
+  const client: IMGProcessingClient = new IMGProcessingClient({
+    apiKey: getApiKey(),
+  });
+  let uploadedImage: ImageObject;
+  beforeAll(async () => {
+    uploadedImage = await client.uploadImage({
+      image: getAsset("test_image_1.jpeg"),
+      name: "test_image",
+    });
+  });
+  test("should extract text from an image", async () => {
+    const response = await uploadedImage.extractFormattedText();
+    expect(response).toMatchObject({
+      format: "plain",
+      content: expect.any(String),
+    });
+  });
+});
diff --git a/test/analysis/extract-text.test.ts b/test/analysis/extract-text.test.ts
@@ -4,7 +4,7 @@ import {
   IMGProcessingClient,
   type ImageObject,
 } from "../../src/index.js";
-import { getApiKey, getAsset } from '../test-helpers.js';
+import { getApiKey, getAsset } from "../test-helpers.js";
 
 describe("extract text", () => {
   const client: IMGProcessingClient = new IMGProcessingClient({
@@ -22,4 +22,4 @@ describe("extract text", () => {
     expect(lines).toBeDefined();
     expect(lines).toEqual(expect.arrayContaining([expect.any(String)]));
   });
-});
+});