Skip to main content
This guide explains how to integrate deAPI with a self-hosted n8n instance using the official deAPI community node. The community node provides a simpler, no-code experience compared to the HTTP Request-based approach.

Why Use the Community Node?

The n8n-nodes-deapi community node offers several advantages over manually configuring HTTP Request nodes:

Prerequisites

Before you begin, ensure you have:
The deAPI node uses webhooks to receive job completion notifications. Your n8n instance must be accessible via HTTPS for generation operations to work.

Installation

  1. In your n8n instance, go to Settings > Community Nodes
  2. Click Install a community node
  3. Enter n8n-nodes-deapi and click Install
  4. Restart n8n if prompted

Option 2: Manual Installation (docker)

If you’re running n8n via docker:
Then restart your n8n instance.

Credential Configuration

After installation, configure your deAPI credentials:
  1. In n8n, go to Credentials > Add Credential
  2. Search for deAPI API and select it
  3. Fill in the required fields:
  1. Click Save to store the credentials
The Webhook Secret is used to verify that incoming webhook notifications are genuinely from deAPI. Keep it secure and never share it publicly.

Available Operations

The deAPI node provides two node types:

Deapi Node (Regular Operations)

Use this node to perform AI operations within your workflow.
Image Operations
Image input operations (Remove Background, Upscale) accept JPG, JPEG, PNG, GIF, BMP, and WebP files up to 10 MB.
Video Operations
Video file transcription accepts MP4, MPEG, MOV, AVI, WMV, and OGG files up to 50 MB.
Audio Operations
Audio transcription accepts AAC, MP3, OGG, WAV, WebM, and FLAC files up to 20 MB.
Prompt Operations

DeapiTrigger Node (Webhook Trigger)

Use this node to start workflows when deAPI sends job status updates. This is useful for:
  • Building event-driven workflows
  • Processing results from jobs submitted outside n8n
  • Monitoring job progress across multiple systems

How the Webhook-Based Waiting Works

Generation operations (image, video, transcription) use an efficient webhook-based pattern instead of polling:
Key benefits:
  • No polling loop consuming API calls
  • Workflow pauses and frees memory during processing
  • Results include binary data ready for downstream nodes

Example Workflow: Text-to-Image Generation

This example demonstrates a simple image generation workflow.

Workflow Overview

Step 1: Add a Trigger

Add a Manual Trigger (or Schedule, Webhook, etc.) to start your workflow.

Step 2: Add the Deapi Node

  1. Add a Deapi node to your workflow
  2. Select your deAPI API credentials
  3. Configure the operation:
  1. Optionally configure:
    • Negative Prompt — Elements to exclude from the image
    • Resolution — Select image dimensions other than the default ones, depending on your needs
    • Seed — For reproducible results (use -1 for random)
    • Steps — Number of inference steps (higher = more detail)

Step 3: Run the Workflow

  1. Click Test Workflow or Execute Workflow
  2. The node will:
    • Submit the generation request to deAPI
    • Pause the workflow while waiting
    • Resume automatically when the image is ready
  3. The output contains the generated image as binary data

Using the Generated Image

The image is available in the data binary field. Connect downstream nodes to:
  • Write Binary File — Save to disk
  • Send Email — Attach to an email
  • HTTP Request — Upload to cloud storage
  • Slack/Discord — Share in a channel

Using the DeapiTrigger Node

The DeapiTrigger node listens for webhook events from deAPI, enabling event-driven workflows.

Setup

  1. Add a DeapiTrigger node to a new workflow
  2. Select your deAPI API credentials
  3. Configure event filtering:
  1. Activate the workflow to make the webhook URL live
  2. Copy the Webhook URL displayed in the node
  3. Add this URL to your deAPI Webhook Settings

Event Types


Comparison: Community Node vs HTTP Request


Troubleshooting

HTTPS Required

Generation operations require your n8n instance to be accessible via HTTPS for webhook callbacks. Solutions:
  • Use a reverse proxy (nginx, Caddy, Traefik) with SSL termination
  • Use a tunnel service (ngrok, Cloudflare Tunnel) for development
  • Ensure your SSL certificate is valid and not self-signed

Webhook Verification Failures

If you see webhook signature verification errors:
  1. Verify your Webhook Secret matches the one in deAPI Webhook Settings
  2. Ensure your n8n server clock is synchronized (signature includes timestamp)
  3. Check that no proxy is modifying the request body

Timeout Errors

Operations have a configurable Wait Timeout with defaults that vary by type: For long-running operations:
  1. Select the Deapi node
  2. Expand Options
  3. Increase Wait Timeout to allow more time

Rate Limiting

If you see “upgrade your plan” errors, you’ve hit deAPI’s rate limits. Consider upgrading your deAPI plan for higher limits.

Example Workflow Download

An example n8n workflow demonstrating all available operations is available in the GitHub repository.
  1. Download deAPI_guide.json
  2. In n8n, go to Workflows > Import from File
  3. Select the downloaded file
  4. Configure your deAPI credentials
  5. Explore the example nodes and sticky notes

Resources