Mastering Video Chroma Keying with magpai-app Cognitive Actions

24 Apr 2025
Mastering Video Chroma Keying with magpai-app Cognitive Actions

Integrating video processing capabilities into your applications can significantly enhance user engagement and creativity. The magpai-app/chroma-key specification offers a powerful Cognitive Action that allows developers to perform chroma keying on videos, enabling seamless background replacement. This article will explore how to utilize the "Apply Video Chroma Key" action, detailing its capabilities, input requirements, and output structure.

Prerequisites

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

  • An active API key for the Cognitive Actions platform.
  • Basic knowledge of JSON and HTTP requests.
  • A suitable environment for running Python scripts if you plan to execute the provided examples.

When making requests to the Cognitive Actions API, authentication typically involves passing your API key in the request headers. This will allow you to securely access the available actions.

Cognitive Actions Overview

Apply Video Chroma Key

The Apply Video Chroma Key action enables you to replace a specified color in a foreground video with a background media of your choice. This is particularly useful for creating engaging video content, allowing for dynamic backgrounds that can be tailored to your needs.

Input

The input schema for this action requires the following fields:

  • backgroundMedia (string, required): The URI of the video or image to be used as the background.
  • foregroundVideo (string, required): The URI of the foreground video that will have the chroma key effect applied.
  • color (string, optional): The color hex code to use for the chroma key (default: #00FF00).
  • stiffness (number, optional): The stiffness value for threshold clamping (default: 5, range: 0-10).
  • threshold (number, optional): The threshold level for the chroma key effect (default: 100).

Here’s an example of the JSON payload needed for this action:

{
  "color": "#00FF00",
  "stiffness": 5,
  "threshold": 100,
  "backgroundMedia": "https://replicate.delivery/pbxt/KTEDWv5sxMinOrVSfIDiX5l9fnkYsxXxJKaVbQfE2wxOX3Oh/tokyo-walk.mp4",
  "foregroundVideo": "https://replicate.delivery/pbxt/KTEDWv70zS67RO8gUHThAA7vzHIO5GFJDtzhaxK3t2KalB31/Ted-whoops-green-screen.mp4"
}

Output

Upon successful execution, the action will return a JSON object containing the URI of the processed video:

{
  "video": "https://assets.cognitiveactions.com/invocations/117da4f5-bc20-470b-b4d0-f5b222fe2b21/44a944dd-8418-49cc-aac2-8124ae329164.mp4"
}

This output provides a direct link to the video with the applied chroma key effect, ready for use in your application.

Conceptual Usage Example (Python)

Below is a conceptual Python code snippet demonstrating how to call the Cognitive Actions execution endpoint for the "Apply Video Chroma Key" 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 = "fbb075b2-2826-4a34-ab1f-c8a7d9173152" # Action ID for Apply Video Chroma Key

# Construct the input payload based on the action's requirements
payload = {
    "color": "#00FF00",
    "stiffness": 5,
    "threshold": 100,
    "backgroundMedia": "https://replicate.delivery/pbxt/KTEDWv5sxMinOrVSfIDiX5l9fnkYsxXxJKaVbQfE2wxOX3Oh/tokyo-walk.mp4",
    "foregroundVideo": "https://replicate.delivery/pbxt/KTEDWv70zS67RO8gUHThAA7vzHIO5GFJDtzhaxK3t2KalB31/Ted-whoops-green-screen.mp4"
}

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, replace YOUR_COGNITIVE_ACTIONS_API_KEY with your actual API key. The payload is structured to meet the action's input requirements, and the action ID corresponds to the "Apply Video Chroma Key" action.

Conclusion

The Apply Video Chroma Key action from the magpai-app/chroma-key specification opens up a realm of possibilities for video content creation. By allowing developers to seamlessly integrate background replacement into their applications, this action enhances user engagement and creativity. Consider experimenting with different background media and chroma key settings to see how they can elevate your projects. Happy coding!

← Back to All Articles