:/iffy
Ingest

Ingest record

Create or update a content record for moderation. To update a record, simply ingest the content again with the same clientId.

POST
/api/v1/ingest

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, assigned by the client. Used to create or update the record. The clientId must be unique for each record. This is usually your id for the record.

clientUrlstring

An optional URL associated with the record, such as a link to the original content.

nameRequiredstring

The name or title of the record.

entityRequiredstring

The category or type of the record (e.g., 'post', 'comment', 'message'). Helps categorize the content.

contentRequiredobject
metadataobject

Optional metadata associated with the record. Keys must be strings, values can be of any type, but will be serialized to JSON.

userobject

Optional information about the user associated with the record. The user object allows all content for a given user to be grouped (and for suspension/ban actions to operate at a user level).

curl -X POST "https://api.iffy.com/api/v1/ingest" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "post_123",
    "clientUrl": "https://example.com/posts/post_123",
    "name": "Sample Post",
    "entity": "post",
    "content": {
      "text": "This is the content to be moderated.",
      "imageUrls": [
        "https://example.com/image.jpg"
      ]
    },
    "user": {
      "clientId": "user_123",
      "name": "John Doe",
      "username": "johndoe"
    }
  }'

Record successfully created or updated.

{
  "message": "Success"
}

Previous

Delete record DELETE