Modbot Docs
APIAPI referenceAutoMod settings

Run rule tests

POST/api/settings/automod/rules/{kind}/{id}/tests/run

Check every sample against the rule as it stands now. AI topics cost a real request.

Needs the ManageSettings permission.

AuthorizationBearer <token>

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

In: header

Path Parameters

kind*string
id*string
Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/api/settings/automod/rules/string/497f6eca-6276-4993-bfeb-53cbbbba6f08/tests/run"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "ranAt": "2019-08-24T14:15:22Z",  "model": null,  "ruleVersion": 0,  "samples": 0,  "shouldFlagCount": 0,  "caught": 0,  "missed": 0,  "shouldNotFlagCount": 0,  "wronglyFlagged": 0,  "aiSkipped": null,  "ranBy": null,  "results": [    {      "sampleId": "5c4a81f0-8df5-49c5-ae5b-8065332edd7d",      "text": "string",      "shouldFlag": true,      "note": null,      "target": "string",      "flagged": true,      "term": null,      "matched": null,      "reason": null    }  ]}

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.