Analyze text.
Analyze text with your Moderation API project.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The text you'd like to analyze. We recommend to submit plain text or HTML
1 - 100000Do not store the content. The content won't enter the review queue
The author of the content.
For example the ID of a chat room or a post
Any metadata you want to store with the content
Response
Success if the request was successful
Information about the request
Whether the content was flagged by any models
Whether the content was moderated or not. Same as content !== original
Whether the content is using look-alike characters. Often used by spammers.
Whether any entity matchers found data for the content
The original content
The content after moderation. With all mask replacements applied and look-alike characters replaced with the original characters.
The ID of the content. Only returned if the content was stored.
The NSFW model output if enabled in your project. Read more at https://docs.moderationapi.com/models/nsfw
The toxicity model output if enabled in your project. Read more at https://docs.moderationapi.com/models/toxicity
The spam model output if enabled in your project. Read more at https://docs.moderationapi.com/models/spam
The sentiment model output if enabled in your project. Read more at https://docs.moderationapi.com/models/sentiment
The propriety model output if enabled in your project. Read more at https://docs.moderationapi.com/models/propriety
The email entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/email
The phone entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/phone
The url entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/url
The address entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/address
The name entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/name
The username entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/username
The profanity entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/profanity
The sensitive numbers entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/sensitive
The wordlist entity matcher output if enabled in your project. Read more at https://docs.moderationapi.com/models/word
The wordlist entity matcher outputs if enabled in your project. Read more at https://docs.moderationapi.com/models/word
Was this page helpful?