Endpoints
Confused about "Endpoints"?
Let us know how we can improve our documentation:
Stateful endpoint
Copied!Confused about "Stateful endpoint"?
Let us know how we can improve our documentation:
Content can be moderated in a “stateful” way to provide seamless integration for customers. Enabling moderation for stream chat customers is as easy as a switch and will enable all its exclusive features with a click.
Integrating with the stateful moderation endpoint allows having the full automod moderation experience with a human in the loop. Advanced Moderation dashboard access will be given where messages can be moderated based on the input of the AI engine as well the human moderators in addition to many exciting features to reduce the effort needed to the minimum.
URL
Copied!Confused about "URL"?
Let us know how we can improve our documentation:
Request parameters
Copied!Confused about "Request parameters"?
Let us know how we can improve our documentation:
Responses
Copied!Confused about "Responses"?
Let us know how we can improve our documentation:
201 - Successful response:
Copied!| name | type | description | default | optional |
|---|---|---|---|---|
| task | ChatMessageTaskResponse | ChatMessageTaskResponse Object | - | |
| duration | string | The duration time of the request | - |
Stateless endpoint
Copied!Confused about "Stateless endpoint"?
Let us know how we can improve our documentation:
Content can be moderated in a “stateless” way, without defining rules up front, by passing one or more desired evaluations in the request. This allows, third-party providers to use the AutoMod API as an external service for moderating text. In the future, we will support multiple types of content for moderation such as images, videos, etc.
URL
Copied!Confused about "URL"?
Let us know how we can improve our documentation:
Request parameters
Copied!Confused about "Request parameters"?
Let us know how we can improve our documentation:
Responses
Copied!Confused about "Responses"?
Let us know how we can improve our documentation:
201 - Successful Response:
Copied!| name | type | description | default | optional |
|---|---|---|---|---|
| task | TaskResponseObj | TaskResponse Object | - | |
| duration | string | The duration time of the request | - |
Evaluations Object
Copied!Confused about "Evaluations Object"?
Let us know how we can improve our documentation:
| name | type | description | default | optional |
|---|---|---|---|---|
| type | string | The Evaluation type. Can be one of spam_commercial, platform_circumvention or semantic_filter | - | |
| score | float32 | The score from the result of the evaluation against the filter | - | |
| phrase_list_ids | []int | List of Phrase List ID's, applicable to semantic_filter | - | ✓ |
| matches | []MatchObj | List of Match objects which contain only the type for comparing the results | - | ✓ |
Task Response Object
Copied!Confused about "Task Response Object"?
Let us know how we can improve our documentation:
| name | type | description | default | optional |
|---|---|---|---|---|
| id | string | Unique Identifier | - | |
| status | string | The status of the task | - | |
| content_type | string | Type of payload for this task, can be one of: text, image | - | |
| payload | PayloadObj | The (serialized) payload for this content type, typically consists of text field that represents the message to be moderated | - | |
| extra | ExtraObj | Object with data that needs to be stored for this task, eg. fields relevant for the user to identify the content in 3rd party systems, custom metadata, etc. | - | ✓ |
| evaluations | []EvaluationObj | List of evaluations with scores from the responses | - | |
| rule | RuleResponseObj | The rule object containing the filter, evaluations, condition and triggers for this task | - | ✓ |
| triggers | []TriggerResponseObj | List of triggers assigned to the task | - | ✓ |
| assigned_to | string | The user that this task was assigned to | - | ✓ |
| reviewed_at | timestamp | The time the task was reviewed at | - | ✓ |
| reviewed_by | string | The person who reviewed the task | - | ✓ |
| created_at | timestamp | - | ||
| updated_at | timestamp | - |
Chat Message Task Response Object
Copied!Confused about "Chat Message Task Response Object"?
Let us know how we can improve our documentation:
| name | type | description | default | optional |
|---|---|---|---|---|
| id | string | Unique Identifier | - | |
| message_id | string | Message ID | - | |
| user_id | string | User ID | - | |
| channel_id | string | Channel ID | - | |
| user_name | string | User Name (if not provided the user_id value is set) | - | |
| channel_name | string | Channel Name (if not provided the channel_id value is set) | - | |
| status | string | The status of the task | - | |
| text | string | The text message to be moderated | - | |
| content_type | string | Type of payload for this task, can be one of: text, image | - | |
| extra | ExtraObj | Object with data that needs to be stored for this task, eg. fields relevant for the user to identify the content in 3rd party systems, custom metadata, etc. | - | ✓ |
| evaluations | []EvaluationObj | List of evaluations with scores from the responses | - | |
| rule | RuleResponseObj | The rule object containing the filter, evaluations, condition and triggers for this task | - | ✓ |
| triggers | []TriggerResponseObj | List of triggers assigned to the task | - | ✓ |
| assigned_to | string | The user that this task was assigned to | - | ✓ |
| reviewed_at | timestamp | The time the task was reviewed at | - | ✓ |
| reviewed_by | string | The person who reviewed the task | - | ✓ |
| created_at | timestamp | - | ||
| updated_at | timestamp | - |
Rule Response Object
Copied!Confused about "Rule Response Object"?
Let us know how we can improve our documentation:
| name | type | description | default | optional |
|---|---|---|---|---|
| filter | string | Filter that selects a task based on its attributes, eg. content-type or channel type. | - | |
| evaluations | []EvaluationObj | - | ||
| condition | ConditionObj | MongoDB expression that determines if the defined actions should be executed | - | |
| triggers | []TriggerResponseObj | - |
Trigger Response Object
Copied!Confused about "Trigger Response Object"?
Let us know how we can improve our documentation:
| name | type | description | default | optional |
|---|---|---|---|---|
| type | string | Trigger Type | - | |
| options | []OptionsObj | List of trigger options for | - | ✓ |