Workspaces

Get Ai Credits

This month's AI credits (RO-380): the allowance, what's used and left, the level (`ok`, `warning` past the lowest alert threshold, `exhausted` when AI is paused), the alert thresholds and which are reached, and the caller's own limit (RO-382). Any member.

API key access

Needs the leads:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
GET/api/v1/workspaces/current/ai-credits
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/workspaces/current/ai-credits" \  -H "X-Workspace-Id: string"
{
  "period_start": "2019-08-24T14:15:22Z",
  "resets_at": "2019-08-24T14:15:22Z",
  "monthly_credits": 0,
  "used": 0,
  "remaining": 0,
  "used_ratio": 0.1,
  "level": "string",
  "pause_all": true,
  "alert_thresholds": [
    0
  ],
  "reached_thresholds": [
    0
  ],
  "member_monthly_limit": 0,
  "me": {
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "used": 0,
    "limit": 0,
    "limit_source": "string",
    "remaining": 0,
    "exhausted": true
  },
  "can_manage": true
}