:/iffy
Moderate

Moderate record

Moderate a record and return results immediately

POST
/api/v1/moderate

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonRequired
clientIdRequiredstring

A unique identifier for the record

clientUrlstring

Optional URL associated with the record

Format: "uri"
nameRequiredstring

The name or title of the record

entityRequiredstring

The category or type of the record

contentRequiredstring | object
metadataobject

Optional metadata associated with the record. Keys must be strings, values can be of any type. Keys can't be more than 40 characters or include '[' or ']'. Values must be serializable and can't be more than 500 characters. Maximum 50 keys.

userobject

Optional information about the user associated with the record

passthroughboolean

Whether to moderate the content without persisting it. If passthrough is true, the record name and content (and user email, name, and username) will not be stored.

Default: false
curl -X POST "https://api.iffy.com/api/v1/moderate" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "string",
    "clientUrl": "http://example.com",
    "name": "string",
    "entity": "string",
    "content": "string",
    "metadata": {},
    "user": {
      "clientId": "string",
      "clientUrl": "http://example.com",
      "stripeAccountId": "string",
      "email": "user@example.com",
      "name": "string",
      "username": "string",
      "protected": true,
      "metadata": {}
    },
    "passthrough": false
  }'

Content successfully moderated

{
  "id": "string",
  "status": "Compliant",
  "moderation": "string",
  "user": "string"
}

Previous

Ingest record POST