Creating a Video Moderation Job

Function

This API is used to create a video moderation job. After the job is created, the job ID is returned.

URI

POST /v3/{project_id}/moderation/video/jobs

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token which can be obtained by calling the IAM API (The token is the value of X-Subject-Token in the response header.)

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
data	Yes	data object	Input video data
event_type	Yes	String	Event type. The options are as follows: default: default event group_message: group chat video message: private chat video live: live show dynamic: story
image_categories	Yes	Array of strings	Types of risks to be detected in video images. The list cannot be empty. terrorism: terrorism-related content porn: pornographic content image_text: non-compliant image and text content (including advertisements, pornographic content, terrorism-related content, and QR code in images)
audio_categories	No	Array of strings	Types of risks to be detected in the audio of a video. If this parameter is not set or set to null, audio of the video is not moderated. The options are as follows: porn ad moan abuse
callback	No	String	If this field is not empty, the callback will be invoked to send the detection result to your URL. If this field is empty, you need to perform polling periodically to obtain the detection result. NOTE: Your callback interface must support the POST method. For details about the callback data format, see the example response for the API used to query a video moderation job. If the callback interface of your server returns HTTP status code 200 within three seconds after receiving the result from the content security service, the result is successfully received. If another HTTP status code is returned or no status code is returned within three seconds, the result fails to be received. In this case, the content security service will send the detection result repeatedly.
seed	No	String	Used to verify the requests initiated by Huawei Cloud content security service during callback notifications. You can customize it. The value is a random string that contains a maximum of 64 characters, including letters, digits, and underscores (_). NOTE: If seed is not empty, headers contains the X-Auth-Signature field. The field value is generated using the HMAC-SHA256 algorithm. The string to be encrypted is composed of create_time, job_id, request_id, and seed in sequence. The key is seed.

**Table 4** data
Parameter	Mandatory	Type	Description
url	Yes	String	Video URL
frame_interval	No	Integer	Frame capturing interval, in seconds. The value ranges from 1s to 60s. If this parameter is not specified, frames are captured every five seconds by default.
language	No	String	Supported language. The following three languages are available: zh: Chinese en: English ar: Arabic The default value is zh.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
request_id	String	Unique ID of the request, which is used for troubleshooting. You are advised to save the ID.
job_id	String	Unique job ID

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code of a failed API call. For details, see Error Codes. This parameter is not included when the API is successfully called.
error_msg	String	Error message of a failed API call. This parameter is not included when the API is successfully called.

Example Request

Create a default video moderation job to detect pornographic and terrorism-related content in images and text.

endpoint is the request URL for calling an API. Endpoints vary depending on services and regions. For details, see Endpoints.

POST https://{endpoint}/v3/{project_id}/moderation/video/jobs
{
  "data" : {
    "url" : "https://xxxx",
    "frame_interval" : 5
  },
  "event_type" : "default",
  "image_categories" : [ "porn","terrorism", "image_text" ],
  "audio_categories" : [ "porn", "ad", "moan", "abuse" ],
  "callback" : "http://xxxx"
}

Example Response

Status code: 200

Example of a successful response

{
  "job_id" : "01661356800_7c0fe871f80543358917e4faebca4a48",
  "request_id" : "07490f57ac5e034c077ab25b5f9e1da5"
}

Status code: 400

Example of a failed response

{
  "error_code" : "AIS.0401",
  "error_msg" : "The input parameter event_type is incorrect."
}

Status Codes

Status Code	Description
200	Response body for a success
400	Response body for a failure

Parent topic: Video Moderation

Previous topic: Video Moderation

Next topic: Querying a Video Moderation Job

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot