n8n-nodes-belakeai

This is an n8n community node. It lets you use Belake.ai in your n8n workflows.

Belake.ai is an AI platform that provides intelligent agents, chat interactions, data source management, group organization, language model integration, and workspace management to enhance your automation workflows.

n8n is a fair-code licensed workflow automation platform.

Installation
Operations
Credentials
Compatibility
Usage
Resources
Version history

Installation

Follow the installation guide in the n8n community nodes documentation.

Operations

Agent

• Get Agent by ID - Retrieves detailed information about a specific agent using its identifier
• Get Agents - Retrieves a list of all available agents

Chat

• Get Chat by ID - Retrieves a specific chat conversation using its identifier
• Get Chats - Retrieves a list of all chats
• Send Message - Sends a message to AI agents, with support for multiple agents, language specification, optional chat continuation, and chat visibility control

Datasource

• Get Datasource by ID - Retrieves detailed information about a specific datasource using its identifier
• Get Datasources - Retrieves a list of all available datasources

Group

• Get Group by ID - Retrieves detailed information about a specific group using its identifier
• Get Groups - Retrieves a list of all groups

Language Model

• Get Language Model by ID - Retrieves detailed information about a specific language model using its identifier
• Get Language Models - Retrieves a list of all available language models

Workspace

• Get Workspace by ID - Retrieves detailed information about a specific workspace using its identifier
• Get Workspaces - Retrieves a list of all workspaces

Credentials

To use this node, you need to authenticate with Belake.ai using API key authentication.

Prerequisites

1. Belake.ai Account: You need an active Belake.ai account. If you don't have one, sign up at https://www.belake.ai/
2. Backend URL: Your Belake.ai backend instance URL (e.g., https://[instance].belake.ai). All API routes use the /v1 prefix automatically.
3. API Key: Obtain your API key from the Belake.ai portal

Authentication Method

API Key Authentication - This node uses API key-based authentication where:

• You provide your Backend URL and API Key in the credential configuration
• The credentials securely store your API key (no HTTP requests are made at credential level)
• When executing a workflow, the node automatically exchanges your API key for a bearer token using n8n's built-in HTTP helpers
• The bearer token is then used for all subsequent API requests within that execution
• Authentication is handled transparently on each workflow execution

Setting Up Credentials

1. In n8n, create a new credential and select "Belake API"
2. Enter your Backend URL (must include protocol, e.g., https://[your-instance].belake.ai)
3. Enter your API Key from the Belake.ai portal
4. Click "Test" to verify your credentials work correctly
5. Save the credential

For detailed credential setup instructions, see the credentials documentation.

Compatibility

This node requires n8n version 1.0.0 or higher. It has been tested with n8n versions 1.0.0 and above.

The node uses the n8n Nodes API version 1 with strict mode enabled.

Technical Implementation

• Credentials: Store API key and backend URL without making HTTP requests (compliant with n8n best practices)
• Authentication: Token exchange is performed at node execution time using this.helpers.httpRequest()
• Request Handling: Declarative operations map with centralized authentication helper
• Type Safety: Full TypeScript support with IDataObject types (no any types)
• Error Handling: Proper error handling with support for "Continue on Fail" mode

Usage

Basic Workflow Example

A common use case is to send a message to AI agents and process the response:

1. Add a Belake.ai node to your workflow

2. Select your Belake API credentials

3. Choose the Chat resource and Send Message operation

4. Configure the message parameters:

   • Message: The message content to send
   • Agent IDs: Array of agent IDs to send the message to
   • Language: Language code (default: pt-br)
   • Chat ID (optional): For continuing an existing conversation
   • Hide Chat: Boolean to control chat visibility in response

5. Execute the workflow

Retrieving Information

To retrieve information about available resources:

1. Select the appropriate resource (Agent, Chat, Datasource, Group, Language Model, or Workspace)
2. Choose Get [Resource]s to list all available items
3. Use Get [Resource] by ID to retrieve specific item details using its identifier
4. Many operations accept an optional Workspace ID to filter results by workspace

Best Practices

• Use descriptive names for your credentials to distinguish between different Belake.ai instances or environments
• Store sensitive information like API keys securely
• Handle errors appropriately in your workflows
• Use the chat continuation feature (Chat ID) to maintain conversation context across multiple messages

Resources

• n8n community nodes documentation
• Belake.ai homepage
• Belake.ai API credentials documentation

Version history

• v1.0.3 - API v1 routes and Workspace resource (current)

  • Migrated all API endpoints to /v1 prefix
  • Replaced Department resource with Group resource
  • Added Workspace resource with Get Workspace by ID and Get Workspaces operations
  • Workspace ID field available across resources for filtering

• v1.0.2 - Architecture improvements

  • Refactored authentication to comply with n8n best practices
  • Moved token exchange from credentials to node execution
  • Implemented declarative operations map for cleaner code
  • Enhanced type safety (removed any types)
  • Improved error handling and code maintainability

• v1.0.1 - Repository updates

  • Renamed repository references and added lint file

• v1.0.0 - First release

  • Support for Agent, Chat, Datasource, Department, and Language Model resources
  • API key authentication
  • Operations for retrieving and managing Belake.ai resources
  • Chat message sending with multi-agent support and language specification