Skip to main content
POST
Add a client
The client gets their own workspace and a key scoped to it. They never sign up to Orgo: your app uses the key on their behalf. The key is in this response only, so store it with your user. Use your account-wide API key. A client’s own key gets 403 here. See Invoicing.

Body

string
Shown in Settings. Send this, external_id, or both.
string
Your id for this client, unique among your clients. Made from name when you leave it out.
integer
The most computers they can have. No limit when left out.
number
Their AI stops at this amount each month. No limit when left out.

Response

string
The client’s key. Shown once.
Every field of Get client.

Example

Response

Errors

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Body

application/json
name
string

Shown in Settings. Send this, external_id, or both.

external_id
string

Your id for this client, unique among your clients. Made from name when you leave it out.

max_computers
integer

The most computers they can have. No limit when left out.

monthly_ai_cap_usd
number

Their AI stops at this amount each month. No limit when left out.

Response

Created

A client: a workspace you run for them, with a key scoped to it.

id
string
external_id
string
name
string | null
status
enum<string>
Available options:
active,
closed,
transferred
workspace_id
string
created_at
string<date-time>
closed_at
string<date-time> | null
limits
object
usage
object
billing
object | null
transfer
object | null
computers
object[]

On Get client only.

api_key
string

Shown once.