Workspaces

A workspace in System Initiative is the isolation boundary for a set of models. They are a hard boundary between data. Workspaces have multiple 'members' that map to users in System Initiative.

Interacting with Workspaces

Creating New Workspaces

Click the 'Create New Workspace' button:

You'll be asked to provide a Display Name for your workspace, an optional description, and to choose one of 3 workspace types:

• Managed By System Initiative: The default. The workspace will be managed by the System Initiative SaaS platform.
• Local Dev Instance: The workspace will be created in your local development environment.
• Remote URL: The workspace will be created in a publicly available instance of System Initiative at the specified URL. This option is only used in Bring Your Own Cloud or custom deployments.

Click 'Create Workspace' to create your new workspace.

If you want a workspace in the managed System Initiative SaaS product use app.systeminit.com as the instanceUrl.

TypeScript

const api = new WorkspaceManagementApi(apiConfig);
const response = api.createWorkspace({
  createWorkspaceRequest: {
    description,
    displayName,
    instanceUrl,
  },
});

Python

request = CreateWorkspaceRequest(
  description=description,
  displayName=displayName,
  instanceUrl=instanceUrl,
)
api = WorkspaceManagementApi(client)
response = api.create_workspace(
  create_workspace_request=request
)

Update Workspace

Click on the 'Gear' icon on an existing workspace and choose 'Settings'.

From here, you can change your workspaces' Display Name or Description, access the API tokens screen, invite users to the workspace, and configure the role of a user within your workspace.

TypeScript

const api = new WorkspaceManagementApi(apiConfig);
const response = api.updateWorkspace({
  workspaceId,
  updateWorkspaceRequest: {
    description,
    displayName,
    instanceUrl,
  },
});

Python

request = UpdateWorkspaceRequest(
  description=description,
  displayName=displayName,
  instanceUrl=instanceUrl,
)
api = WorkspaceManagementApi(client)
response = api.update_workspace(
  update_workspace_request=request
)

Add a User to a Workspace

You can add users to the workspace by adding their email and clicking 'Add User to Workspace':

TypeScript

const api = new WorkspaceManagementApi(apiConfig);
const response = api.inviteMember({
  workspaceId,
  inviteMemberRequest: {
    email,
  },
});

Python

request = InviteMemberRequest(
  email=email,
)
api = WorkspaceManagementApi(client)
response = api.invite_member(
  invite_member_request=request
)

Set a User's Role in a Workspace

You can set a user's Role in a workspace:

There are two options:

• Collaborator: the user will be able to propose changes to a workspace, but will not be able to apply or approve change sets.
• Approver: the user will be able to approve changes to the workspace and apply change sets.

TypeScript

const api = new WorkspaceManagementApi(apiConfig);
const listResponse = api.listMembers({
  workspaceId,
});

const userId = listResponse.data.pop()?.userId;

const response = api.updateMemberRole({
  workspaceId,
  updateMemberRole: {
    userId,
    role,
  },
});

Python

request = UpdateMemberRoleRequest(
  role=role,
  user_id=user_id,
)
api = WorkspaceManagementApi(client)
response = api.update_member_role(
  update_member_role_request=request
)

Remove a User from a Workspace

To remove a user from the workspace, click the 'Trash' icon next to their email in the members list:

TypeScript

const api = new WorkspaceManagementApi(apiConfig);
const response = api.removeMember({
  workspaceId,
  removeMemberRequest: {
    email,
  },
});

Python

request = RemoveMemberRequest(
  email=email,
)
api = WorkspaceManagementApi(client)
response = api.remove_member(
  remove_member_request=request
)

Leaving a Workspace

To leave a workspace with the CLI:

si workspace leave "Production Workspace"
? Are you sure you want to leave workspace "Production Workspace"? (y/N) › Yes
✨ info    si              Leaving workspace "Production Workspace"...
✨ info    si              Successfully left workspace: Production Workspace

Click on the 'Gear' icon on an existing workspace and choose 'Settings'.

From here, you can change or leave your workspace.

INFO

Workspace owners are not permitted to leave their workspace.

TypeScript

const api = new WorkspaceManagementApi(apiConfig);
const response = api.leaveWorkspace({
  workspaceId,
});

Python

api = WorkspaceManagementApi(client)
api.leave_workspace(
    workspace_id="your-workspace-id"
)

Deleting a Workspace

To delete a workspace with the CLI:

si workspace delete "Production Workspace"
? Are you sure you want to delete workspace "Production Workspace"? To recover this operation, you need to contact customer service at support@systeminit.com. This operation will leave any existing resources running. (y/N) › Yes
✨ info    si              Deleting workspace "Production Workspace"...
✨ info    si              Successfully deleted workspace: Production Workspace

Click on the 'Gear' icon on an existing workspace and choose 'Settings'.

From here, you can change or delete your workspace.

INFO

Only workspace owners can delete a workspace!

TypeScript

const api = new WorkspaceManagementApi(apiConfig);
const response = api.deleteWorkspace({
  workspaceId,
});

Python

api = WorkspaceManagementApi(client)
api.delete_workspace(
    workspace_id="your-workspace-id"
)

API Token Management

API Tokens in System Initiative are used by the Public API and AI Agent to access a System Initiative workspace on a users behalf.

You can manage API tokens by either selecting the 'Manage Workspace Tokens' option from the workspace in the Web Application:

From the Workspace Management screen, through the 'Gear' icon and selecting 'API Tokens':

Or from the Workspace Settings screen by clicking the 'Key' icon:

Each option will lead you to the API Tokens management screen:

Generate API Token

To generate a new API token, provide a token name and a suitable expiration, such as '1y' or '48h'.

Then click the 'Generate API Token' button. The token will then be shown only one time in a modal. Copy the token and store it somewhere safe - it gives you access to your System Initiative workspace!

It will then appear in the 'Active Tokens' list.

Revoking an API Token

While API Tokens cannot be retrieved, they can be revoked. To revoke an API token, click the 'Trash' icon next to the token you wish to revoke. It will then be moved to the 'Inactive Tokens' list.