Workspaces
Create workspace
Create a new workspace to organize computers.
POST
Create workspace
Creates a workspace and returns it with
A workspace-scoped API key can call this, and it gets a new workspace it is not scoped to. Key scope is not enforced on this endpoint. See Authentication.
The create response does not include
201. The calling account becomes the owner.
Workspaces are containers for computers. Use them to separate projects, environments, or teams.
Request
string
required
Workspace name. Leading and trailing whitespace is trimmed. The name must not match one you already own, compared case-insensitively. Names of workspaces shared with you do not conflict. Missing, non-string, or whitespace-only values are rejected with
400.string
Optional URL of an icon for the workspace. Stored as given and not validated. Omit it and the workspace is created with
icon_url: null.string
default:"active"
Optional. Defaults to
active when omitted. The product understands active and inactive. The field is stored as given and is not validated against that list.Response
string
Workspace identifier. Use it as
workspace_id when creating computers.string
Workspace name, trimmed.
string
User ID of the owner, which is your account.
string
Workspace status.
string
Icon URL, or
null when none was sent.string
ISO 8601 timestamp.
updated_at, owner_tier, owner_email, or desktops. Get workspace returns those.
Example
Response
Errors
Some error bodies on this endpoint carry a
code alongside error. Branch on code where it is present. It is stable, and the error string is not.Authorizations
API key authentication. Get your key at orgo.ai/workspaces
Body
application/json
Response
Workspace created
Unique workspace identifier
Example:
"550e8400-e29b-41d4-a716-446655440000"
Workspace name
Example:
"production"
Owner user ID
Available options:
active, inactive Example:
"active"
Icon URL for the workspace, or null when none is set.