Documentation Index
Fetch the complete documentation index at: https://docs.akool.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Automate content moderation reduces the cost of your image, video, text, and voice moderation by accurately detecting inappropriate content. Jarvis Moderator provides services through open application programming interfaces (APIs). You can obtain the inference result by calling APIs. It helps you build an intelligent service system and improves service efficiency.- A software tool such as curl and Postman
Internationalization labels
The following content will be subject to review and detection to ensure compliance with relevant laws, regulations, and platform policies:- Advertising: Detects malicious advertising and redirection content to prevent users from being led to unsafe or inappropriate sites.
- Violent Content: Detects violent or terrorist content to prevent the dissemination of harmful information.
- Political Content: Reviews political content to ensure that it does not involve sensitive or inflammatory political information.
- Specified Speech: Detects specified speech or voice content to identify and manage audio that meets certain conditions.
- Specified Lyrics: Detects specified lyrics content to prevent the spread of inappropriate or harmful lyrics.
- Sexual Content: Reviews content related to sexual behavior or sexual innuendo to protect users from inappropriate information.
- Moaning Sounds: Detects sounds related to sexual activity, such as moaning, to prevent the spread of such audio.
- Contraband: Identifies and blocks all illegal or prohibited content.
- Profane Language: Reviews and filters content containing profanity or vulgar language.
- Religious Content: Reviews religious content to avoid controversy or offense to specific religious beliefs.
- Cyberbullying: Detects cyberbullying behavior to prevent such content from harming users.
- Harmful or Inappropriate Content: Reviews and manages harmful or inappropriate content to maintain a safe and positive environment on the platform.
- Silent Audio: Detects silent audio content to identify and address potential technical issues or other anomalies.
- Customized Content: Allows users to define and review specific types of content according to business needs or compliance requirements.
Subscribing to the Service
NOTE: This service is available only to enterprise users now. To subscribe to Jarvis Moderator, perform the following steps:- Register an AKOOL account.
- Then click the picture icon in the upper right corner of the website, and click the “APl Credentials” function to set the key pair (clientId, clientSecret) used when accessing the API and save it.
- Use the secret key pair just saved to send the api interface to obtain the access token.
- Pricing:
Content Type Credits Pricing Text 0.1C/600 characters 0.004USD/600 characters Image 0.2C/image 0.008USD/image Audio 0.5C/min 0.02USD/min Video 1C/min 0.04USD/min
Jarvis Moderator
| Parameter | Value | Description |
|---|---|---|
| x-api-key | API Key | Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded. |
| Authorization | Bearer {token} | Your API Key used for request authorization.Get Token. |
| Parameter | Type | Value | Description |
|---|---|---|---|
| content | String | url or text, when the content is a image, video, or audio, a url must be provided. When the content provided is text, it can be either text content or a url. | |
| type | Number | 1: image 2:video 3: auido 4: text | |
| language | String | When type=2 or 3 or 4, it is best to provide the language to ensure the accuracy of the results。 Supplying the input language in ISO-639-1 format | |
| webhookUrl | String | Callback url address based on HTTP request. | |
| input | String | Optional | The user defines the content to be detected in words |
We restrict image to 20MB. we currently support PNG (.png), JPEG (.jpeg and .jpg), WEBP (.webp), and non-animated GIF (.gif).
We restrict audio to 25MB, 60minute. we currently support .flac, .mp3, .mp4, .mpeg, .mpga, .m4a, .ogg, .wav, .webm
We restrict video to 1024MB, resolution limited to 1080p. we currently support .mp4, .avi
When the content provided is text, it can be either text content or a url. If it is url, we currently support .txt, .docx, .xml, .pdf, .csv, .md, .json
| Parameter | Type | Value | Description |
|---|---|---|---|
| code | int | 1000 | Interface returns business status code(1000:success) |
| msg | String | Interface returns status information | |
| data | Object | { "_id": "", "status": 1 } | _id: Interface returns data, status: the status of video: [1:queueing, 2:processing, 3:completed, 4:failed] |
Get analysis Info Result
| Parameter | Value | Description |
|---|---|---|
| x-api-key | API Key | Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded. |
| Authorization | Bearer {token} | Your API Key used for request authorization.Get Token |
| Parameter | Type | Value | Description |
|---|---|---|---|
| _id | String | NULL | video db id: You can get it based on the _id field returned by Sentiment Analysis API . |
| Parameter | Type | Value | Description |
|---|---|---|---|
| code | int | 1000 | Interface returns business status code(1000:success) |
| msg | String | OK | Interface returns status information |
| data | Object | { status:1, _id:"", result:"", final_conclusion: "" } | video_status: the status of video:【1:queueing, 2:processing, 3:completed, 4:failed】 result: sentiment analysis result【Related information returned by the detection content】 final_conclusion: final conclusion.【Non-Compliant、Compliant、Unknown】 _id: Interface returns data |
Please note that if the value of the response code is not equal to 1000, the request is failed or wrong
| Parameter | Value | Description |
|---|---|---|
| code | 1000 | Success |
| code | 1003 | Parameter error or Parameter can not be empty |
| code | 1008 | The content you get does not exist |
| code | 1009 | You do not have permission to operate |
| code | 1101 | Invalid authorization or The request token has expired |
| code | 1102 | Authorization cannot be empty |
| code | 1200 | The account has been banned |
| code | 1201 | create audio error, please try again later |
| code | 1202 | The same video cannot be translated lipSync in the same language more than 1 times |
| code | 1203 | video should be with audio |