Stream product:moderation API
The product:moderation API from Stream — 56 operation(s) for product:moderation.
Stream product:moderation API is one of 19 APIs that Stream publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include product:moderation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes 65 operations across 56 paths, and defines 280 schemas. It is described by OpenAPI 3.2.0, at version v228.3.0.
Requests are made against a single base URL, https://chat.stream-io-api.com.
65 operations
56 paths
280 schemas
4 DELETE18 GET43 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Stream product:moderation API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (JWT).
An API key is passed in the query as api_key (api_key).
An API key is passed in the header as Stream-Auth-Type (stream-auth-type).
By default, every request must be authenticated.
JWT— JWT should be always provided when stream-auth-type=jwt. Using JWT auth request could be authenticated as user or as server-side. When using user authenticatio…api_key— Application API key should be always set in order to authenticate the request.stream-auth-type— Stream-Auth-Type should be always set in order to authenticate the request. Possible values: jwt or anonymous. jwt allows you to authenticate as a user. With t…
Paths & Operations 65
Across 56 paths, the API surfaces 65 operations — 4 DELETE, 18 GET, 43 POST. Each is listed below with its method, path, parameters, and response codes.
product:moderation 65
POST
/api/v1/moderation/chat_message_tasks
Submit Chat Message Task
GET
/api/v1/moderation/dashboard/blocked_messages
TODO
POST
/api/v1/moderation/dashboard/flag_feedback
TODO
GET
/api/v1/moderation/dashboard/moderation_log
TODO
POST
/api/v1/moderation/dashboard/update_flags
TODO
GET
/api/v1/moderation/moderation/blocked_messages
TODO
POST
/api/v1/moderation/moderation/flag_feedback
TODO
GET
/api/v1/moderation/moderation/moderation_log
TODO
POST
/api/v1/moderation/moderation/update_flags
TODO
GET
/api/v1/moderation/tasks
List Tasks
POST
/api/v1/moderation/tasks
Submit Task
GET
/api/v1/moderation/tasks/{id}
Get Task
POST
/api/v1/moderation/tasks/{id}
Update Task
POST
/automod/v1/chat_message_tasks
Submit Chat Message Task
GET
/automod/v1/dashboard/blocked_messages
TODO
POST
/automod/v1/dashboard/flag_feedback
TODO
GET
/automod/v1/dashboard/moderation_log
TODO
POST
/automod/v1/dashboard/update_flags
TODO
GET
/automod/v1/moderation/blocked_messages
TODO
POST
/automod/v1/moderation/flag_feedback
TODO
GET
/automod/v1/moderation/moderation_log
TODO
POST
/automod/v1/moderation/update_flags
TODO
GET
/automod/v1/tasks
List Tasks
POST
/automod/v1/tasks
Submit Task
GET
/automod/v1/tasks/{id}
Get Task
POST
/automod/v1/tasks/{id}
Update Task
GET
/api/v2/moderation/action_config
Get moderation action configs
POST
/api/v2/moderation/action_config
Create or update a moderation action config
DELETE
/api/v2/moderation/action_config/{id}
Delete a moderation action config
POST
/api/v2/moderation/action_config/bulk
Bulk create or update moderation action configs
POST
/api/v2/moderation/action_config/bulk_delete
Bulk delete moderation action configs
POST
/api/v2/moderation/action_logs
Insert moderation action log
POST
/api/v2/moderation/appeal
Appeal against the moderation decision
GET
/api/v2/moderation/appeal/{id}
Get appeal item
POST
/api/v2/moderation/appeals
Query Appeals
POST
/api/v2/moderation/ban
Ban
POST
/api/v2/moderation/bulk_image_moderation
Bulk image moderation
POST
/api/v2/moderation/bypass
Bypass Moderation
POST
/api/v2/moderation/check
Check
POST
/api/v2/moderation/check_s3_access
Check S3 image access
POST
/api/v2/moderation/config
Create or update moderation configuration
DELETE
/api/v2/moderation/config/{key}
Delete a moderation policy
GET
/api/v2/moderation/config/{key}
Get moderation configuration
POST
/api/v2/moderation/configs
Query moderation configurations
POST
/api/v2/moderation/custom_check
Custom check endpoint
DELETE
/api/v2/moderation/feeds_moderation_template
Delete a moderation template
GET
/api/v2/moderation/feeds_moderation_template
Query feed moderation templates
POST
/api/v2/moderation/feeds_moderation_template
Upsert feeds template
POST
/api/v2/moderation/flag
Flag content for moderation
POST
/api/v2/moderation/flag_count
Get flag count for a user
POST
/api/v2/moderation/flags
Query moderation flags
POST
/api/v2/moderation/labels
Labels
POST
/api/v2/moderation/labels/results
Query label results
POST
/api/v2/moderation/logs
Query moderation action logs
POST
/api/v2/moderation/moderation_rule
Upsert moderation rule
DELETE
/api/v2/moderation/moderation_rule/{id}
Delete moderation rule
GET
/api/v2/moderation/moderation_rule/{id}
Get moderation rule
POST
/api/v2/moderation/moderation_rules
Query moderation rules
POST
/api/v2/moderation/mute
Mute
POST
/api/v2/moderation/review_queue
Query review queue items
GET
/api/v2/moderation/review_queue/{id}
Get review queue item
POST
/api/v2/moderation/submit_action
Submit moderation action
POST
/api/v2/moderation/submit_moderation_feedback
Submit moderation feedback
POST
/api/v2/moderation/unban
Unban
POST
/api/v2/moderation/unmute
Unmute a user
Schemas 280
The contract defines 280 schemas that model the data the API accepts and returns. The most detailed are FeedsV3ActivityResponse (48 properties), ChatMessageResponse (48 properties), ReviewQueueItemResponse (37 properties), ChannelConfigWithInfo (37 properties). Each schema is shown below with its type and property counts.
Reaction
object
17 properties
5 required
TriggerResponse
object
2 properties
1 required
UpsertActionConfigResponse
objectnull
2 properties
1 required
UpsertModerationTemplateRequest
objectnull
2 properties
2 required
FrameRecordingSettingsResponse
object
3 properties
2 required
TranscriptionSettingsResponse
object
5 properties
4 required
GetReviewQueueItemResponse
objectnull
2 properties
1 required
TriggerPayload
objectnull
2 properties
CustomCheckFlag
object
4 properties
1 required
ChatReactionGroupUserResponse
object
3 properties
2 required
UpsertActionConfigRequest
objectnull
10 properties
3 required
FeedsPreferencesResponse
object
8 properties
ChatPreferences
object
8 properties
ScreensharingSettingsResponse
object
3 properties
2 required
BanInfoResponse
objectnull
Ban information
6 properties
1 required
APIError
objectnull
8 properties
6 required
Time
object
UserIdenticalContentCountParameters
object
2 properties
ReadReceiptsResponse
object
1 property
BulkDeleteActionConfigRequest
objectnull
3 properties
1 required
QueryAppealsResponse
objectnull
4 properties
2 required
PollVoteResponseData
objectnull
9 properties
5 required
FlagCountRuleParameters
object
1 property
GetActionConfigResponse
objectnull
2 properties
2 required
FeedsV3CommentResponse
object
26 properties
16 required
IndividualRecordingSettingsResponse
object
2 properties
1 required
ChatDraftPayloadResponse
object
13 properties
3 required
BlockActionRequestPayload
object
Configuration for block action
1 property
UpsertConfigResponse
objectnull
2 properties
1 required
BanActionRequestPayload
object
Configuration for ban moderation action
9 properties
UpsertModerationRuleRequest
objectnull
14 properties
2 required
ConfigResponse
object
19 properties
6 required
IngressVideoEncodingResponse
object
2 properties
2 required
RuleBuilderConfig
object
2 properties
GetAppealResponse
objectnull
2 properties
1 required
SubmitTaskRequest
objectnull
4 properties
2 required
BanOptions
object
5 properties
AITextConfig
object
5 properties
AppealItemResponse
object
11 properties
7 required
ImageRuleParameters
object
4 properties
GetFlagCountResponse
objectnull
2 properties
2 required
InsertActionLogRequest
objectnull
Request to insert a moderation action log entry
8 properties
4 required
DeleteModerationTemplateResponse
objectnull
1 property
1 required
VideoSettingsResponse
object
5 properties
5 required
UnmuteResponse
objectnull
2 properties
1 required
CallCustomPropertyParameters
object
2 properties
RTMPSettingsResponse
object
RTMPSettingsResponse is the payload for RTMP settings
3 properties
3 required
CheckS3AccessRequest
objectnull
1 property
EnrichedActivity
object
12 properties
GetTaskResponse
objectnull
2 properties
2 required
QueryReviewQueueRequest
objectnull
12 properties
FeedsModerationTemplateConfigPayload
object
Configuration for a feeds moderation template
2 properties
1 required
UnmuteRequest
objectnull
3 properties
1 required
SubmitModerationFeedbackResponse
objectnull
1 property
1 required
KeyframeRuleParameters
object
3 properties
BodyguardSeverityRule
object
2 properties
2 required
BlockListRule
object
3 properties
1 required
SRTIngress
object
1 property
1 required
PrivacySettingsResponse
object
3 properties
CallRuleActionSequence
object
3 properties
ModerationConfig
object
18 properties
CallSessionResponse
object
12 properties
7 required
ShadowBlockActionRequestPayload
object
Configuration for shadow block action
1 property
SubmitActionRequest
objectnull
22 properties
1 required
DeleteActionConfigResponse
objectnull
2 properties
2 required
BanResponse
objectnull
7 properties
1 required
BlockListConfig
object
4 properties
ChatReactionResponse
object
8 properties
8 required
UnbanRequest
objectnull
2 properties
GoogleVisionConfig
object
1 property
LabelThresholds
object
2 properties
AWSRekognitionRule
object
4 properties
3 required
ContentCountRuleParameters
object
2 properties
UserCreatedWithinParameters
object
1 property
ImageContentParameters
object
3 properties
IndividualRecordingResponse
object
1 property
1 required
SortParamRequest
objectnull
3 properties
ChannelConfigWithInfo
object
37 properties
28 required
ChannelMute
objectnull
5 properties
2 required
RejectAppealRequestPayload
object
Configuration for rejecting an appeal
1 property
1 required
ThumbnailsSettingsResponse
object
1 property
1 required
BroadcastSettingsResponse
object
BroadcastSettingsResponse is the payload for broadcasting settings
3 properties
3 required
ModerationFlagResponse
objectnull
15 properties
7 required
QueryModerationFlagsResponse
objectnull
Basic response information
4 properties
2 required
FeedsNotificationParentActivity
object
5 properties
1 required
QueryModerationConfigsResponse
objectnull
4 properties
2 required
BlockListOptions
object
2 properties
2 required
AppealRequest
objectnull
6 properties
3 required
ModerationActionConfigResponse
objectnull
Configuration for a moderation action
8 properties
5 required
VideoContentParameters
object
2 properties
OwnUserResponse
object
30 properties
17 required
ImageData
object
5 properties
5 required
RuleResponse
object
7 properties
7 required
FeedsNotificationTarget
object
9 properties
1 required
EvaluationResponse
object
3 properties
2 required
QueryModerationLogsResponse
objectnull
4 properties
2 required
QueryLabelResultsRequest
objectnull
7 properties
CheckRequest
objectnull
12 properties
3 required
BulkUpsertActionConfigRequest
objectnull
3 properties
1 required
DeleteUserRequestPayload
object
Configuration for user deletion action
7 properties
AutomodSemanticFiltersRule
object
3 properties
3 required
RTMPIngress
object
RTMP input settings
1 property
1 required
UpsertModerationTemplateResponse
objectnull
5 properties
4 required
QueryModerationConfigsRequest
objectnull
7 properties
TypingIndicatorsResponse
object
1 property
BodyguardProfileSummary
object
3 properties
1 required
DeviceResponse
objectnull
Response for Device
8 properties
4 required
UpdateTaskResponse
objectnull
2 properties
2 required
CompositeRecordingResponse
object
1 property
1 required
FlagUserOptions
object
1 property
ModerationPayloadRequest
object
Content payload for moderation
4 properties
DeleteReactionRequestPayload
object
Configuration for reaction deletion action
4 properties
UserResponse
object
User response object
25 properties
12 required
QueryModerationRulesRequest
objectnull
7 properties
AutomodToxicityConfig
object
3 properties
CheckResponse
objectnull
6 properties
3 required
SubmitTaskResponse
objectnull
2 properties
2 required
MarkReviewedRequestPayload
object
Configuration for mark reviewed action
3 properties
QueryLabelResultsResponse
objectnull
4 properties
2 required
TriggeredRuleResponse
object
5 properties
2 required
IngressVideoLayerResponse
objectnull
5 properties
5 required
FeedsReactionGroupResponse
object
3 properties
3 required
IngressAudioEncodingResponse
object
3 properties
3 required
SpeechSegmentConfig
object
2 properties
LLMConfig
object
5 properties
SubmitChatMessageTaskResponse
objectnull
2 properties
2 required
EscalatePayload
object
Configuration for escalation action
3 properties
FeedsNotificationContext
object
2 properties
EgressResponse
object
7 properties
2 required
UserRuleParameters
object
1 property
CallResponse
object
Represents a call
25 properties
17 required
LayoutSettingsResponse
object
5 properties
3 required
FilterConfigResponse
object
3 properties
1 required
VideoCallRuleConfig
object
3 properties
QueryFeedModerationTemplate
object
4 properties
3 required
ThumbnailResponse
object
1 property
1 required
TargetResolution
object
3 properties
3 required
DeleteModerationRuleResponse
objectnull
Basic response information
1 property
1 required
BulkImageModerationResponse
objectnull
2 properties
2 required
AIImageLabelDefinition
object
4 properties
4 required
ChatPreferencesResponse
object
7 properties
DeleteMessageRequestPayload
object
Configuration for message deletion action
4 properties
DeleteModerationConfigResponse
objectnull
1 property
1 required
UserCustomPropertyParameters
object
2 properties
FeedsNotificationTrigger
object
4 properties
2 required
ListTasksResponse
objectnull
2 properties
2 required
FeedsNotificationComment
object
4 properties
3 required
CallSettingsResponse
object
16 properties
15 required
OCRRule
object
2 properties
2 required
DeleteCommentRequestPayload
object
Configuration for comment deletion action
4 properties
ChatDraftResponse
object
6 properties
3 required
ChannelMessageCountRuleParameters
object
2 properties
TextContentParameters
object
6 properties
AutomodSemanticFiltersConfig
object
3 properties
ChatModerationV2Response
object
8 properties
2 required
FrameRecordingResponse
object
1 property
1 required
CheckS3AccessResponse
objectnull
3 properties
2 required
BypassActionRequest
object
1 property
InsertActionLogResponse
objectnull
Response after inserting a moderation action log
1 property
1 required
UnblockActionRequestPayload
object
Configuration for unblock action
1 property
UpsertConfigRequest
objectnull
19 properties
1 required
Field
objectnull
3 properties
3 required
ChatReminderResponseData
object
8 properties
5 required
FeedsReactionResponse
object
7 properties
5 required
RestoreActionRequestPayload
object
Configuration for restore action
1 property
ModerationPayloadResponse
object
Content payload for moderation
4 properties
AudioSettingsResponse
object
8 properties
7 required
QueryModerationFlagsRequest
objectnull
5 properties
BulkImageModerationRequest
objectnull
1 property
1 required
UserRequest
object
User request object
10 properties
1 required
FeedsActivityLocation
object
2 properties
2 required
MuteResponse
objectnull
4 properties
1 required
RawRecordingResponse
object
1 property
1 required
ReviewQueueItemResponse
object
37 properties
17 required
FeedsFeedResponse
object
18 properties
13 required
BodyguardRule
object
3 properties
1 required
MatchResponse
object
2 properties
2 required
HarmConfig
object
5 properties
EgressHLSResponse
object
2 properties
2 required
ActionSequence
object
7 properties
FlagRequest
objectnull
8 properties
2 required
PushPreferencesResponse
objectnull
6 properties
ChatSharedLocationResponseData
object
10 properties
8 required
SubmitChatMessageTaskRequest
objectnull
8 properties
4 required
UpdateTaskRequest
objectnull
5 properties
RawRecordingSettingsResponse
object
2 properties
1 required
Attachment
objectnull
An attachment is a message object that represents a file uploaded by a user.
22 properties
1 required
GetModerationRuleResponse
objectnull
Basic response information
2 properties
1 required
ModerationV2Response
object
8 properties
2 required
RecordSettingsResponse
object
RecordSettings is the payload for recording settings
4 properties
4 required
TaskResponse
object
12 properties
7 required
CustomActionRequestPayload
object
Configuration for custom moderation action
2 properties
CallActionOptions
object
7 properties
DeliveryReceiptsResponse
object
1 property
MuteRequest
objectnull
4 properties
1 required
UpsertModerationRuleResponse
objectnull
Basic response information
2 properties
1 required
TextRuleParameters
object
9 properties
CallParticipantResponse
object
4 properties
4 required
TranslationSettings
object
2 properties
2 required
LabelResultResponse
object
15 properties
10 required
Images
object
7 properties
7 required
FeedsV3ActivityResponse
object
48 properties
28 required
BanRequest
objectnull
9 properties
1 required
SessionSettingsResponse
object
1 property
1 required
BackstageSettingsResponse
object
2 properties
1 required
ModerationPayload
object
4 properties
ChatMessageTaskResponse
object
Chat message task response
18 properties
12 required
ActionLogResponse
objectnull
12 properties
9 required
User
object
2 properties
1 required
RuleBuilderCondition
object
22 properties
CustomCheckResponse
objectnull
4 properties
3 required
UpsertActionConfigItem
object
8 properties
3 required
IngressSourceResponse
object
3 properties
3 required
PushNotificationSettingsResponse
object
2 properties
AIVideoConfig
object
3 properties
QueryModerationLogsRequest
objectnull
7 properties
Action
objectnull
5 properties
3 required
QueryAppealsRequest
objectnull
7 properties
ChatReactionGroupResponse
objectnull
5 properties
5 required
NoiseCancellationSettings
object
1 property
1 required
Data
object
1 property
1 required
VelocityFilterConfig
object
7 properties
UnbanResponse
objectnull
1 property
1 required
EscalationMetadata
object
3 properties
VelocityFilterConfigRule
object
14 properties
1 required
ChannelMemberResponse
objectnull
20 properties
7 required
RingSettingsResponse
object
3 properties
3 required
ChannelResponse
object
Represents channel in chat
28 properties
8 required
RuleBuilderRule
object
8 properties
1 required
EnrichedReaction
objectnull
13 properties
3 required
SubmitModerationFeedbackRequest
objectnull
9 properties
3 required
BodyguardImageAnalysisConfig
object
1 property
UnbanActionRequestPayload
object
Configuration for unban moderation action
3 properties
BypassResponse
objectnull
1 property
1 required
AIImageConfig
object
4 properties
Command
objectnull
Represents custom chat command
6 properties
4 required
GetConfigResponse
objectnull
2 properties
1 required
RuleBuilderAction
object
5 properties
ModerationRuleV2Response
object
15 properties
9 required
UserRoleParameters
object
2 properties
FeedsEnrichedCollectionResponse
object
7 properties
7 required
GeofenceSettingsResponse
object
1 property
1 required
ChatMessageResponse
object
48 properties
23 required
ChannelOwnCapability
string
All possibility of string to use
HLSSettingsResponse
object
HLSSettings is the payload for HLS settings
4 properties
4 required
IngressSettingsResponse
object
3 properties
1 required
VideoRuleParameters
object
3 properties
CallIngressResponse
object
CallIngressResponse is the payload for ingress settings
3 properties
3 required
QueryReviewQueueResponse
objectnull
8 properties
4 required
RuleBuilderConditionGroup
object
2 properties
ClosedCaptionRuleParameters
object
3 properties
BulkUpsertActionConfigResponse
objectnull
2 properties
2 required
SubmitActionResponse
objectnull
3 properties
1 required
LabelsResponse
objectnull
9 properties
2 required
AutomodRule
object
3 properties
3 required
LabelsRequest
objectnull
6 properties
1 required
WHIPIngress
object
1 property
1 required
AutomodPlatformCircumventionConfig
object
3 properties
QueryFeedModerationTemplatesResponse
objectnull
2 properties
2 required
LimitsSettingsResponse
object
4 properties
1 required
MatchPayload
objectnull
2 properties
UserMuteResponse
objectnull
5 properties
2 required
EvaluationPayload
objectnull
5 properties
1 required
CustomCheckRequest
objectnull
7 properties
3 required
BypassRequest
objectnull
2 properties
2 required
CallViolationCountParameters
object
2 properties
CallTypeRuleParameters
object
1 property
PollOptionResponseData
objectnull
3 properties
3 required
EntityCreatorResponse
object
28 properties
15 required
DeleteActivityRequestPayload
object
Configuration for activity deletion action
4 properties
FeedsBookmarkResponse
object
7 properties
5 required
LLMRule
object
4 properties
2 required
Thresholds
object
Sets thresholds for AI moderation
3 properties
AppealResponse
objectnull
2 properties
2 required
PollResponseData
object
21 properties
18 required
FlagResponse
objectnull
2 properties
2 required
EgressRTMPResponse
object
4 properties
2 required
GetFlagCountRequest
objectnull
2 properties
1 required
BulkDeleteActionConfigResponse
objectnull
2 properties
2 required
QueryModerationRulesResponse
objectnull
10 properties
8 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Stream 12
Other APIs Stream publishes across the network.
Stream Activity Feeds API
Stream Video and Audio API
Stream Application API
Stream Campaigns API
Stream Channels API
Stream Devices API
Stream Members API
Stream Messages API
Stream Moderation API
Stream Permissions API
Stream Reactions API
Stream Roles API
#product:moderation
Where this information came from
This is an independent, third-party profile of Stream product:moderation API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.