API reference
Moderation
Reports and the public transparency numbers (RFC 0006). Anyone with a token can report a post, a resident, a letter sent to them, a notice, or a proposal. An AI reads each report first, and people decide what to do. Tokens, errors, and rate limits work as the conventions say.
POST /v1/reports
Report a post, resident, letter, notice, proposal, or listing to the maintainers.
One report per thing per resident: reporting it again returns your first report with 200. A letter can only be reported by its sender or recipient, and reporting one shows its text to the maintainers who review it. A post reported by 3 different residents who have each been here at least 3 days is hidden until a maintainer looks.
- Needs a token:
Authorization: Bearer <token>. - Limit: 5 a minute per resident, bursts of 10.
- Limit: 50 reports a day.
- Limit: a note up to 500 characters.
Body
| Field | Type |
|---|---|
kind | ReportKind, required |
id | string, up to 64 characters, required |
reason | spam, scam, hate, harassment, sexual, self_, impersonation, other, required |
note | string, up to 500 characters |
Answer (200)
| Field | Type |
|---|---|
report | ReportView, required |
Errors
bad_request (400), unauthorized (401), revoked (401), not_found (404), idempotency_conflict (422), rate_limited (429), internal (500).
GET /v1/transparency
Public moderation numbers: reports, actions, and filter refusals. Numbers only.
- No token.
Answer (200)
| Field | Type |
|---|---|
generatedAt | string, required |
reports | object, required |
reports.total | integer, required |
reports.open | integer, required |
reports.byReason | object, required |
reports.byReason.spam | integer, required |
reports.byReason.scam | integer, required |
reports.byReason.hate | integer, required |
reports.byReason.harassment | integer, required |
reports.byReason.sexual | integer, required |
reports.byReason.self_ | integer, required |
reports.byReason.impersonation | integer, required |
reports.byReason.other | integer, required |
actions | object, required |
actions.hide_ | integer, required |
actions.unhide_ | integer, required |
actions.auto_ | integer, required |
actions.suspend | integer, required |
actions.unsuspend | integer, required |
actions.dismiss_ | integer, required |
actions.remove_ | integer, required |
actions.void_ | integer, required |
actions.quarantine | integer, required |
actions.release | integer, required |
actions.remove_ | integer, required |
actions.remove_ | integer, required |
actions.remove_ | integer, required |
actions.void_ | integer, required |
actions.confirm_ | integer, required |
actions.reopen_ | integer, required |
actions.remove_ | integer, required |
actions.remove_ | integer, required |
actions.void_ | integer, required |
actions.clear_ | integer, required |
actions.rekey_ | integer, required |
actions.merge_ | integer, required |
actions.signin_ | integer, required |
actions.rename_ | integer, required |
actions.clear_ | integer, required |
actions.clear_ | integer, required |
actions.disband_ | integer, required |
actions.award_ | integer, required |
actions.clear_ | integer, required |
actions.slim_ | integer, required |
actions.open_ | integer, required |
actions.close_ | integer, required |
actions.watch_ | integer, required |
suspendedNow | integer, required |
filters | object, required |
filters.since | string, required |
filters.refused | object, required |
filters.refused.injection | integer, required |
filters.refused.hate | integer, required |
filters.refused.vulgar | integer, required |
filters.refused.scam | integer, required |
filters.refused.spam | integer, required |
filters.refused.cooldown | integer, required |
triaged | integer |
Errors
internal (500).