Skip to main content

Image

Displays an image widget in chat interfaces.

Common Properties

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs

  • Session Id - Unique identifier for the UI client connection.
  • Image URL - URL of the image to display.
  • Label - Optional label for the image.
  • Description - Optional description for the image.
  • Alt Text - Optional alternative text for the image.

Options

  • None

Output

  • None (this is a display-only widget)

How It Works

The Image node creates an image widget that displays an image from a URL. When executed, the node:

  1. Validates the provided Session ID and Image URL
  2. Retrieves the session information for the provided ID
  3. Creates an image widget with the specified URL, label, description, and alt text
  4. Sends the widget to the client with the specified session ID

Requirements

  • A valid session ID for an active client connection
  • Valid image URL
  • Properly configured client interface that can display image widgets

Error Handling

The node will return specific errors in the following cases:

  • Empty or invalid Session ID
  • Session not found for the provided ID
  • Image URL is required but not provided
  • Image URL is empty
  • Failed to send widget to client

Usage Notes

  • The Session ID must match an active client connection
  • The image widget is a visual element only and does not collect user input
  • The Label and Description fields are optional but can help users understand what the image represents
  • The Alt Text field is optional but provides accessibility benefits for users with screen readers
  • Images should be hosted at publicly accessible URLs