Sub-workspaces

A sub-workspace family is one primary workspace with any number of sub-workspaces under it, typically one per client, brand, or team. Each sub-workspace is a full workspace with its own assistants, numbers, campaigns, call history, API key, and members, fully isolated from its siblings. The primary is the management console: it holds the family’s money and calling capacity, shares them out, and sees every sub-workspace’s data in one place. The primary itself does not place calls.

​

Billing modes

The family’s billing mode is set when it is created and applies to every sub-workspace. Concurrency (how many calls can run at once) is bought on the primary and allocated to sub-workspaces in both modes. In an individual family each allocation is that sub-workspace’s hard ceiling. In a common family idle capacity flows to whichever sub-workspace is busy, so a sub-workspace’s ceiling is the family total.

​

Authentication

Call every endpoint in this section with the primary workspace’s API key in X-API-KEY. The key identifies the family; there is no workspace header to set.

​

Endpoints

• Create Sub-workspace — POST /workspace/sub
• Get Sub-workspaces — GET /workspace/sub, the whole family in one call
• List Family Members — GET /workspace/sub/members
• Allocate Concurrency — PATCH /workspace/sub/{sub_workspace_id}/concurrency
• Reallocate Credit Limits — PATCH /workspace/sub/credit-limits, postpaid individual families
• Reallocate Credit Balances — PATCH /workspace/sub/credit-balances, prepaid individual families

​

Money formats

The read endpoints and the concurrency endpoint return amounts as JSON numbers (200000.0). The two allocation endpoints return amounts as decimal strings ("200000.00"). Parse both before doing arithmetic.

​

Create an assistant inside a sub-workspace

There is no separate endpoint for this. A sub-workspace is a normal workspace, so use its own API key with the existing create assistant endpoint and the assistant is created inside that sub-workspace, invisible from the primary and from sibling sub-workspaces. The same applies to every other endpoint in this reference: numbers, campaigns, calls, and history all scope to the workspace that owns the key. A new sub-workspace starts without an API key. To get one, switch into the sub-workspace in the Ringg AI dashboard, open Settings → API Key, and generate it there. The key is shown once, exactly as described in Authentication. Keys cannot be created or rotated through the API.

​

Typical flow

1. Create the sub-workspace with the primary’s key.
2. Allocate concurrency to it, and a credit limit or balance in an individual family.
3. Generate the sub-workspace’s API key in the dashboard.
4. Create assistants, attach numbers, and run campaigns with the sub-workspace’s key.
5. Watch usage across the family with Get Sub-workspaces.