All Products
Search
Document Center

AI Guardrails:API overview

Last Updated:Mar 18, 2026

This topic lists the content detection API operations that you can call in AI Guardrails.

Overview

This topic is for users who call API operations by sending HTTP or HTTPS POST requests. If you use a software development kit (SDK), you can skip this topic.

A request URL consists of different parameters and has a fixed request structure. The URL includes common parameters, your signature, and API-specific parameters. Each API document provides a sample request URL for your reference. For readability, these sample URLs are not encoded. You must encode the URL before you send a request. After your request is authenticated using your signature, a response is returned. If the call succeeds, the response parameters are returned. If the call fails, an error message is returned. You can analyze and troubleshoot issues based on common and API-specific error codes.

Note

We recommend that you use an SDK to avoid manual signature authentication and to easily call API operations and manage resources.

Content moderation (machine-assisted moderation)

Service

Interface

Description

Image moderation

/green/image/scan

Submits a synchronous image moderation task to detect non-compliant or undesirable content in an image.

/green/image/asyncscan

Submits an asynchronous image moderation task to detect non-compliant or undesirable content in an image.

/green/image/results

Queries the result of an asynchronous image moderation task.

/green/image/feedback

Submits feedback on the result of an image moderation task.

Video moderation

/green/video/syncscan

Submits a synchronous video moderation task to detect pornography, terrorist and political content, text that violates regulations, undesirable scenes, and logos in a video.

/green/video/asyncscan

Submits an asynchronous video moderation task to detect pornography, terrorist and political content, text that violates regulations, undesirable scenes, and logos in a video.

/green/video/results

Queries the result of an asynchronous video moderation task.

/green/video/cancelscan

Cancels a video stream moderation task.

/green/video/feedback

Submits feedback on the result of a video moderation task.

Text moderation

/green/text/scan

Submits a synchronous text moderation task to detect non-compliant content, such as pornographic content, advertisements, spam, political content, and abuse, in Chinese or English text.

/green/text/feedback

Submits feedback on the result of a text moderation task.

Image and text OCR

Service

Interface

Description

General image and text OCR

/green/image/scan

Submits a synchronous OCR task to detect text in an image.

/green/image/asyncscan

Submits an asynchronous OCR task to detect text in an image.

/green/image/results

Queries the result of an asynchronous OCR task.