Overview

Moderation APIs allow you to integrate moderation capabilities into your product or application. You can use a combination of these APIs along with Stream's Moderation Dashboard to prevent app users from posting harmful content on your platform. Additionally, you can build a custom dashboard using these APIs.

Let's examine each of the moderation APIs provided by Stream.

Prerequisites

• Make sure you have created the app on Stream. If not, please refer to Guide to Getting Started with Stream
• Following API documentation presents examples from our javascript client. Please refer to our guide on Stream API and client integration to setup client.

Moderation Check Endpoint

The Moderation Check Endpoint is a powerful tool that allows customers to submit content for moderation and receive recommended actions. This versatile API can handle various types of content, including text, images, and videos.

Here's how it works:

• Customers perform a one-time setup for moderation configuration and assign it a unique key
• Customers send the content to be moderated along with the configuration key.
• The API processes the content using the specified moderation engines and rules.
• The API returns a recommended action based on the analysis results.

The recommended actions typically include:

• Keep: The content is deemed appropriate and can remain as is.
• Flag: The content is marked for further review by human moderators.
• Remove: The content is recommended for removal due to policy violations.
• Shadow Block: The content is hidden from other users without notifying the content creator (applicable to chat products only).

This endpoint provides a streamlined way to integrate content moderation into your application, ensuring a safer and more compliant user experience.