Documentation Index
Fetch the complete documentation index at: https://mintlify.com/GuaiZai233/FrostAgent/llms.txt
Use this file to discover all available pages before exploring further.
BotStatusService is a ConnectRPC service that exposes real-time health and operational data for a running FrostAgent instance. It is accessible under the base path /frostagent.v1.BotStatusService/ and provides two RPCs: GetOverview for a snapshot of the bot’s current state, and GetSessions for a paginated list of active conversation sessions.
Connection
ConnectRPC services use HTTP POST with eitherContent-Type: application/json (for JSON encoding) or Content-Type: application/proto (for binary protobuf). The default base URL is http://<host>:8080, configured via the LISTEN_ADDR environment variable.
GetOverview
Returns a point-in-time snapshot of the bot’s status, including uptime, model in use, registered tools, and session count. Thestatus field reflects whether the engine has finished initialising.
Request: GetOverviewRequest
This message has no fields — send an empty JSON object {}.
Response: GetOverviewResponse
The name of the agent. Always
"FrostAgent" in the current release.The running binary version string, e.g.
"0.1.0".Seconds elapsed since the engine’s
StartedAt timestamp was recorded.Cumulative count of messages the engine has processed since startup.
Number of sessions currently held in the session manager.
The model name taken from the
MODEL_NAME environment variable, e.g. "qwen-turbo".Either
"running" (session manager is initialised) or "initializing" (engine is still starting up).List of tools registered with the engine at startup.
GetSessions
Returns a paginated list of currently active conversation sessions. Sessions are created by the OneBot adapter and identified by a prefixed ID such asgroup_123456 or private_789.
Request: GetSessionsRequest
Controls the page of results to return.
GetSessionsResponse
The sessions in the requested page.
Pagination metadata for the response.
page_token is set to the next page cursor if more results exist, or an empty string on the last page. total holds the total session count.