Check Profanity
Verifies whether text violates the profanity policy.
URI Fragment
/profanity
Supported Signing Methods
Client Only Signing, 3-legged Authorization Signing
 | Please refer here for the details of authentication flow and here for how to sign request to generate the Authorization header. |
HTTP Method
GET
Request Header
- The Authorization header is necessary for this call to succeed.
URL Query Parameters
Parameter Name |
Type |
Description |
Required |
|---|---|---|---|
text |
String |
User input string that should be checked. |
Yes |
format |
String |
Only "json" is accepted. |
No |
Request Body
None.
Response Status Code
HTTP Status Code |
HTTP Status Message |
Meaning |
|---|---|---|
200 |
OK |
Data successfully acquired |
400 |
Bad Request |
Corrupt request data on the client side |
401 |
Unauthorized |
Authorization error |
403 |
Forbidden |
The resource exists, but access is not possible due to a reason other than an authorization error. |
500 |
Internal Server Error |
An error on the API server side |
503 |
Service Unavailable |
The API cannot be used temporarily |
Response Body
- Validity of the string in JSON format. See below example.
- Content-Type: application/json; charset=utf-8
Example Request & Response
| The input string used below was 殺すのようなわるい言葉. It was URL encoded before being sent to the platform. |
Base String
HTTP Request
HTTP Response