8 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

ModerationService

Inherits from: Instance → Object

ModerationService lets server-side experience code submit user-generated captures (screenshots taken with CaptureService:CaptureScreenshot() and videos recorded with CaptureService:StartVideoCaptureAsync()) to Roblox's content moderation pipeline and receive the review results asynchronously.

Inherits from: Instance

Memory category: Instances

Tags: NotCreatable, Service, NotReplicated

Methods

Name	Type / Returns	Description
ModerationService:BindReviewableContentEventProcessor	RBXScriptConnection	Registers a server-side processor, ordered by `priority`, that is invoked for each moderation review event on reviewable content.
ModerationService:CreateReviewableContentAsync	string	Registers user-generated captures for moderation review and triggers the owning clients to upload them, returning the reviewable-content ID.
ModerationService:CreateReviewableContentKey	string	Returns an opaque key that identifies a screenshot or video capture for use with `CreateReviewableContentAsync()`.

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

ModerationService:BindReviewableContentEventProcessor

Binds a callback that the server invokes for each moderation review event produced for content registered through CreateReviewableContentAsync().

Once at least one processor is bound, review events are delivered to the bound processors in priority order. The callback function receives a single table with the following fields:

Id — The reviewable-content ID the event refers to.
State — The review state (ReviewableContentState).
Ref — The optional caller-supplied reference string passed to CreateReviewableContentAsync(), present only when one was supplied.
ModerationResult — Present when a moderation result is available, a table with a Category (ModerationResultCategory) and, when a violation is detected, a Labels array of ModerationResultLabel values.

Processors run as a chain: if a processor returns true, the event is acknowledged, deleted from the backend, and removed from the pending set, and no further processors run for that event. If it returns false (or does not return a boolean), the next processor runs; if no processor returns true, the event is left unacknowledged and redelivered on a later poll.

Parameters

Name	Type	Default	Description
priority	int		Determines the order in which this processor is invoked relative to other bound processors.
callback	Function		The function invoked for each reviewable-content event. It receives a table describing the event and should return `true` to acknowledge the event or `false` to leave it for redelivery.

Returns

Type	Description
RBXScriptConnection	A connection that can be disconnected to unregister the processor.

Field	Value
security	None
thread safety	Unsafe
capabilities	["Consequences"]

ModerationService:CreateReviewableContentAsync

Registers one or more captures as a single unit of reviewable content and starts its moderation review. This is a yielding function that must be called on the server and is restricted to allow-listed universes; calling it from a universe that is not permitted to use this API raises an error.

The config table accepts:

Id — An optional caller-chosen ID for the reviewable content. Supplying an ID that already exists raises an error.
Ref — An optional reference string echoed back on the events delivered to processors bound with BindReviewableContentEventProcessor().
Content — A list of items (currently limited to one), each containing either an Image or a Video table with a UserId (the owning player) and a ContentKey obtained from CreateReviewableContentKey().

The method registers the content with the backend and returns the reviewable content ID. Review results are later delivered to bound processors as the moderation review completes.

Parameters

Name	Type	Default	Description
config	Dictionary		A table of parameters describing the content to review, including an optional `Id`, an optional `Ref`, and a `Content` list of image or video items.

Returns

Type	Description
string	The ID of the created reviewable content.

Field	Value
tags	["Yields"]
security	None
thread safety	Unsafe
capabilities	["Consequences"]

ModerationService:CreateReviewableContentKey

Produces an opaque key that describes a single capture so it can be submitted to CreateReviewableContentAsync().

The content must reference a supported capture (a temporary content URI produced by CaptureService:CaptureScreenshot(), a ScreenshotCapture object, or a VideoCapture object). Any other content raises an error.

Parameters

Name	Type	Default	Description
content	Content		A `Content` referring to a screenshot or video capture (a temporary URI from `CaptureService:CaptureScreenshot()`, a `ScreenshotCapture`, or a `VideoCapture`).

Returns

Type	Description
string	An opaque content key identifying the capture.

Field	Value
security	None
thread safety	Unsafe
capabilities	["Consequences"]

Properties

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

Events

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.