Unleashing Image Creativity: Integrating the Generate Inpainted Image Action from the andyx1976/checkshirt1 Spec

23 Apr 2025
Unleashing Image Creativity: Integrating the Generate Inpainted Image Action from the andyx1976/checkshirt1 Spec

In the realm of image processing, the ability to generate inpainted images opens up a world of creative possibilities. The andyx1976/checkshirt1 API offers a powerful Generate Inpainted Image action that leverages sophisticated models to produce stunning visuals tailored to your specifications. This action allows developers to create inpainted images with custom prompts, aspect ratios, resolutions, and more, making it an invaluable tool for enhancing applications that require dynamic visual content.

Prerequisites

Before diving into the integration, ensure you have the following prerequisites:

  • An API key for the Cognitive Actions platform.
  • Familiarity with making HTTP requests in your chosen programming language.

For authentication, you will generally pass your API key in the request headers. This will allow you to securely access the capabilities of the Cognitive Actions.

Cognitive Actions Overview

Generate Inpainted Image

The Generate Inpainted Image action is designed to create inpainted images using specified models, offering flexibility in image specifications. This includes options for image masking, prompt integration, and adjustments to enhance generation speed and quality.

Input

The input for this action requires a JSON object that includes various fields, with the prompt field being mandatory. Here’s a closer look at the input schema:

  • prompt (required): A text prompt guiding the image generation.
  • mask (optional): URI of the image mask used for inpainting.
  • seed (optional): Integer for initializing the random number generator.
  • image (optional): URI of the input image for transformation.
  • width (optional): Specifies the width of the generated image in pixels (valid only when aspect_ratio is set to custom).
  • height (optional): Specifies the height of the generated image in pixels (valid only when aspect_ratio is set to custom).
  • modelType (optional): Model selection for inference (dev or schnell).
  • outputCount (optional): Defines the number of outputs to generate (1 to 4).
  • enableFastMode (optional): Enables accelerated predictions.
  • imageMegapixels (optional): Sets the approximate megapixel count for the image.
  • imageAspectRatio (optional): Defines the aspect ratio of the generated image.
  • imageOutputFormat (optional): Sets the format for the output images.
  • imageOutputQuality (optional): Specifies the quality of output images.
  • inferenceStepCount (optional): Determines the number of denoising steps during inference.
  • additionalLoraScale (optional): Defines the intensity of the additional LoRA application.
  • imagePromptStrength (optional): Influences how much the prompt affects the image.
  • loraApplicationScale (optional): Controls the influence level of the primary LoRA.
  • safetyCheckerDisabled (optional): Enables or disables the safety checker for generated images.

Example Input:

{
  "prompt": "\ndynamic shots from different angles and zoomed at different body parts from the following scene: two tall, very slim, very young, skinny nerdy male students, age 18...",
  "modelType": "dev",
  "outputCount": 1,
  "enableFastMode": false,
  "imageMegapixels": "1",
  "imageAspectRatio": "1:1",
  "imageOutputFormat": "jpg",
  "imageOutputQuality": 100,
  "inferenceStepCount": 28,
  "additionalLoraScale": 1,
  "imagePromptStrength": 0.96,
  "loraApplicationScale": 0.39,
  "diffusionGuidanceScale": 3.75
}

Output

Upon execution, the action typically returns a URL pointing to the generated inpainted image. The output may vary based on the inputs provided and the configurations used.

Example Output:

[
  "https://assets.cognitiveactions.com/invocations/cef1921c-60ec-4cc9-879e-f5e3ba9959d7/41e89cb2-e06a-4bfb-a83a-b8bc336d6d55.jpg"
]

Conceptual Usage Example (Python)

Here’s a conceptual example in Python that demonstrates how to call the Generate Inpainted Image action:

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 = "8b5dea5d-1a29-451d-a72f-42f0b438ba34"  # Action ID for Generate Inpainted Image

# Construct the input payload based on the action's requirements
payload = {
    "prompt": "\ndynamic shots from different angles and zoomed at different body parts from the following scene: two tall, very slim, very young, skinny nerdy male students...",
    "modelType": "dev",
    "outputCount": 1,
    "enableFastMode": False,
    "imageMegapixels": "1",
    "imageAspectRatio": "1:1",
    "imageOutputFormat": "jpg",
    "imageOutputQuality": 100,
    "inferenceStepCount": 28,
    "additionalLoraScale": 1,
    "imagePromptStrength": 0.96,
    "loraApplicationScale": 0.39,
    "diffusionGuidanceScale": 3.75
}

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 snippet, replace YOUR_COGNITIVE_ACTIONS_API_KEY with your actual API key. The action_id corresponds to the Generate Inpainted Image action, and the payload contains the input based on the required schema.

Conclusion

The Generate Inpainted Image action from the andyx1976/checkshirt1 spec serves as a powerful tool for developers looking to enhance their applications with dynamic image generation capabilities. By integrating this action, you can create custom visuals tailored to your specific needs, unlocking endless possibilities for creativity and innovation in image processing. Start experimenting with different prompts and configurations to see what unique images you can generate!

← Back to All Articles