Enable video moderation | FastPix Developer Documentation

This endpoint enables moderation features, such as NSFW and profanity filtering, to detect inappropriate content in existing media. #### How it works 1. Make a `PATCH` request to this endpoint, replacing `<mediaId>` with the ID of the media you want to update. 2. Include the `moderation` object and provide the requried `type` parameter in the request body to specify the media type (for example, video/audio/av). 4. The response contains the updated media data, confirming the changes made. You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaaimoderationready">video.mediaAI.moderation.ready</a> webhook event to track and notify about the detected moderation results. **Use case:** This is particularly useful when a user uploads a video and later decides to enable moderation detection without the need to re-upload it. Related guide: <a href="https://docs.fastpix.io/docs/using-nsfw-and-profanity-filter-for-video-moderation">Moderate NSFW & Profanity</a>

This endpoint enables moderation features, such as NSFW and profanity filtering, to detect inappropriate content in existing media.

How it works

Make a PATCH request to this endpoint, replacing <mediaId> with the ID of the media you want to update.
Include the moderation object and provide the requried type parameter in the request body to specify the media type (for example, video/audio/av).
The response contains the updated media data, confirming the changes made.

You can use the video.mediaAI.moderation.ready webhook event to track and notify about the detected moderation results.

Use case: This is particularly useful when a user uploads a video and later decides to enable moderation detection without the need to re-upload it.

Related guide: Moderate NSFW & Profanity

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

Username: Access Token ID
Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

Path parameters

mediaIdstringRequiredformat: "uuid"

The unique identifier assigned to the media when created. The value must be a valid UUID.

Request

This endpoint expects an object.

moderationobjectOptional

Response

Media details updated successfully with the named entity extraction feature enabled or disabled

successboolean

Shows the request status. Returns true for success and false for failure.

dataobject

This endpoint enables moderation features, such as NSFW and profanity filtering, to detect inappropriate content in existing media.

How it works

Make a PATCH request to this endpoint, replacing <mediaId> with the ID of the media you want to update.
Include the moderation object and provide the requried type parameter in the request body to specify the media type (for example, video/audio/av).
The response contains the updated media data, confirming the changes made.

You can use the video.mediaAI.moderation.ready webhook event to track and notify about the detected moderation results.

Use case: This is particularly useful when a user uploads a video and later decides to enable moderation detection without the need to re-upload it.

Related guide: Moderate NSFW & Profanity

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

Username: Access Token ID
Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

The unique identifier assigned to the media when created. The value must be a valid UUID.

This endpoint expects an object.

Media details updated successfully with the named entity extraction feature enabled or disabled

Shows the request status. Returns true for success and false for failure.

$	curl -X PATCH https://api.fastpix.com/v1/on-demand/0cec3c88-c69d-4232-9b96-f0976327fa2d/moderation \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"moderation": {
>	"type": "video"
>	}
>	}'

1	{
2	"success": true,
3	"data": {
4	"mediaId": "c695988b-ff84-42ae-bb21-10f284fedb0e",
5	"isModerationEnabled": true
6	}
7	}

$	curl -X PATCH https://api.fastpix.com/v1/on-demand/0cec3c88-c69d-4232-9b96-f0976327fa2d/moderation \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"moderation": {
>	"type": "video"
>	}
>	}'

1	{
2	"success": true,
3	"data": {
4	"mediaId": "c695988b-ff84-42ae-bb21-10f284fedb0e",
5	"isModerationEnabled": true
6	}
7	}