plemeo Image Analysis icon

plemeo Image Analysis

Analyze images with Plemeo AI
Join our community

Overview

This node integrates with the Plemeo AI image analysis API to analyze one or more images and return descriptive information about their content. It is useful in scenarios where automated image understanding is needed, such as categorizing images, extracting metadata, or generating captions for visual content.

The node supports two modes of analysis:

  • Using the Plemeo AI proprietary model via a specified API endpoint.
  • Optionally using a HuggingFace model for image analysis if enabled.

Typical use cases include:

  • Automatically tagging images uploaded to a system.
  • Extracting insights from images for content moderation.
  • Generating textual descriptions for accessibility purposes.

Properties

Name Meaning
API Hostname The hostname of the Plemeo AI API server to which requests are sent (e.g., tenant.plemeo.ai).
API Port The port number on the Plemeo AI API server (default 8000).
API Path The path of the Plemeo Image Analysis API endpoint (default /analyze_image).
API Key The API key used for authenticating requests to the Plemeo AI API.
Use HTTP Whether to use HTTP instead of HTTPS for the API request (useful if SSL certificate issues occur).
Use HuggingFace Model Whether to use a HuggingFace model for image analysis instead of the default Plemeo AI model.
HuggingFace Access Code Access code required for authenticating with the HuggingFace API (only shown if HuggingFace model is enabled).
Message A prompt or message describing what to analyze or ask about the image(s) (default: "What does this image show?").
Images One or more images to analyze. Each image requires base64-encoded image data (PNG, JPG, etc.).

Output

The node outputs an array of JSON objects, each corresponding to the analysis result of the input images batch per execution cycle. The JSON structure depends on the response from the Plemeo AI or HuggingFace API but generally contains descriptive information about the images based on the provided prompt.

If the API returns binary data, it is not explicitly handled or output by this node; only JSON responses are processed.

Example output JSON (structure depends on API response):

{
  "result": "...",
  "details": { ... }
}

Dependencies

  • Requires network access to the configured Plemeo AI API endpoint.
  • Needs a valid API key credential for authentication.
  • Optional: If using the HuggingFace model, requires an access code for the HuggingFace API.
  • Uses Node.js built-in https or http modules for making API requests.
  • No additional external libraries beyond standard Node.js and n8n workflow utilities.

Troubleshooting

  • Missing API Hostname or API Key: The node will throw an error if these required parameters are not set.
  • No images provided: At least one image must be supplied; otherwise, an error is thrown.
  • Invalid image data: The node expects base64-encoded image data. Non-base64 characters may cause warnings or errors.
  • SSL certificate issues: If HTTPS requests fail due to SSL problems, enable the "Use HTTP" option to switch to HTTP.
  • API request failures: Network errors or non-2xx HTTP responses will cause the node to throw errors with details from the API response.
  • Response parsing errors: If the API returns invalid JSON, the node will report a parse failure.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if some fail, returning error messages in the output.

Links and References

Discussion