Enhance Your Photos with the lucataco/codeformer Cognitive Action

23 Apr 2025
Enhance Your Photos with the lucataco/codeformer Cognitive Action

In the ever-evolving field of image processing, the ability to restore and enhance visual content is crucial for many applications. The lucataco/codeformer API offers a powerful Cognitive Action aimed at revitalizing old or AI-generated photos. This functionality allows developers to improve the quality and fidelity of facial details while also enhancing the background. By leveraging pre-built actions, developers can easily integrate sophisticated image enhancement capabilities into their applications without needing to develop complex algorithms from scratch.

Prerequisites

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

  • An API key for accessing the Cognitive Actions platform.
  • A basic understanding of how to make HTTP requests.
  • Familiarity with JSON for structuring your input and output data.

Authentication typically involves passing your API key in the header of your requests.

Cognitive Actions Overview

Restore and Enhance Face in Photos

The Restore and Enhance Face in Photos action uses the CodeFormer model to restore and enhance facial features in images. This action not only improves the quality of faces but also offers background enhancement through Real-ESRGAN, making it a versatile tool for image enhancement.

  • Category: Image Enhancement

Input

To utilize this action, you'll need to provide a JSON payload that adheres to the following schema:

{
  "image": "https://replicate.delivery/pbxt/JTjMycH2wZpm6LunkJozXGi7JKsRMbcDiuuoLjJ31z5DyTuj/codeformer.jpg",
  "upscale": 1,
  "faceUpsample": true,
  "backgroundEnhance": true,
  "codeformerFidelity": 0.7
}
  • Required Field:
    • image: URI of the input image to be processed. This must be accessible via the provided URI.
  • Optional Fields:
    • upscale: Defines the upsampling scale factor, defaulting to 2 (integer).
    • faceUpsample: A boolean indicating if faces should be upsampled for higher resolution (default: true).
    • backgroundEnhance: A boolean to enhance the image background (default: true).
    • codeformerFidelity: A number between 0 (higher quality) and 1 (higher fidelity) to control image output balance (default: 0.5).

Example Input

{
  "image": "https://replicate.delivery/pbxt/JTjMycH2wZpm6LunkJozXGi7JKsRMbcDiuuoLjJ31z5DyTuj/codeformer.jpg",
  "upscale": 1,
  "faceUpsample": true,
  "backgroundEnhance": true,
  "codeformerFidelity": 0.7
}

Output

Upon successful execution, the action will return a URI to the enhanced image:

"https://assets.cognitiveactions.com/invocations/e3ed694b-b690-4feb-bb5a-44fe497b0af4/57c8ec52-a773-44c6-8ebf-162ddbb6d0ee.png"

This output provides you with the link to the processed image, showcasing the enhancements made.

Conceptual Usage Example (Python)

Here’s a conceptual example demonstrating how to invoke this 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 = "ffa77b0b-bffd-40df-840f-66812b5c984d" # Action ID for Restore and Enhance Face in Photos

# Construct the input payload based on the action's requirements
payload = {
    "image": "https://replicate.delivery/pbxt/JTjMycH2wZpm6LunkJozXGi7JKsRMbcDiuuoLjJ31z5DyTuj/codeformer.jpg",
    "upscale": 1,
    "faceUpsample": true,
    "backgroundEnhance": true,
    "codeformerFidelity": 0.7
}

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, make sure to replace the placeholder for the API key and endpoint with your actual values. The action ID corresponds to the specific function you want to execute, and the input payload is structured according to the specified schema.

Conclusion

The lucataco/codeformer Cognitive Action provides a robust solution for restoring and enhancing photos, particularly focusing on facial details and background quality. By integrating this action into your applications, you can significantly improve the visual appeal of images, making it a valuable tool for developers working in fields such as photography, social media, and digital content creation. Explore the possibilities of image enhancement today!

← Back to All Articles