Creates a workspace inside an organisation on the chosen Bitcoin network, and returns the new workspace with the role you hold in it.
AccessRequires a permission in the workspaceMANAGE_WORKSPACE
A workspace is the boundary everything else sits inside: its own vaults, tokens,
policies, role assignments, and audit history, none of which cross into another
workspace. net sets the Bitcoin network, and every vault and token created in
this workspace inherits it, so this one field fixes the network for all the work
that follows. Workspaces describes the
same step in the interface, and why organisations keep separate workspaces.
new_workspace nests two objects. WorkspaceInfo is the workspace itself,
whose uid is the value you pass as workspace_id on almost every other call.
Role is the role you hold in the new workspace, with the permission keys
attached to it, in the same shape as the memberships on the User object under
Shared objects.
!
warning:
Mainnet moves real value
Choosing mainnet means every vault and token in this workspace transacts in
real Bitcoin and real tokens. Confirm the network before you call this
endpoint, because it applies to the whole workspace rather than to each vault
in turn. Testnet is for supervised training and pre-production testing only.
Body parameters
workspace_namestringrequired
Display name for the workspace, shown throughout the application. Choose a name that identifies its purpose.
descriptionstringrequired
Short description of what the workspace is for.
org_uidnumberrequired
The organisation the new workspace belongs to.
current_workspace_uidnumberrequired
The workspace you are working in when you make the request.
netstringrequired
The Bitcoin network the workspace operates on. Either mainnet or testnet, and every vault and token created in the workspace inherits it.
The workspace starts empty. Invite members, assign their roles, and register the
signing keys that will approve movements, then create a vault with
POST /api/v1/create_wallet on the same network as the
workspace before any value can move.
