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