Create Stunning Holiday Designs with the fofr/flux-xmas-sweater Cognitive Actions

23 Apr 2025
Create Stunning Holiday Designs with the fofr/flux-xmas-sweater Cognitive Actions

The fofr/flux-xmas-sweater API offers powerful Cognitive Actions that allow developers to generate unique images with a festive flair, perfect for creating holiday-themed content. Among the offered actions, the ability to utilize inpainting techniques provides an innovative way to control and customize image generation, ensuring high-quality outputs that can be tailored to specific artistic visions. This post explores the available action and guides you through integrating it into your applications.

Prerequisites

Before diving into the Cognitive Actions, ensure you have the following:

  • An API key for the Cognitive Actions platform.
  • Basic understanding of JSON and RESTful API concepts.
  • Familiarity with programming in Python.

To authenticate requests, you will typically pass your API key in the headers of your HTTP requests.

Cognitive Actions Overview

Generate Image with Inpainting

Description:
This action allows you to generate an image using inpainting techniques by providing an image and its corresponding mask. It offers detailed control over the generation process, including model selection, image dimensions, and quality. The 'dev' model option ensures high-quality output, while the 'schnell' model optimizes for speed.

Category: image-generation

Input

The input schema for this action requires a prompt and allows for various optional parameters:

  • prompt (string, required): A text prompt guiding the generated image. For example:
    "a photo of a model wearing a green patterned XMAS_SWEATER with the text “fofr” and a monstera leaf pattern"
  • mask (string, optional): The URI of the image mask for inpainting.
  • seed (integer, optional): Seed for reproducible output.
  • image (string, optional): URI of the input image for transformation or inpainting mode.
  • width (integer, optional): Width of the generated image in pixels (256 to 1440).
  • height (integer, optional): Height of the generated image in pixels (256 to 1440).
  • modelType (string, optional): Choose between "dev" (default) or "schnell" for model type.
  • outputCount (integer, optional): Number of images to produce, ranging from 1 to 4.

Example Input:

{
  "prompt": "a photo of a model wearing a green patterned XMAS_SWEATER with the text “fofr” and a monstera leaf pattern",
  "modelType": "dev",
  "outputCount": 1,
  "mainLoraScale": 1,
  "enableFastMode": false,
  "approxMegapixels": "1",
  "imageAspectRatio": "1:1",
  "imageOutputFormat": "webp",
  "imageGuidanceScale": 3,
  "imageOutputQuality": 80,
  "inferenceStepCount": 28,
  "additionalLoraScale": 1,
  "inputPromptStrength": 0.8
}

Output

The action returns an array of URLs pointing to the generated images. The example output for the action would look like this:

Example Output:

[
  "https://assets.cognitiveactions.com/invocations/37544ce6-61f1-4463-88b3-4c63a3d36fb5/1e4e5309-6517-4ffe-9263-fb7c9b3e63fb.webp"
]

Conceptual Usage Example (Python)

Here’s how you might invoke the 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 = "250030cb-9956-42a7-ad96-8b833d830aa4"  # Action ID for Generate Image with Inpainting

# Construct the input payload based on the action's requirements
payload = {
  "prompt": "a photo of a model wearing a green patterned XMAS_SWEATER with the text “fofr” and a monstera leaf pattern",
  "modelType": "dev",
  "outputCount": 1,
  "mainLoraScale": 1,
  "enableFastMode": False,
  "approxMegapixels": "1",
  "imageAspectRatio": "1:1",
  "imageOutputFormat": "webp",
  "imageGuidanceScale": 3,
  "imageOutputQuality": 80,
  "inferenceStepCount": 28,
  "additionalLoraScale": 1,
  "inputPromptStrength": 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 example, ensure you replace the placeholders with your actual API key and endpoint. The action ID and the structured input payload are crucial for generating the desired output.

Conclusion

The fofr/flux-xmas-sweater Cognitive Actions empower developers to create visually appealing images tailored for the holiday season. By leveraging the inpainting capabilities, you can produce unique designs that capture the festive spirit. Explore further possibilities with this action, and consider integrating it into your applications for enhanced visual content creation!

← Back to All Articles