Help Center/ Content Moderation/ Getting Started/ Using Postman to Call Content Moderation/ Moderation (Text)
Updated on 2025-07-03 GMT+08:00
View PDF
Share

Moderation (Text)

This section provides an example of how to use Postman to call Moderation (Text), helping you quickly get familiar with the service. The procedure is as follows:

  1. Subscribe to Moderation (Text) on the Content Moderation console.
  2. Configure allowlist and blocklist dictionaries.
  3. Configure an environment. Import the prepared configuration file into the development environment.
  4. Use a token for authentication. When you call an API, a token is required for authentication.
  5. Call the service API and view the status code and error code whenever necessary.
  6. (Optional) View call statistics and call details.

Subscribing to the Service

Subscribe to Moderation (Text) by following the instructions in Subscribing to the Service.

Configuring Custom Dictionaries

You can configure allowlist and blocklist dictionaries for text moderation.

For details, see .

Configuring an Environment

Download and install Postman. Postman 7.24.0 is recommended.

Using a Token for Authentication

  1. On the Postman page, choose New > Collection, set the name, and click Create to create a collection.

  2. Right-click the created collection and select Add Request from the shortcut menu. Set the request name and click Save.

  3. Change the request mode to POST and enter the URL.

    For example, if your region is ap-southeast-1, set the URL to https://iam.ap-southeast-1.myhuaweicloud.com/v3/auth/tokens.

  4. On the Headers page, set KEY to Content-Type and VALUE to application/json.

  5. Click Body, select raw, and enter the following code in the blank area.
    Figure 1 Token-based authentication

    Replace username, ******** (login password), domainname, and project name (region where the service is deployed) with the actual values. To obtain the values of these parameters, log in to the management console and click My Credentials.

    The region where Content Moderation is deployed must be the same as the region where you call the service. In this example, the region is ap-southeast-1.

    {
    "auth": {
        "identity": {
            "methods": [
                "password"
            ],
            "password": {
                "user": {
                    "name": "username",
                    "password": "**********",
                    "domain": {
                        "name": "domainname"
                    }
                }
            }
        },
        "scope": {
            "project": {
                "name": "ap-southeast-1"
            }
        }
    }
}
  6. Click Send in the upper right corner to send the request. Obtain the token from the returned result. The token is valid for 24 hours.

Calling a Service

  1. In the Collections directory in the navigation pane of Postman, click the Moderation_text configuration file.
  2. Click Headers and copy the token value to X-Auth-Token.
    Figure 2 Entering the token
  3. Click Body and enter the text to be checked for the text parameter.
    • For details about other parameters in the body, see the Text Moderation API.
      Figure 3 Modifying the parameters
  4. Click Send to send the request and obtain the API call results. 
    {
    "request_id": "065561ff4bba1af6dd63a27c5c1371de",
    "result": {
        "details": [],
        "label": "normal",
        "suggestion": "pass"
    }
}

(Optional) Viewing the Number of Calls

  1. Log in to the Content Moderation management console.
  2. In the left navigation pane, choose Content Moderation V3 > Identification Statistics. On the Text Moderation page, you can view the identification statistics. You can set a time range and select a policy (event type) to view the change of the number of API calls within the time range.

    • Identification Statistics: total number of calls to Content Moderation, number of rejected calls, number of suspected calls, and number of passed calls within a specified period of time, helping you better learn the calls and moderation status of Content Moderation.
      • Total: total number of calls made to Content Moderation
      • Rejected: number of calls made to Content Moderation that are rejected because the text contains sensitive information
      • Suspected: number of calls made to Content Moderation that require manual review
      • Passed: number of calls made to Content Moderation that are approved
    • Data Trend: trend of the total number of calls, number of rejected calls, number of suspected calls, and number of passed calls within the specified period of time

    • Causes of Rejected Data: proportion of detection scenarios that fail to pass the review within the specified period of time
    • Causes of Suspected Data: proportion of detection scenarios that require manual review within the specified period of time