Integration guides

n8n

Moderate images and texts in n8n with the verified OpenShield community node, on n8n Cloud and self-hosted n8n.

OpenShield is a verified n8n community node. Install it from the nodes panel on n8n Cloud, or on self-hosted n8n, then moderate an image or a text in any workflow and branch on the answer: accept, review or reject.

The package is n8n-nodes-openshield on npm. You get 2,000 free usage credits per month, no card.

Install on n8n Cloud

Verified community nodes install from the nodes panel. This also works on self-hosted n8n when verified community nodes are enabled.

  1. Open a workflow on the canvas.
  2. Open the nodes panel with + or the n key.
  3. Search for OpenShield. It appears in the More from the community section at the bottom of the panel.
  4. Select the node to open its details, then select Install.

Only the instance owner and admins can install a community node. Once it is installed, everyone on the instance can use it. See n8n's guide, Install verified community nodes.

Install on self-hosted n8n

If the node does not show in the nodes panel, install the package from the settings:

  1. Go to Settings > Community nodes.
  2. Select Install a community node, enter n8n-nodes-openshield, accept the risk notice and select Install.

See n8n's community nodes installation for the other ways to install a package.

Add your API key

  1. Create an account at openshield.dev and create an API key in the dashboard. See Authentication for keys and scopes.
  2. In n8n, add an OpenShield API credential:
FieldValue
API KeyYour live key (om_live_...). n8n sends it as Authorization: Bearer <key>.
Base URLhttps://api.openshield.dev

The credential's Test button lists your workflows: it checks no content.

What the node does

Resource > OperationWhat it checks
Image > Moderate URLAn image at a public URL, which OpenShield fetches itself.
Image > Moderate BinaryAn image from an input binary field, such as a form upload or an e-mail attachment.
Text > ModerateA text, with optional context such as the message being answered.

Each check takes the workflow to check against (default when empty) and your own ref, kept in the journal.

The node returns the API's answer as it is, plus a top-level decision field equal to summary.action: accept, review or reject. Route on it with an If or a Switch node, and publish only on accept.

The node also has a separate Fraud > Decide operation, for sign-ups and logins. It needs fraud prevention turned on for your organization.

Handle errors

A refused call stops the node with a message that says what to do: check the key (401), the key's scopes (403), or top up when the balance is used up (429 quota_exceeded). With the node's On Error setting on continue, a refused call comes back as an item with an error field and no decision: treat it like a review and do not publish the content.

Next steps

  • Pricing: what each check costs after the free credits.
  • Documentation: workflows, limits and the full API reference.
  • The package on npm: its README, version history and every error the node reports.