Symbiosika Assistant Chat icon

Symbiosika Assistant Chat

Chat with a Symbiosika Assistant

Overview

The Symbiosika Assistant Chat node enables interaction with Symbiosika AI assistants within an organization. It supports three main operations:

  • Get Available Assistants: Retrieves a list of AI assistant templates available for the selected organization.
  • Chat with Assistant: Sends user messages to an AI assistant, optionally continuing an existing chat or using a specific assistant template.
  • Reset Chat: Resets an ongoing chat conversation by its chat ID.

This node is useful for automating conversational workflows, integrating AI-driven chatbots into business processes, or managing multiple AI assistants across organizations.

Practical examples:

  • Fetching all AI assistants available in your company’s account to display options in a UI.
  • Sending customer queries to a specific AI assistant and receiving responses programmatically.
  • Resetting a chat session when starting a new conversation or clearing context.

Properties

Name Meaning
Organisation Name or ID Select or specify the organization to operate within. The node loads available organizations via API.
Operation Choose the action to perform:
- Chat with Assistant
- Get Available Assistants
- Reset Chat
User Input (For "Chat with Assistant") The message text to send to the assistant.
Use Existing Chat ID (For "Chat with Assistant") Whether to continue an existing chat session using a chat ID.
Chat ID (For "Chat with Assistant" when continuing) The ID of the chat session to continue.
Use Specific Assistant (For "Chat with Assistant") Whether to use a specific assistant template for the chat.
Assistant Name or ID (For "Chat with Assistant" when using a specific assistant) Select or specify the assistant template.
Chat ID (Reset Chat) (For "Reset Chat") The ID of the chat session to reset.

Output

The output JSON structure varies by operation:

  • Get Available Assistants

    {
      "assistants": [ 
        {
          "id": "string",
          "label": "string",
          "category": "string",
          ...
        }
      ]
    }
    

    Contains an array of assistant templates available for the selected organization.

  • Chat with Assistant

    {
      "assistantMessage": "string",  // The assistant's reply content
      "chatId": "string",            // The chat session identifier
      "finished": boolean,           // Whether the chat session is finished
      "render": any,                 // Additional rendering info from the assistant
      "sessionId": "string",         // Session identifier passed through input
      "meta": { ... }                // Metadata returned by the API
    }
    

    Represents the assistant's response to the user's message, including chat session details.

  • Reset Chat

    {
      "resetMessage": "string",     // Confirmation or message after resetting chat
      "chatId": "string",           // The chat session identifier that was reset
      "finished": boolean,          // Whether the chat session is finished after reset
      "render": any,                // Additional rendering info
      "sessionId": "string"         // Session identifier passed through input
    }
    

    Confirms the reset of a chat session.

Binary Data: This node does not output binary data.


Dependencies

  • Requires an API key credential for authenticating with the Symbiosika Chat API.
  • The node makes HTTP requests to the Symbiosika API endpoints:
    • /api/v1/user/organisations to load organizations.
    • /api/v1/organisation/{organisationId}/ai/templates to get assistants.
    • /api/v1/organisation/{organisationId}/ai/chat-with-template to chat.
    • /api/v1/organisation/{organisationId}/ai/reset-chat to reset chats.
  • Proper configuration of the API URL and API key in credentials is necessary.

Troubleshooting

  • Common Issues:

    • Missing or invalid API key will cause authentication failures.
    • Selecting an organization before fetching assistants is required; otherwise, the node returns a prompt to select an organization.
    • Providing no user input when chatting will throw an error.
    • Using an invalid or missing chat ID when continuing or resetting a chat will cause errors.
    • Network or API downtime can cause request failures.
  • Error Messages:

    • "Failed to load organisations: <error>": Indicates issues fetching organizations, possibly due to network or credential problems.
    • "Failed to fetch assistants: <error>": Occurs if assistants cannot be retrieved, often due to invalid organization ID or API issues.
    • "No user input provided": Thrown if the user input string is empty during chat operation.
    • "Invalid response from Symbiosika API": The API returned unexpected data format.
    • "Operation <operation> is not supported": An unsupported operation was requested.
  • Resolutions:

    • Verify API key and endpoint correctness.
    • Ensure the organization ID is selected and valid.
    • Provide required inputs such as user messages and chat IDs.
    • Check network connectivity and API service status.
    • Use the node’s “Continue On Fail” option to handle errors gracefully in workflows.

Links and References

Discussion