Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

n8n-nodes-volcengine-ai

crazyyanchao4.4kMIT0.2.3TypeScript support: included

n8n custom node for VolcEngine AI services including chat completion and code completion

n8n-community-node-package, volcengine, volcengine-ai, ai, chat-completion, code-completion, fim, llm

readme

n8n-nodes-volcengine-ai

English 中文文档

This is an n8n community node that allows you to use VolcEngine's AI services in n8n workflows, including chat completion and code completion features.

This node supports the following VolcEngine AI services:

  • Chat Completion: Provides intelligent conversation capabilities with support for multi-turn conversations and rich parameter configuration
  • FIM Completion (Fill-In-the-Middle): Provides code completion and filling functionality, supporting middle part filling in code
  • Speech Synthesis: Converts text to natural speech with support for multiple voices and audio formats
  • Image Generation: Generates high-quality images based on text descriptions with support for multiple models and output formats

Through this node, you can easily integrate VolcEngine's AI capabilities into your automation workflows to achieve intelligent conversations, content generation, code assistance, speech synthesis, image generation, and more.

n8n is a workflow automation platform with fair-code licensing.

Installation
Operations
Credentials
Compatibility
Usage Instructions
Resources

Installation

Follow the installation guide in the n8n community nodes documentation.

Alternatively, you can also refer to these n8n workflow templates.

Operations

This node supports the following resource types and operations:

Chat Completion

  • Complete Conversation: Create model responses with support for multi-turn conversations
    • Support for system messages, user messages, and assistant messages
    • Dynamic loading of available AI models
    • Rich parameter configuration options
    • Support for simplified output mode

FIM Completion (Fill-In-the-Middle Completion)

  • Code Completion: Create code fill completion
    • Support for middle part filling in code
    • Configurable prefix and suffix text
    • Support for various code completion scenarios
    • Provides code generation and editing functionality

Speech Synthesis

  • Text-to-Speech: Convert text to natural speech
    • Support for multiple voices and languages
    • Configurable parameters such as speed, volume, emotion, etc.
    • Support for multiple audio formats (MP3, OGG, PCM)
    • Provides local caching functionality

Image Generation

  • AI Image Generation: Generate high-quality images based on text descriptions
    • Support for multiple generation models (doubao-seedream series)
    • Configurable image dimensions, format, watermark, etc.
    • Support for single and multiple image generation
    • Provides multiple output formats (URL, Base64, file, etc.)

Advanced Parameter Configuration

  • Temperature Control: Control randomness of generated content (0-1)
  • Max Tokens: Set maximum length of generated content (up to 32768)
  • Frequency Penalty: Reduce generation of repetitive content (-2 to 2)
  • Presence Penalty: Encourage model to discuss new topics (-2 to 2)
  • Top-P Sampling: Control nucleus sampling diversity (0-1)
  • Response Format: Customize output format
  • Log Probabilities: Return probability information of output tokens

Credentials

To use this node, you need:

  1. Register VolcEngine Account: Visit VolcEngine Official Website to register an account
  2. Enable AI Services: Enable AI-related services in the VolcEngine console
  3. Obtain API Key: Create an API Key in the VolcEngine console
  4. Configure Credentials: Configure VolcEngine AI credentials in n8n

Authentication Methods

  • API Key Authentication: Use VolcEngine API Key for API calls, choose X-Api-Access-Key or Authorization
  • Automatic Authentication: The node automatically adds authentication information to request headers
  • Note: Currently audio uses X-Api-Access-Key, while others use Authorization authentication

Usage Instructions

Basic Usage Workflow

  1. Install Node: Follow the installation guide to install this community node
  2. Configure Credentials: Configure VolcEngine AI API credentials in n8n
  3. Create Workflow: Add VolcEngine AI node to n8n workflow
  4. Select Resource Type: Choose "Chat" or "FIM" resource type
  5. Configure Parameters: Configure model, prompts, and other parameters according to needs
  6. Execute Workflow: Run the workflow to get AI responses

Compatibility

  • Minimum n8n Version: 1.0.0
  • Node.js Version: >=22.16
  • Tested Version: n8n 1.0.0+

Resources

Note: Using this node requires a valid VolcEngine account and AI service permissions. Please ensure compliance with VolcEngine's terms of use and API call limits. Please configure appropriate access permissions based on actual usage.