Organisations
Read today's calls against the daily limits
Each member's calls today through the agents they connected, each connection's and each key's, with its limit, and the ones at or past 80 percent.
GET
/orgs/{org}/call-caps/todayTL;DR
| Question | Answer |
|---|---|
| What does it do? | Read today's calls against the daily limits. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type CapsToday. |
| What can go wrong? | 401 not signed in; 404 no such organisation, or the caller is not a member of it; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
Each member's calls today through the agents they connected, each connection's and each key's, with its limit, and the ones at or past 80 percent. Everyone for a caller who may read the call history; their own for anyone else.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | Today's calls against the limits. | CapsToday |
| 401 | Not signed in. | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type CapsToday.
| Field | Type | Required | Description |
|---|---|---|---|
available | boolean | yes | |
day | string | yes | The UTC day, YYYY-MM-DD. The counts start again at 00:00 UTC. |
scope | "organisation" | "own" | yes | organisation for a caller who may read the call history; own for anyone else, who sees their own. |
items | CapUse[] | yes | |
items[].scope | "member" | "connection" | "key" | yes | |
items[].id | string | yes | The member's account id, or the key's id. |
items[].label | string | yes | |
items[].member | string | null | yes | For a connection: the address of the member who connected it. |
items[].used | integer | yes | Calls today, UTC. |
items[].limit | integer | null | yes | The limit, or null when none holds it. |
alerts | CapUse[] | yes | The ones at or past 80 percent of their limit, the fullest first. |
alerts[].scope | "member" | "connection" | "key" | yes | |
alerts[].id | string | yes | The member's account id, or the key's id. |
alerts[].label | string | yes | |
alerts[].member | string | null | yes | For a connection: the address of the member who connected it. |
alerts[].used | integer | yes | Calls today, UTC. |
alerts[].limit | integer | null | yes | The limit, or null when none holds it. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |