Docs/Overview
Organisations

Overview

Run Sai for your own customers with an Organisation, its Tenants and Organisation Keys.

An Organisation lets you run Sai for your own customers. Each customer is a Tenant: a clinic, a team, a person. A Tenant's machines, files and sessions are kept apart from every other Tenant's, and the Organisation pays for all of them.

How the pieces fit

PieceWhat it isPage
OrganisationYour company on Sai. It has owners and admins, its own credit balance and its own keys.Organisations API
Organisation KeyA sapi_ key that belongs to the Organisation, not to a person. Your backend uses it to manage Tenants.Organisation Keys
TenantOne of your customers.Tenants
Enrollment codeA single-use code your installer uses to add a customer's computer to a Tenant.Machine enrollment
Tenant machineA computer of the Tenant's, running the Sai runtime.Tenant machines
Tenant tokenA one-hour token that acts as one Tenant on /v1/agents/*.Tenant tokens

A typical integration:

  1. Create the Organisation and an Organisation Key in the portal.
  2. Your backend creates a Tenant for each customer with the Organisation Key.
  3. Your installer enrolls the customer's computer with an enrollment code.
  4. Your backend exchanges the Organisation Key for a Tenant token and calls /v1/agents/message with it, as that Tenant.

Who can call what

CredentialCan call
A signed-in member's session/v1/orgs/*: the Organisation, its keys and members. This is what the portal's console uses.
Organisation Key/v1/tenants/*, enrollment codes, and the Tenant token exchange. Not /v1/agents/*.
Tenant token/v1/agents/* as one Tenant, with some routes left out.

Create an Organisation

Open the account switcher in the portal at platform.simular.ai and choose Create Organisation. You become its owner. Each Organisation has its own console: Tenants, API keys, Members, Billing, the Playground and Settings.

One person can create 5 Organisations, and 5 per hour. On the free plan, creating one needs a verified phone number, as for an API key. To do it from code, see Create an Organisation.

A disabled Organisation can still be read, but every change, every Tenant token and every Organisation Key is refused with 403 organisation_disabled. Contact support@simular.ai.

Members

An Organisation has two roles:

RoleCan
ownerEverything an admin can, and: rename or delete the Organisation, invite and remove members, change roles, top up credit, set the low-balance alert.
adminManage Tenants and Organisation Keys, see billing and usage, and use the Playground as a Tenant.

People join through an invitation from an owner, on the console's Members page. The invitation goes to an email address and lasts 7 days. The invitee accepts it from Invitations in the portal, signed in with that verified email. An Organisation always keeps at least one owner.

A member who leaves or is removed loses access at once. Tenant tokens they exchanged stop working within a minute. Organisation Keys they created keep working.

Billing

The Organisation pays for every Tenant. Model and computer use by a Tenant draws from the Organisation's credit, not from any member's account. The console's Billing page shows the balance, takes top-ups, sets a low-balance alert and breaks usage down by Tenant and by key.

Until the Organisation first adds credit, it can have 100 Tenants.

Deleting the Organisation loses any unspent credit.