Get the session quota

Get how many concurrent sessions you can run and how many are in use.

GET /api/v2/sessions/quota

Python

from hai_agents import Client

client = Client()

quota = client.sessions.get_session_quota()
print(quota.available)

200

{
  "scope": "user",
  "limit": 10,
  "active": 3,
  "available": 7
}

Behavior

available: 0 doesn’t mean creates fail. New sessions are queued by default and start as slots free up.

Response

200 with the quota object.

scope · string · required

The level the limit applies at: user or org.

limit · integer · required

Maximum number of concurrent sessions allowed.

active · integer · required

Number of sessions currently holding a slot (recently active and not in a terminal state). queued sessions hold no slot and are not counted.

available · integer · required

Remaining concurrent slots (limit - active).

Python

from hai_agents import Client

client = Client()

quota = client.sessions.get_session_quota()
print(quota.available)

200

{
  "scope": "user",
  "limit": 10,
  "active": 3,
  "available": 7
}