Moderation Agent synchronous detection API

Get started

1. Register for an Alibaba Cloud account: Register now.

2. Activate pay-as-you-go for Content Moderation: Activate the service. Activation is free, and you are automatically billed based on your API usage. For more information, see Billing.

3. Create an AccessKey: Create an AccessKey. If you use an AccessKey from a RAM user, your root account must grant the AliyunYundunGreenWebFullAccess permission to that RAM user. For more information, see RAM authorization.

4. Develop and integrate: Use an SDK to make API calls. For more information, see Moderation Agent service SDK reference.

API reference

Call this API to create a detection task. You can make direct calls by constructing HTTP requests or use prebuilt requests from the SDK. For more information, see Moderation Agent service SDK reference.

• API operation: MultiModalAgent.

• Supported regions and endpoints:

  Region	Public endpoint	Internal endpoint
  China (Shanghai)	https://green-cip.cn-shanghai.aliyuncs.com	https://green-cip-vpc.cn-shanghai.aliyuncs.com
  Singapore	https://green-cip.ap-southeast-1.aliyuncs.com	https://green-cip-vpc.ap-southeast-1.aliyuncs.com

• Billing:

  This operation is a billable operation. Only requests that return an HTTP status code of 200 are metered and billed. Requests that return other error codes are not billed.

  For billing items and pricing on the China site, see the China site region block in Billing.

• Data requirements:

  • Text:

    • Text is limited to 2,000 characters per request.

  • Image:

    • A single request supports a maximum of one image.

    • Supported image formats include PNG, JPG, JPEG, BMP, WEBP, TIFF, SVG, HEIC (the longest side must be less than 8,192 pixels), GIF (only the first frame is processed), and ICO (only the last image is processed).

    • The image size cannot exceed 20 MB. The height or width cannot exceed 16,384 pixels, and the total number of pixels cannot exceed 167 million. For best detection results, use images with a resolution of at least 200x200 pixels.

    • The image must download within 3 seconds, or the request will time out.

  • Image-text multimodality:

    • The preceding text and image limits apply.

QPS limits

The QPS limit for a single user is 10 requests per second. Calls that exceed this limit are throttled, which may impact your business. Plan your calls accordingly. If you require a higher QPS limit, contact your account manager.

Debugging

Request parameters

Response data

Examples

{
	"AppID": "txt_check_agent_01",
	"ServiceParameters": {
		"content": "This is the text content to be moderated.",
		"DataId": "data123***"
	}
}

{
	"AppID": "img_check_agent_01",
	"ServiceParameters": {
		"images": [
			{
				"imageUrl": "https://aliyun.com/240308/test001.jpg"
			}
		],
		"DataId": "data123***"
	}
}

{
	"AppID": "img_txt_check_agent_01",
	"ServiceParameters": {
		"content": "This is the text content to be moderated.",
		"images": [
			{
				"imageUrl": "https://aliyun.com/240308/test001.jpg"
			}
		],
		"DataId": "data123***"
	}
}

{
	"Msg": "success",
	"Code": 200,
	"Data": {
		"DataId": "123****",
		"TaskId": "TASK1234-1234-1234-1234-123***",
		"Result": [
			{
				"Label": "CustomViolationLabelOne",
				"Description": "agent1"
			},
			{
				"Label": "CustomViolationLabelTwo",
				"Description": "agent2"
			}
		],
		"RiskLevel": "high",
		"usage": {
			"promptLength": 1379,
			"contentLength": 1376,
			"AgentDetail": {
				"agent1": {
					"promptLength": 789,
					"contentLength": 1376
				},
				"agent2": {
					"promptLength": 587,
					"contentLength": 1376
				}
			}
		}
	},
	"RequestId": "ABCD1234-1234-1234-1234-123****"
}

{
	"Msg": "success",
	"Code": 200,
	"Data": {
		"DataId": "123****",
		"TaskId": "TASK1234-1234-1234-1234-123***",
		"Result": [
			{
				"Label": "nonLabel",
				"Description": "agent1"
			},
			{
				"Label": "nonLabel",
				"Description": "agent2"
			}
		],
		"RiskLevel": "none",
		"usage": {
			"promptLength": 1379,
			"contentLength": 1376,
			"AgentDetail": {
				"agent1": {
					"promptLength": 789,
					"contentLength": 1376
				},
				"agent2": {
					"promptLength": 587,
					"contentLength": 1376
				}
			}
		}
	},
	"RequestId": "EFCH1234-1234-1234-1234-123****"
}

Status codes

This table describes the Code values returned by the API. Only requests that return a Code of 200 are billed.