---
title: "n8n"
description: "Moderate images and texts in n8n with the verified OpenShield community node, on n8n Cloud and self-hosted n8n."
canonical_url: "https://www.openshield.dev/docs/integration-guides/n8n"
---
# 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`](https://www.npmjs.com/package/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](https://docs.n8n.io/integrations/community-nodes/installation-and-management/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](https://docs.n8n.io/integrations/community-nodes/installation-and-management) for the other ways to install a package.

## Add your API key

1. Create an account at [openshield.dev](https://www.openshield.dev) and create an API key in the [dashboard](https://www.openshield.dev/dashboard/keys). See [Authentication](https://www.openshield.dev/docs/authentication) for keys and scopes.
2. In n8n, add an **OpenShield API** credential:

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Value
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      API Key
    </td>
    
    <td>
      Your live key (<code>
        om_live_...
      </code>
      
      ). n8n sends it as <code>
        Authorization: Bearer <key>
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      Base URL
    </td>
    
    <td>
      <code>
        https://api.openshield.dev
      </code>
    </td>
  </tr>
</tbody>
</table>

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

## What the node does

<table>
<thead>
  <tr>
    <th>
      Resource > Operation
    </th>
    
    <th>
      What it checks
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      Image > Moderate URL
    </td>
    
    <td>
      An image at a public URL, which OpenShield fetches itself.
    </td>
  </tr>
  
  <tr>
    <td>
      Image > Moderate Binary
    </td>
    
    <td>
      An image from an input binary field, such as a form upload or an e-mail attachment.
    </td>
  </tr>
  
  <tr>
    <td>
      Text > Moderate
    </td>
    
    <td>
      A text, with optional context such as the message being answered.
    </td>
  </tr>
</tbody>
</table>

Each check takes the [workflow](https://www.openshield.dev/docs/workflows) to check against (`default` when empty) and your own `ref`, kept in the [journal](https://www.openshield.dev/docs/journal-and-ref).

The node returns the API's [answer](https://www.openshield.dev/docs/responses-and-errors) 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](https://www.openshield.dev/docs/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](https://www.openshield.dev/dashboard/billing) 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](https://www.openshield.dev/pricing): what each check costs after the free credits.
- [Documentation](https://www.openshield.dev/docs): workflows, limits and the full API reference.
- [The package on npm](https://www.npmjs.com/package/n8n-nodes-openshield): its README, version history and every error the node reports.


## Sitemap

See the full [sitemap](https://www.openshield.dev/sitemap.md) for all pages.
