The following tables list API operations available for use in Content Moderation.
Overview
This topic is intended for users who initiate HTTP or HTTPS POST requests by using request URLs. If you use an SDK to initiate HTTP or HTTPS POST requests, you can skip this topic.
Each request URL consists of different parameters and has fixed syntax. Generally, a request URL contains common parameters, your signature, and operation-specific parameters. A sample request URL is provided for each API operation. For ease of reading, these sample URLs are not encoded. Before you initiate a request, you must encode the request URL. A response is returned to you after authentication is complete based on your signature. Response parameters are displayed if the call succeeds, and an error message appears if the call fails. You can troubleshoot issues based on common error codes and operation-specific error codes.
Note We recommend that you use an SDK to call an operation and manage your resources. If you use an SDK, manual signature authentication is not required.
Content Moderation (machine moderation)
| Service | Operation | Description |
|---|---|---|
| Image moderation | /green/image/scan | Submits image moderation tasks to moderate images for violated or undesirable content and obtains results in real time. |
| /green/image/asyncscan | Submits asynchronous image moderation tasks to moderate images for violated or undesirable content. | |
| /green/image/results | Queries asynchronous image moderation results. | |
| /green/image/feedback | Gives feedback on image moderation results. | |
| Video moderation | /green/video/syncscan | Submits video moderation tasks and obtains results in real time. This operation applies to the following video moderation scenarios: pornography detection, terrorist content detection, ad violation detection, undesirable scene detection, and logo detection. |
| /green/video/asyncscan | Submits asynchronous video moderation tasks. This operation applies to the following video moderation scenarios: pornography detection, terrorist content detection, ad violation detection, undesirable scene detection, and logo detection. | |
| /green/video/feedback | Queries asynchronous video moderation results. | |
| /green/video/cancelscan | Stops moderating video streams. | |
| /green/video/feedback | Gives feedback on video moderation results. | |
| Text moderation | /green/text/scan | Submits text moderation tasks and obtains results in real time. You can call this operation to detect undesirable content in text, such as pornographic content, ads, spam, political content, and abuse. |
| /green/text/feedback | Gives feedback on text moderation results. |
Image OCR moderation
| Service | Operation | Description |
|---|---|---|
| General image optical character recognition (OCR) | /green/image/scan | Submits OCR tasks to detect text in images and obtains results in real time. |
| /green/image/asyncscan | Submits asynchronous OCR tasks to detect text in images. | |
| /green/image/results | Queries asynchronous OCR results. |