Skip to main content
POST
Profanity detection

Authentication

Include your API key in the Authorization header:
API v2 accepts the key only in this header, not in query parameters or request bodies. See Authentication. POST /score/text with a JSON body (not a GET request).

JSON body

string
required
The text you want to filter.Sample value: This is a sample text without profanity!
string
default:"JSON"
The format command is used to get a response in a specific format.Expected values: JSON, XML, CSV, or NewlineFor more information please refer to Response format.
string
default:"live"
The mode command is used in the development stage to simulate the integration process before releasing it to the production environment.Expected values: live, or test.For more information please refer to Development environment.
string
Optional label for your own analytics or support correlation (for example a product or channel name).

Response properties

boolean
required
true when the request succeeded; false on error.
object
required
integer
required
Time taken to process the request (milliseconds).

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
text
string
required
format
string
mode
string
source
string

Response

200

OK