Assistant

Get Assistant Usage

The workspace meter (RO-321): assistant messages today against `ASSISTANT_DAILY_MESSAGES`, AI credits today and this month (every feature) against `ASSISTANT_MONTHLY_CREDITS`, and when each resets. At either limit the assistant answers 429 until the reset; everything else keeps working.

API key access

Not available to API keys or connected apps: only a signed-in person can call this route.
GET/api/v1/assistant/usage
AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X GET "http://localhost:8000/api/v1/assistant/usage" \  -H "X-Workspace-Id: string"
{
  "messages_today": 0,
  "daily_messages": 0,
  "credits_today": 0,
  "credits_month": 0,
  "monthly_credits": 0,
  "day_resets_at": "2019-08-24T14:15:22Z",
  "month_resets_at": "2019-08-24T14:15:22Z",
  "used_ratio": 0.1,
  "warning": true,
  "exhausted": true,
  "show_credits": true
}