POST
The Copyleaks Text Moderation API provides real-time content moderation capabilities to help you maintain safe and appropriate content across your platform. This API automatically scans and flags potentially harmful content across multiple categories, enabling you to take appropriate action to protect your users and maintain community standards.

Request

Path Parameters

string
required
A unique scan id provided by you. We recommend you use the same id in your database to represent the scan in the Copyleaks database. Learn more about the criteria for creating a Scan ID.>= 3 characters <= 36 characters

Headers

Request Body

The request body is a JSON object containing the text to scan.
string
required
Text to produce Text Moderation report for.>= 2 characters <= 25000 characters
boolean
default:"false"
Use sandbox mode to test your integration with the Copyleaks API without consuming any credits.
string
The language code of your content. Only English (en) is supported. If the language field is not specified, our system will automatically detect the language of the content; text in any other language returns 400 Bad Request.Example: "en"
array[object]
required
A list of label configurations to be used for the moderation process. Each result’s label value in moderations.text.chars.labels is the position of that label in this list, as listed in the response’s legend.>= 1 items <= 16 items

Responses