API overview
Updated at:
API standards and multilingual preset SDKs
The OpenAPI of this product (Green/2018-05-09) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Common
|
API |
Title |
Description |
| GetGroups | Get group list | Retrieves all group information for individuals under an account. |
| UploadCredentials | Generate an upload credential | Generates an upload credential before uploading a file. |
Face
|
API |
Title |
Description |
| AddFaces | Add face image to individual | Adds a face image to an individual for retrieval. The individual must be created in advance. |
| DeleteFaces | Delete face images | Deletes one or more face images of a specified individual from an individual library. |
| DetectFace | Face detection and localization | Detects attribute content of a specified face image (such as whether the person is smiling or wearing glasses). |
Image
|
API |
Title |
Description |
| ListSimilarityImages | List images | Queries all image samples and their metadata in a specified image library. |
| ImageAsyncScan | Asynchronous image risk detection | Identifies multiple risk scenarios in images, including pornography, terrorism-related sensitive content, text, faces, advertisements, and QR codes. |
| ImageAsyncScanResults | Retrieve asynchronous image detection results | Retrieves the results of asynchronous image detection. |
| ImageSyncScan | Image synchronous risk detection | Detects whether an image contains risky content. |
| ImageAsyncManualScan | Manual image review | Submits an image manual review request. |
| ImageAsyncManualScanResults | Retrieve manual review results of an image | Retrieves the manual review results of an image. |
| ImageScanFeedback | Image scan feedback | Reports images that are inaccurately identified by the machine. |
Similar image
|
API |
Title |
Description |
| AddSimilarityImage | Add similar image samples | Adds one or more images to an image library for retrieval. |
| AddSimilarityLibrary | Create an image library | Creates one or more image libraries under an account (UID) for image retrieval. |
| DeleteSimilarityImage | Remove similar image samples | Deletes one or more images from a similar image library. |
| DeleteSimilarityLibrary | Delete specified image libraries | Deletes one or more image libraries from an account. |
| GetSimilarityImage | Retrieve similar image information | Queries the metadata of sample images in a specified similar image library. |
| GetSimilarityLibrary | Query information about a specified image library | Queries the information about all image libraries under an account. |
| ListSimilarityLibraries | Retrieve image libraries | Queries all image libraries and their metadata under an account. |
Video
|
API |
Title |
Description |
| VideoAsyncScan | Asynchronous video file risk detection | Submits an asynchronous risk detection request for a video file. |
| VideoAsyncScanResults | Query video risk asynchronous detection task results | Retrieves the manual review result of a video file. The result is returned in JSON format. |
| VideoCancelScan | Stop video detection | Stops video risk detection. |
| VideoFeedback | Video detection result feedback | Provides feedback on inaccurate machine recognition results for video information. |
| VideoSyncScan | Asynchronous video moderation | Detects whether a video contains risky content. |
| VideoAsyncManualScan | Asynchronous manual video review | Submits an asynchronous manual review request for a video file. |
| VideoAsyncManualScanResults | Retrieve asynchronous manual review results | Retrieves the manual review result of a video file. The result is returned in JSON format. |
Live stream
|
API |
Title |
Description |
| LiveStreamAsyncScan | Asynchronous live stream scan | Submits an asynchronous detection request for a live stream to detect risky content in the live stream. |
| LiveStreamAsyncScanResults | Live stream asynchronous scan results | Retrieves the asynchronous scan results of a live stream. |
| LiveStreamCancelScan | Cancel live stream scan | Cancels a live stream moderation task that is in progress. |
Video on demand
|
API |
Title |
Description |
| VodAsyncScan | Asynchronous scan for on-demand videos | Detects whether on-demand videos contain risky content. |
| VodAsyncScanResults | Retrieve asynchronous scan results of on-demand videos | Retrieves the asynchronous scan results of on-demand videos. |
Audio
|
API |
Title |
Description |
| VoiceAsyncScan | Submit asynchronous speech moderation task | Submits an asynchronous speech moderation task to detect risks in audio files or audio streams. |
| VoiceAsyncScanResults | Query voice asynchronous detection results | Queries the detection results of a voice stream or voice file. |
| VoiceCancelScan | Cancel an audio detection task | Cancels a submitted audio detection task that is currently being processed. |
| VoiceSyncScan | Short audio synchronous detection | Detects spam in real-time audio streams or audio files. |
| VoiceAsyncManualScan | Submit audio file for manual review | Submits an audio file to the Content Moderation service for manual review. The results must be retrieved asynchronously. |
| VoiceAsyncManualScanResults | Query manual voice review results | Queries the results of manual voice review. The results are returned in JSON format. |
Text
|
API |
Title |
Description |
| TextAsyncManualScan | Manual text review | Submits an asynchronous manual review request for text content. |
| TextAsyncManualScanResults | Retrieve manual text review result | Retrieves the result of manual text review. The result is returned in JSON format. |
| TextFeedback | Provide feedback on text anti-spam results | Provides feedback on text content that was inaccurately identified by the machine. |
| TextScan | Text scan | Detects spam and keywords in text. |
File
|
API |
Title |
Description |
| FileAsyncScan | Asynchronous file scan | Asynchronously detects risky content in document files such as PDF and Word files. |
| FileAsyncScanResults | Query asynchronous file scan results | Queries the detection results of asynchronous file scanning. |
Web page
|
API |
Title |
Description |
| WebpageAsyncScan | Asynchronous web page content moderation | Submits an asynchronous risk scan request for an HTML web page. The results must be retrieved asynchronously. |
| WebpageAsyncScanResults | Query webpage asynchronous detection results | Queries the risk detection results of an HTML page. The results are returned in JSON format. |
| WebpageSyncScan | Synchronous webpage content moderation | Synchronously detects content risks in an HTML page. |
Individual
|
API |
Title |
Description |
| AddGroups | Add an individual to a specified group | Adds an individual to a specified group. You must specify a group when retrieving an individual. |
| AddPerson | Create an individual | Creates an individual with optional properties such as name and ID. |
| DeleteGroups | Delete individual groups | Deletes one or more individual groups. |
| DeletePerson | Delete individuals | Deletes one or more individuals from an individual library. |
| SetPerson | Set individual information | Sets information such as the name and ID of an individual. |
| GetFaces | Query individual information | The individual name, associated face image IDs, and group IDs to which the individual belongs. |
| GetPerson | Retrieve individual information | Retrieves the property information of a specified individual. |
| GetPersons | Retrieve individual list information | Retrieves individual information from a specified individual group. |
Other
|
API |
Title |
Description |
| AddVideoDna | Add video fingerprint | Adds a video fingerprint. |
| AddVideoDnaGroup | Add a video group | Adds a video DNA group. |
| DeleteVideoDna | Delete video animated screenshots | Deletes a video DNA. |
| DeleteVideoDnaGroup | Delete a video fingerprinting group | Deletes a video fingerprinting group. |
| FileAsyncScanV2 | Detect document content (new version) | Detects content in files of the new version. Supports common office document formats. |
| VoiceIdentityCheck | Set voice manual review status | Sets the status of manual voice review. |
| VoiceIdentityRegister | Create individual recognition | Creates a voice individual recognition entry. |
| VoiceIdentityStartCheck | Set entity recognition algorithm | Sets the entity speech recognition algorithm. |
| VoiceIdentityStartRegister | Start speech entity recognition | Starts the entity speech recognition algorithm. |
| VoiceIdentityUnregister | Unregister a voice-registered face | Unregisters a voice-registered face. |
Is this page helpful?