POST
/
moderate
/
text

Authorizations

Authorization
string
header
required

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

Body

application/json
value
string
required

The text you'd like to analyze. We recommend to submit plain text or HTML

Required string length: 1 - 100000
authorId
string

The author of the content.

contentId
string

The unique ID of the content in your database.

Required string length: 1 - 100
contextId
string

For example the ID of a chat room or a post

doNotStore
boolean

Do not store the content. The content won't enter the review queue

metadata
object

Any metadata you want to store with the content

Response

200 - application/json
content
string
required

The content after moderation. With all mask replacements applied and look-alike characters replaced with the original characters.

content_moderated
boolean
required

Whether the content was moderated or not. Same as content !== original

data_found
boolean
required

Whether any entity matchers found data for the content

flagged
boolean
required

Whether the content was flagged by any models

original
string
required

The original content

request
object
required

Information about the request

status
string
required

Success if the request was successful

unicode_spoofing
boolean
required

Whether the content is using look-alike characters. Often used by spammers.

address
object

The address entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/address

contentId
string

The ID of the content. Only returned if the content was stored.

email
object

The email entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/email

name
object

The name entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/name

nsfw
object

The NSFW model output if enabled in your project. Read more at https://docs.moderationapi.com/models/nsfw

phone
object

The phone entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/phone

profanity
object

The profanity entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/profanity

propriety
object

The propriety model output if enabled in your project. Read more at https://docs.moderationapi.com/models/propriety

quality
object

The spam model output if enabled in your project. Read more at https://docs.moderationapi.com/models/spam

sensitive
object

The sensitive numbers entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/sensitive

sentiment
object

The sentiment model output if enabled in your project. Read more at https://docs.moderationapi.com/models/sentiment

toxicity
object

The toxicity model output if enabled in your project. Read more at https://docs.moderationapi.com/models/toxicity

url
object

The url entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/url

username
object

The username entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/username

wordlist
object

The wordlist entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/word

wordlists
object[]

The wordlist entity matcher outputs if enabled in your project. Read more at https://docs.moderationapi.com/models/word

{key}
any

Was this page helpful?