POST
/
text

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
Minimum length: 1
options
object

Response

200 - application/json
confidence
number
required

Confidence of the safety of the text from 1-100

content
string
required

The original text

filteredContent
string
required

The text with profanity replaced by *.

hash
string
required

SHA-256 hash of the text

id
string
required

The id of the text moderation

isSafe
boolean
required

Whether the text is considered safe

nsfwCategories
object[]
required
request
object
required
riskScores
object
required
sentiment
enum<string>
required

Sentiment of the text, either negative, neutral or positive

Available options:
positive,
negative,
neutral
sentimentScore
number
required

Sentiment score from 1-100 (negative, neutral, positive)

suggestedActions
object
required
summary
object
required
topics
string[]
required

General topics the text depicts, lowercase and no punctuation

meta
any | null

The metadata of the request