This page explains how to install the Davix H2I n8n community node, add credentials, and prepare it for use in workflows.
Installation model #
The package is distributed as n8n-nodes-davix-h2i and is structured as an n8n community node package. The repository documentation describes two installation methods:
- installation through the n8n Community Nodes UI
- installation through npm for self-hosted environments
The node display name exposed in n8n is Davix H2I.
Runtime and compatibility requirements #
The package declares a Node.js runtime requirement of >=20. The repository documentation also shows Node 20 in its CI and publish workflows.
The analyzed package metadata does not declare a pinned minimum or maximum n8n core version. Instead, the repository declares peerDependencies.n8n-workflow: "*".
Install through the n8n Community Nodes UI #
One documented installation method is the n8n Community Nodes UI. The repository documentation identifies this as one of the supported installation paths.
After a successful installation, the node should appear in n8n as Davix H2I. That is the display name defined in the node implementation.
[Image placeholder — n8n Community Nodes installation screen showing the Davix H2I package]
Install through npm for self-hosted n8n #
The second documented installation method is npm installation for self-hosted setups. The repository documentation explicitly documents installation using:
npm install n8n-nodes-davix-h2i
The package is published as an npm distribution for use in n8n, and the published output is built from the repository’s compiled package artifacts.
What gets installed #
The repository contains:
- one node definition: Davix H2I
- one credential type: Davix H2I (PixLab) API
The node class is implemented as DavixH2I, and the credential type is implemented as DavixH2IApi. The node definition declares one required credential reference to davixH2IApi.
Verify that installation succeeded #
After installation, the node should be available in n8n with these implementation-defined characteristics:
- display name:
Davix H2I - default node instance name:
Davix H2I - group:
transform - version:
1
The node exposes a top-level Resource selector with these options:
- H2I (HTML → Image)
- Image (Transform / Export PDF)
- PDF (Merge/Split/Compress/Convert)
- Tools (Analyze Images)
If you can add the node to a workflow and see that Resource selector, the node is installed and loaded correctly.
[Image placeholder — n8n node editor showing the Davix H2I node added to a workflow]
Add credentials #
The node requires one credential type: Davix H2I (PixLab) API. Its internal credential name is davixH2IApi, and the node declares it as required.
The credential form contains two required fields.
Base URL #
- internal name:
baseUrl - type:
string - required:
true - default:
https://pixlab.davix.dev - placeholder:
https://pixlab.davix.dev - description:
PixLab API base URL (no trailing slash). Example: https://pixlab.davix.dev
API Key #
- internal name:
apiKey - type:
string - required:
true - default: empty string
- password-style input: enabled through
typeOptions: { password: true } - description:
Your Davix PixLab API key.
[Image placeholder — n8n credential screen showing Base URL and API Key fields]
Base URL requirements #
The helper code validates the configured Base URL at runtime before requests are sent. The enforced rules are:
- the Base URL must not be empty
- it must be a valid absolute URL
- it must use HTTPS
- it must not include embedded credentials such as
username:password@host
The default configured value in the credential definition is:
https://pixlab.davix.dev
Authentication setup #
The node sends authentication using the custom HTTP header x-api-key. The shared request helper reads the stored credential values and injects that header on outbound requests. The analyzed source files do not document Bearer-token mode or OAuth flows for this node.
Once a valid API key has been saved in the credential, that credential can be selected when you use the node in workflows.
What happens after credentials are saved #
After credentials are configured, the node builds requests by:
- reading the selected resource and operation from the node UI
- reading the configured
davixH2IApicredential - validating the Base URL and API key
- injecting
x-api-key - sending the request to the endpoint path for the selected resource
The runtime endpoint paths documented in the node are:
/v1/h2i/v1/image/v1/pdf/v1/tools
These paths are combined with the configured Base URL by the shared request helper.
First-use verification inside the node #
After installation and credential setup, a basic first-use verification is:
- Add the Davix H2I node to a workflow.
- Select the configured Davix H2I (PixLab) API credential.
- Confirm that the Resource selector is available.
- Choose one of the supported resources: H2I, Image, PDF, or Tools.
At that point, the node is installed, credentialed, and ready for operation-specific configuration.
Build and package facts relevant to installation #
The repository is TypeScript-based, and the documented build command is:
npm run build
which runs:
tsc && npm run copy:icons
The repository also documents a watch-mode development script:
npm run dev
which runs:
tsc --watch
These details are mainly relevant when working from source. For normal installation, the documented paths remain the n8n Community Nodes UI and npm package installation.
Installation outcomes you should expect #
A correct installation and setup gives you:
- the Davix H2I node in the n8n editor
- the Davix H2I (PixLab) API credential type
- access to the four documented resources: H2I, Image, PDF, and Tools
- the ability to configure requests through the node’s resource-specific operation and field model
If installation succeeds but requests fail at runtime, the next page to consult should be Authentication and Credentials, because credential validation and Base URL validation are part of the runtime request path.
