Integrating Image Inpainting with the Lightweight AI Model1 Cognitive Actions

25 Apr 2025
Integrating Image Inpainting with the Lightweight AI Model1 Cognitive Actions

In today's digital landscape, enhancing images with precision and creativity is more important than ever. The Lightweight AI Model1 offers powerful Cognitive Actions that allow developers to integrate advanced image processing capabilities into their applications. One of the standout features of this spec is the ability to perform image inpainting using the Flux Schnell model, enabling developers to specify masks and generate high-quality images in various formats.

Prerequisites

Before diving into the integration of Cognitive Actions, you’ll need to ensure the following:

  • API Key: You will need an API key from the Cognitive Actions platform to authenticate your requests. This key should be included in the headers of your API calls.
  • Basic Setup: Familiarity with making HTTP requests and working with JSON payloads is essential for effective integration.

Cognitive Actions Overview

Perform Image Inpainting with Flux Schnell Model

Description: This action leverages the Flux Schnell model for image-to-image inference to perform image inpainting. This operation allows enhanced image generation by specifying masks, seed, dimensions, outputs, and output quality, along with supporting multiple output formats like 'webp', 'jpg', and 'png'.

Category: Image Processing

Input

The input schema for this action requires a variety of parameters to guide the image inpainting process:

  • mask (string): Upload a mask image for inpainting. White areas (255) indicate regions to be inpainted, while black areas (0) will be preserved from the original image.
  • seed (integer, optional): Specify a random seed to ensure reproducibility of image generation results.
  • width (integer, default: 1024): Specify the width of the output image in pixels.
  • height (integer, default: 1024): Specify the height of the output image in pixels.
  • prompt (string, default: predefined description): Detailed description of the desired image to guide the generation process.
  • imageUrl (string, optional): URL of the base image to be used in the generation process.
  • loraList (array, optional): List of Lora models to be applied during image generation.
  • loraScaleValues (array, optional): Corresponding scale values for each Lora model in the Lora list.
  • numberOfOutputs (integer, default: 1, min: 1, max: 4): Number of images to output.
  • outputImageFormat (string, enum: 'webp', 'jpg', 'png', default: 'png'): Desired format for the output images.
  • outputImageQuality (integer, default: 100, min: 0, max: 100): Sets the quality level for saving outputs.
  • numberOfInferenceSteps (integer, default: 4, min: 1, max: 12): Defines the number of steps for the inference process.
  • promptInfluenceStrength (number, default: 0.8, min: 0, max: 1): Determines the influence strength of the prompt on the image generation.

Example Input:

{
  "width": 1024,
  "height": 1024,
  "prompt": "A fluffy, orange tabby cat curled up asleep in a sunbeam streaming through a window, its soft fur glowing with the warmth of the light; highly detailed 8K UHD photorealistic rendering, natural lighting, warm and inviting atmosphere, focus on softness and texture.",
  "numberOfOutputs": 1,
  "outputImageFormat": "png",
  "outputImageQuality": 100,
  "numberOfInferenceSteps": 4,
  "promptInfluenceStrength": 0.8
}

Output

The action typically returns an array of URLs pointing to the generated images.

Example Output:

[
  "https://assets.cognitiveactions.com/invocations/12fc69fb-8412-48ae-ad71-29a9219acb25/beae0d84-2511-484d-a135-48fe34b591be.png"
]

Conceptual Usage Example (Python)

Here’s how you could implement a call to the image inpainting action using Python:

import requests
import json

# Replace with your Cognitive Actions API key and endpoint
COGNITIVE_ACTIONS_API_KEY = "YOUR_COGNITIVE_ACTIONS_API_KEY"
COGNITIVE_ACTIONS_EXECUTE_URL = "https://api.cognitiveactions.com/actions/execute" # Hypothetical endpoint

action_id = "174cee31-f1dd-4a56-8d26-4e2296c192c5" # Action ID for Perform Image Inpainting with Flux Schnell Model

# Construct the input payload based on the action's requirements
payload = {
    "width": 1024,
    "height": 1024,
    "prompt": "A fluffy, orange tabby cat curled up asleep in a sunbeam streaming through a window, its soft fur glowing with the warmth of the light; highly detailed 8K UHD photorealistic rendering, natural lighting, warm and inviting atmosphere, focus on softness and texture.",
    "numberOfOutputs": 1,
    "outputImageFormat": "png",
    "outputImageQuality": 100,
    "numberOfInferenceSteps": 4,
    "promptInfluenceStrength": 0.8
}

headers = {
    "Authorization": f"Bearer {COGNITIVE_ACTIONS_API_KEY}",
    "Content-Type": "application/json"
}

try:
    response = requests.post(
        COGNITIVE_ACTIONS_EXECUTE_URL,
        headers=headers,
        json={"action_id": action_id, "inputs": payload} # Hypothetical structure
    )
    response.raise_for_status() # Raise an exception for bad status codes (4xx or 5xx)

    result = response.json()
    print("Action executed successfully:")
    print(json.dumps(result, indent=2))

except requests.exceptions.RequestException as e:
    print(f"Error executing action {action_id}: {e}")
    if e.response is not None:
        print(f"Response status: {e.response.status_code}")
        try:
            print(f"Response body: {e.response.json()}")
        except json.JSONDecodeError:
            print(f"Response body: {e.response.text}")

In this code snippet, replace "YOUR_COGNITIVE_ACTIONS_API_KEY" with your actual API key. The action ID and structured input payload are provided based on the requirements of the image inpainting action.

Conclusion

The Lightweight AI Model1's image inpainting Cognitive Action offers developers a powerful tool for enhancing images with precision and creativity. By following the guidelines outlined in this article, you can easily integrate image inpainting capabilities into your applications, allowing for a wide range of creative possibilities. Whether you're building a content creation tool or an image editing application, these Cognitive Actions can significantly enhance your project. Happy coding!

← Back to All Articles