n8n-nodes-fineguide

This is an n8n community node that allows you to interact with the Fineguide REST API v1.

n8n is a fair-code licensed workflow automation platform.

Installation
Operations
Credentials
Compatibility
Usage
Resources

Installation

Follow the installation guide in the n8n community nodes documentation.

npm install n8n-nodes-fineguide

Operations

Bot

• Get All: List all bots for your organization
• Get: Get a specific bot by ID
• Get Status: Check if a bot is available

Session

• Create: Create a new chat session (requires anonymId)
• Get: Retrieve session details and message history
• Get All: List all sessions for a bot
• Get Messages: Get message history for a session

Message

• Send: Send a message to a session and receive bot response

Metadata

• Get: Get session metadata
• Update: Replace session metadata (PUT)
• Patch: Partially update session metadata

Credentials

This node requires Fineguide API credentials. You need to configure:

• API Token: Your Fineguide API authentication token

Compatibility

This node was developed and tested with n8n version 1.0+.

Usage

Creating a Session

1. Select "Session" as the resource
2. Choose "Create" as the operation
3. Provide the Bot ID (your bot's unique identifier)
4. Provide an Anonymous ID (a unique identifier for the user, e.g., "user-12345")
5. The node will return the created session details including the session ID

Response:

{
  "sessionId": "abc123...",
  "messages": []
}

Sending a Message

1. Select "Message" as the resource
2. Choose "Send" as the operation
3. Provide the Bot ID and Session ID
4. Enter your message content
5. The node will return both the user message and bot response

Response:

{
  "userMessage": {
    "id": "msg_user_xyz",
    "message": "Your message here",
    "role": "user"
  },
  "botResponse": {
    "message": "Bot's response here",
    "role": "assistant",
    "usage": {
      "prompt_tokens": 45,
      "completion_tokens": 78,
      "total_tokens": 123
    }
  }
}

Getting Session Details

1. Select "Session" as the resource
2. Choose "Get" as the operation
3. Provide the Bot ID and Session ID
4. The node will return session details with full message history

Example Workflow

1. Fineguide Node (Create Session) → Get session ID
   - Resource: Session
   - Operation: Create
   - Bot ID: your-bot-id
   - Anonymous ID: {{ $json.userId }}

2. Fineguide Node (Send Message) → Send user message
   - Resource: Message
   - Operation: Send
   - Bot ID: your-bot-id
   - Session ID: {{ $node["Fineguide"].json.sessionId }}
   - Message: {{ $json.userMessage }}

Resources

• n8n community nodes documentation
• Fineguide API Documentation

License

MIT