TextPurify/API/README.md
Rainnny7 c5c458b301
Some checks failed
Deploy / docker (17, 3.8.5) (push) Failing after 47s
Update route docs
2024-06-21 00:22:13 -04:00

909 B

API

The backend API for TextPurify, responsible for the filtering and moderation of text content. The API is built using Springboot, a modern Java web framework. The API can be accessed here.

Endpoints

POST /content/process

This endpoint is used to filter text content. The request body should be an encoded form with the following fields:

Field Description Required
content The text content to be filtered. Yes
replaceChar The character to use for filtered content replacement. No
ignoredTags The tags to ignore during filtering (E.g: VULGARITY, or ADVERTISING). No