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

​
Authorization
string
header
required

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

Body

application/json
​
value
object
required

The object you want to analyze.

​
contentId
string

The unique ID of the content in your database.

Required string length: 1 - 100
​
doNotStore
boolean

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

​
authorId
string

The author of the content.

​
contextId
string

For example the ID of a chat room or a post

​
metadata
object

Any metadata you want to store with the content

Response

200
application/json
Successful response
​
status
string
required

Success if the request was successful

​
request
object
required

Information about the request

​
flagged
boolean
required

Whether the content was flagged by any models

​
unicode_spoofing
boolean
required

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

​
data_found
boolean
required

Whether any entity matchers found data for the content

​
labels
object[]
required

The scores of each label

​
entities
object[]
required

The entities found in the content

​
fields
object[]
required

The fields in the object and their flags

​
contentId
string

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

​
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?