Modbot Docs
APIAPI referenceAutoMod settings

Try some text

POST/api/settings/automod/try

Check some text against every rule. Nothing is recorded and nothing is done.

Needs the ManageSettings permission.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/api/settings/automod/try" \  -H "Content-Type: application/json" \  -d '{    "text": null,    "target": null,    "includeAi": true  }'
{  "matches": [    {      "ruleKind": "string",      "ruleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",      "ruleName": "string",      "ruleEnabled": true,      "term": "string",      "matched": "string",      "reason": null,      "deleteMessage": true,      "timeoutMinutes": null,      "groupBan": false,      "groupRemove": false    }  ],  "wouldDeleteMessage": true,  "wouldTimeOutMinutes": null,  "aiSkipped": null,  "callId": null,  "wouldGroupBan": false,  "wouldGroupRemove": false}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.