Brief me on a person
/api/briefs/peopleA summary, written by the Chat model, of what the audit log recorded about one person: the newest 100 entries the person popup's Activity tab shows you, about or by any of their VRChat, Discord and Modbot accounts, in one call with no tools. Give exactly one of vrchatUserId, discordUserId or accountId, as for GET /api/people/lookup. The answer is shaped as for an instance's brief.
Needs AI on, Chat on and AI briefs on, and Use AI chat; which entries are read follows your audit log permissions. A brief that read people records modbot.chat.lookup with via: brief, as a Chat question does.
Needs the UseAiChat permission.
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
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/api/briefs/people" \ -H "Content-Type: application/json" \ -d '{}'{ "text": null, "sources": [ 0 ], "entries": 0, "newest": true, "builtFrom": null, "callId": null, "model": null}Brief me on an instance POST
A summary, written by the Chat model, of what the audit log recorded in one instance: the newest 100 entries the instance popup's Activity tab shows you, in one call with no tools. Each line of `text` ends with the entry ids it rests on, in square brackets; `sources` lists the cited ids that were among the entries sent, and `builtFrom` says what it was built from. No opinions, recommendations, scores or reasons. Needs AI on, Chat on and AI briefs on (Settings → AI → Chat), and Use AI chat, See analytics and See the audit log. Counted, limited and logged as a Chat call; the call log keeps what was sent and what came back. With nothing recorded the model is not asked and `text` is null. 409 when briefs are off or AI is not set up, 429 at a spend limit or the monthly allowance, 502 when the provider did not answer. Needs the `ViewAnalytics` and `ViewAuditLog` and `UseAiChat` permissions.
Save a brief as a note POST
Saves one of your person briefs as a note about that person, marked `writtenByAi`. The server writes the note: the brief's text as the call log holds it, a blank line, and its `builtFrom` line. `callId` is the brief's own; a brief about an instance, one somebody else asked for, or one that did not answer is 404, and a brief already saved is 409. Needs Write notes. Needs the `WriteNotes` permission.