Modbot Docs
APIAPI referenceBriefs

Brief me on an instance

POST/api/briefs/instances/{id}

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.

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string
Formatuuid

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/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "text": null,  "sources": [    0  ],  "entries": 0,  "newest": true,  "builtFrom": null,  "callId": null,  "model": 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.