Content moderation
Analyze object.
Account
Content moderation
Actions
Wordlist (Enterprise)
Authors (Enterprise)
Content moderation
Analyze object.
Analyze an object with multiple fields including text, images, video, audio. Use to moderate a post, a profile, a form submission or anything that have multiple fields.
POST
/
moderate
/
object
curl -X POST 'https://moderationapi.com/api/v1/moderate/object' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"value": {
"type": "profile",
"data": {
"username": {
"type": "text",
"value": "johndoe123"
},
"bio": {
"type": "text",
"value": "Hello, I am John Doe!"
},
"avatar": {
"type": "image",
"value": "https://example.com/avatar.jpg"
}
}
},
"contentId": "profile-123",
"authorId": "user-123",
"metadata": {
"source": "registration"
}
}'
{
"status": "<string>",
"contentId": "<string>",
"request": {
"timestamp": 123,
"quota_usage": 123
},
"flagged": true,
"unicode_spoofing": true,
"data_found": true,
"labels": [
{
"label": "<string>",
"model": "<string>",
"score": 0.5
}
],
"entities": [
{
"model": "<string>",
"matches": [
"<string>"
],
"score": 123
}
],
"wordlists": [
{
"mode": "BLOCKLIST",
"found": true,
"matches": [
"<string>"
],
"components": "<any>",
"error": "<string>",
"warning": "<string>",
"flagged": true,
"name": "<string>",
"id": "<string>",
"score": 123
}
],
"fields": [
{
"key": "<string>",
"flagged": true,
"flagged_by": [
"<string>"
]
}
]
}
curl -X POST 'https://moderationapi.com/api/v1/moderate/object' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"value": {
"type": "profile",
"data": {
"username": {
"type": "text",
"value": "johndoe123"
},
"bio": {
"type": "text",
"value": "Hello, I am John Doe!"
},
"avatar": {
"type": "image",
"value": "https://example.com/avatar.jpg"
}
}
},
"contentId": "profile-123",
"authorId": "user-123",
"metadata": {
"source": "registration"
}
}'
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/json
Successful response
The response is of type object
.
Was this page helpful?
curl -X POST 'https://moderationapi.com/api/v1/moderate/object' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"value": {
"type": "profile",
"data": {
"username": {
"type": "text",
"value": "johndoe123"
},
"bio": {
"type": "text",
"value": "Hello, I am John Doe!"
},
"avatar": {
"type": "image",
"value": "https://example.com/avatar.jpg"
}
}
},
"contentId": "profile-123",
"authorId": "user-123",
"metadata": {
"source": "registration"
}
}'
{
"status": "<string>",
"contentId": "<string>",
"request": {
"timestamp": 123,
"quota_usage": 123
},
"flagged": true,
"unicode_spoofing": true,
"data_found": true,
"labels": [
{
"label": "<string>",
"model": "<string>",
"score": 0.5
}
],
"entities": [
{
"model": "<string>",
"matches": [
"<string>"
],
"score": 123
}
],
"wordlists": [
{
"mode": "BLOCKLIST",
"found": true,
"matches": [
"<string>"
],
"components": "<any>",
"error": "<string>",
"warning": "<string>",
"flagged": true,
"name": "<string>",
"id": "<string>",
"score": 123
}
],
"fields": [
{
"key": "<string>",
"flagged": true,
"flagged_by": [
"<string>"
]
}
]
}