POST
/
api
/
v1
/
ingest

Create or update a content record for moderation.

​
Important Notes

  • The clientId must be unique for each record
  • File URLs in fileUrls must remain accessible for as long as the record exists
  • The user object is optional but helps provide context for moderation decisions
  • Protected users (e.g., administrators) can be marked using user.protected: true

​
Example

POST /api/v1/ingest HTTP/1.1
Host: api.iffy.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "clientId": "unique-record-id",
  "name": "Sample Record",
  "entity": "post",
  "text": "This is the content to be moderated.",
  "clientUrl": "https://yourapp.com/content/unique-record-id",
  "fileUrls": ["https://yourapp.com/files/image1.png"],
  "user": {
    "clientId": "user-12345",
    "name": "John Doe",
    "username": "johndoe"
  }
}

Authorizations

​
Authorization
string
headerrequired

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

Body

application/json
​
clientId
string
required

A unique identifier for the record, assigned by the client. Used to create or update the record.

​
name
string
required

The name or title of the record.

​
entity
string
required

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

​
text
string
required

The text content of the record to be moderated.

​
clientUrl
string

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

​
fileUrls
string[]

An array of URLs pointing to files (e.g., images, videos) associated with the record. These URLs must remain accessible for as long as the record exists.

​
user
object

Optional information about the user associated with the record.

Response

200 - application/json
​
message
string
required

A success message.

Webhook EventsDelete Record