Description

@hienhoceo/n8n-nodes-zukijourney

Zukijourney AI nodes for n8n – OpenAI-compatible API integration with support for chat completions, image generation, audio processing, embeddings, content moderation, and text translation.

Developed by DPS.MEDIA JSC – Leading Digital Marketing Solutions Provider since 2017

Features

• Chat Completions: Advanced chat with tool/function calling and vision capabilities
• Image Generation: Create and upscale images with various sizes and formats
• Audio Processing: Text-to-speech, speech-to-text, and audio translation
• Embeddings: Create text embeddings for semantic search and analysis
• Content Moderation: Check content for policy violations
• Model Management: List and retrieve available models
• Text Translation: Translate text between languages with auto-detection

Installation

1. Go to your n8n Settings → Community Nodes
2. Search for @hienhoceo/n8n-nodes-zukijourney
3. Click Install

⚠️ Important: After Installation/Upgrade

Restart Required: After installing or upgrading this package, you must restart n8n completely for the changes to take effect.

• Docker users: Restart your n8n container
• npm users: Restart your n8n service
• n8n Cloud: Contact support or wait for the next deployment cycle

Failure to restart may result in:

• "Unrecognized node type" errors
• Duplicate nodes appearing
• Nodes not loading properly

Configuration

🔑 Get Your API Key

Getting your Zukijourney API key is easy:

1. Join our Discord Server: https://discord.gg/zukijourney
2. Go to any channel (e.g., #ask-staff)
3. Type: /user get-key
4. Copy your API key and use it in n8n

⚙️ Configuration

Create a new Zukijourney API credential with:

• API Key: Your Zukijourney API key (obtained from Discord)
• Base URL: Your Zukijourney API base URL (e.g., https://api.zukijourney.com/v1)
• Organization: Optional organization ID

Nodes

Zukijourney (Consolidated Node)

Version 0.1.25+ introduces a single consolidated node that combines all AI operations into one powerful node, eliminating duplicate nodes and improving compatibility.

Operations Available:

• Chat Completions: Advanced chat with tool/function calling and vision capabilities
• Image Generation: Create and upscale images with various sizes and formats
• Audio Processing: Text-to-speech, speech-to-text, and audio translation
• Embeddings: Create text embeddings for semantic search and analysis
• Content Moderation: Check content for policy violations
• Text Translation: Translate text between languages with auto-detection

Key Features:

• Dynamic model loading from your Zukijourney API
• Automatic fallback to popular models if API is unavailable
• Optimized for n8n >= 1.86.0
• Single node reduces clutter and improves workflow organization

Use Cases:

• Customer service chatbots with tool integration
• Content creation pipelines with image generation
• Document analysis with embeddings and search
• Automated content moderation systems
• Multilingual applications with translation

Troubleshooting

Common Issues

"Unrecognized node type" Error

• This usually means you need to restart n8n completely
• Docker users: restart your container
• npm users: restart your n8n service

Models Not Loading

• Check your API key is correct (without "zu-" prefix)
• Verify your base URL is accessible
• Try refreshing credentials in n8n

Duplicate Nodes Appearing

• You may have an old version installed
• Uninstall the old version completely
• Restart n8n before installing the new version

Development

Project Structure

n8n-nodes-zukijourney/
├── credentials/           # API credential configuration
├── nodes/                # Consolidated node implementation
├── transport/             # HTTP request handling and mapping
├── utils/                 # Utility functions and schemas
├── tests/                 # Test cases and mocks
├── examples/              # Example workflows
└── dist/                  # Built output

Supported Formats:

• Input: WAV, MP3, OGG, FLAC, AAC
• Output: MP3, WAV, OGG, FLAC, AAC

Use Cases:

• Podcast transcription
• Voice assistant responses
• Content localization
• Accessibility features

ZukiEmbeddings

Create text embeddings for:

• Semantic search
• Document similarity
• Content clustering
• Recommendation systems

Features:

• Single or multiple text input
• Float or Base64 encoding
• Custom dimensions support
• Usage tracking

ZukiModerations

Content moderation with:

• Multi-category analysis
• Confidence scoring
• Batch processing
• Detailed violation reporting

Categories:

• Hate speech
• Sexual content
• Violence
• Self-harm

ZukiModels

Manage AI models with:

• List all available models
• Retrieve specific model details
• Model capabilities information

ZukiText

Text translation with:

• Auto language detection
• Multiple target languages
• Customizable models
• Confidence scoring

API Compatibility

This package provides OpenAI-compatible API integration with Zukijourney. All endpoints follow OpenAI's API structure and response formats.

Development

Prerequisites

• Node.js 18+
• TypeScript 5+
• n8n development environment

Setup

# Clone the repository
git clone https://github.com/hienhoceo-dpsmedia/n8n-nodes-zukijourney.git
cd n8n-nodes-zukijourney

# Install dependencies
npm install

# Build the package
npm run build

# Run tests
npm test

# Run linting
npm run lint

Project Structure

n8n-nodes-zukijourney/
├── credentials/           # API credential configuration
├── nodes/                # Individual node implementations
├── transport/             # HTTP request handling and mapping
├── utils/                 # Utility functions and schemas
├── tests/                 # Test cases and mocks
├── examples/              # Example workflows
└── dist/                  # Built output

Testing

The package includes comprehensive tests for all nodes:

# Run all tests
npm test

# Run tests with coverage
npm run test:coverage

# Watch tests during development
npm run test:watch

Examples

Basic Chat Completion

{
  "nodes": [
    {
      "parameters": {
        "operation": "create",
        "model": "gpt-3.5-turbo",
        "messages": {
          "messages": [
            {
              "role": "user",
              "content": "Hello, how are you?"
            }
          ]
        }
      },
      "id": "zuki-chat",
      "name": "ZukiChat",
      "type": "n8n-nodes-base.zukiChat",
      "typeVersion": 1
    }
  ]
}

Image Generation

{
  "nodes": [
    {
      "parameters": {
        "operation": "generate",
        "model": "dall-e-3",
        "prompt": "A beautiful sunset over mountains",
        "size": "1024x1024",
        "n": 1,
        "responseFormat": "url"
      },
      "id": "zuki-images",
      "name": "ZukiImages",
      "type": "n8n-nodes-base.zukiImages",
      "typeVersion": 1
    }
  ]
}

Text-to-Speech

{
  "nodes": [
    {
      "parameters": {
        "operation": "speech",
        "model": "tts-1",
        "input": "Hello, this is a test message",
        "voice": "alloy",
        "format": "mp3"
      },
      "id": "zuki-audio",
      "name": "ZukiAudio",
      "type": "n8n-nodes-base.zukiAudio",
      "typeVersion": 1
    }
  ]
}

Troubleshooting

Common Issues

4xx Errors: Check your API key and base URL configuration
429 Errors: Enable retry/backoff or reduce request rate
Streaming Issues: Disable "Combine stream" to view raw chunks
Timeout Errors: Increase timeout in node settings

Debug Mode

Enable debug mode in n8n to see detailed API requests and responses.

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests for new functionality
5. Run linting and tests
6. Submit a pull request

License

MIT License – see LICENSE file for details.

🤝 Support & Community

• Discord Community: https://discord.gg/zukijourney
• GitHub Issues: https://github.com/hienhoceo-dpsmedia/n8n-nodes-zukijourney/issues
• n8n Community: https://community.n8n.io/
• Zukijourney Documentation: https://docs.zukijourney.com

🏢 About DPS.MEDIA

CÔNG TY CỔ PHẦN DPS.MEDIA
📍 56 Nguyễn Đình Chiểu, Phường Tân Định, Thành phố Hồ Chí Minh, Việt Nam
📞 0961545445
🌐 https://dps.media/

DPS.MEDIA JSC is a leading Digital Marketing Solutions provider with extensive experience since 2017, serving over 5,400 SME customers with comprehensive digital transformation solutions.

Our Services:

• Digital Marketing Strategy
• SEO & Content Marketing
• Social Media Management
• Web Development & Design
• AI & Automation Solutions
• E-commerce Optimization

Why Choose Us:

• ✅ 7+ years industry experience
• ✅ 5,400+ satisfied customers
• ✅ Expert team of digital specialists
• ✅ Cutting-edge technology solutions
• ✅ Results-driven approach

Get in touch: contact@dps.media

Changelog

v0.1.0

• Initial release
• Support for all Zukijourney API endpoints
• Comprehensive test coverage
• OpenAI-compatible API integration