Workspaces

RapidCanvas platform supports multiple workspaces. Each workspace operates independently, ensuring complete isolation from others. Users and projects within a workspace are restricted to that specific workspace, and projects from one workspace cannot be viewed or accessed by another. For users with access to multiple workspaces, projects and associated resources—such as DataApps, environments, and prediction services—can be copied between workspaces, provided the necessary permissions are in place.

Access to workspaces is strictly controlled, allowing users to interact only with those they are authorized for, ensuring secure and organized collaboration.

Only admin users who have permission can create workspaces.

Creating and managing workspaces

Use this procedure to create a workspace in an instance.

To create a workspace:

1. From the current workspace drop-down on the top-right corner of the screen, click +Create a new workspace

   

   Create a new workspace

   This displays the Create Workspace window.

2. Specify the Workspace details:

   • Workspace Name: The name of the workspace.

   • Workspace description: The description for the workspace.

   • License key: A valid license key to create a workspace. This license key is provided by the service provider.

   

   Workspace details
3. Click TEST to check whether the license key provided is valid or not. The Create button will be enabled only if the license key is valid.

4. Click Create. This creates a new workspace in your instance and directs you to the workspace management dashboard page.

5. Click the Edit icon to change the workspace’s name, on the Workspace Settings tab.

   

   Workspace Settings

Settings

The settings page gives you access to workspace and Admin settings.

• Admin settings - You can update the license key, change the DataApp settings and view the license quotas. For more information, see Admin settings.
• Workspace settings - You can add users, generate workspace token, view total users and projects in your workspace, and edit workspace details. For more information, see Workspace settings.

Workspace Settings

The workspace Settings tab provides an overview of the number of projects available for a workspace. The following are the widgets you can view on the dashboard. The tasks you can perform depend on user permissions.

Workspace dashboard

Workspace name

Displays the workspace’s name. Visible only to Admin users who are also allowed to edit the workspace name and description.

Workspace Stats

Displays the total number of projects in a workspace and the users associated with this workspace.

Workspace token

You can also generate workspace auth token to make API calls to the platform.

Users

Displays the total number of users in the workspace. Users with the Admin role can view and create users, while those with the DataApp-View role can only access the DataApps module within the workspace.

Users assigned the User role have access to all features but cannot invite new users or modify existing user details. Those with the Business User role have access limited to specific features.

For a detailed breakdown of permissions associated with each user role, See details in this table User roles and permissions

Admin settings

The Admin users can view the permissions, license status, and license quotas on this tab.

To access the Admin settings area:

1. Click the current workspace drop-down and select Settings. The workspace Settings tab is displayed by default.

2. Click the Admin Settings tab to view the information organized into four distinct tabs.

   

   Admin settings
3. Click the License & Permissions tab to review the license information:

   1. Under License section view this information:

      • Status: The status of the license.

      • Key: The license key of this workspace. Whenever the license key is updated, the sync happens automatically and the expiration date gets updated accordingly.

      • Expiration Date: The expiration date of this license key. When the expiry date is nearing, there is an alert displayed corresponding to this field to inform the Admin about the number of days left for the renewal of the license key.

   2. Click Update License Key to update the expired license.

   3. View the Create workspace toggle under the Permissions section. This option is enabled only if Admin users have permission to create a workspace and remains disabled if users do not have the permission to create workspaces.

   4. Review the license quotas to view the restrictions set for the workspace, including the maximum number of users that can be added, the accepted email addresses, and other related limitations.

4. Click the DataApp Settings tab to modify the duration after which the DataApp should automatically shut down. This duration is specified in hours, and you can set it between 0 and 262,800 hours. If you set the duration to 0, the DataApp will remain active indefinitely. The configured time applies to all DataApps created within the workspace. However, if a shutdown time is set at the individual DataApp level, that setting will take precedence.

5. Click the Secrets tab to configure secrets by providing the Name and Value in the respective fields, then click Save. You can add as many secrets as you want here. The configured secrets can be used in the helper functions of AskAI. You can also modify the secret key values at a later time, using the Edit option.

   

   Secrets
6. Click the API Keys tab to create and manage API keys. These keys are essential for authentication and must be included in the request header when accessing the Prediction service or other API endpoints. Additionally, they can be used to generate tokens when needed. For more information, see

   1. Creating API keys
   2. Managing API keys

Creating API keys

Use this procedure to create and manage API keys.

1. Click the current workspace drop-down and select Settings. The Workspace Settings tab will be displayed by default.

2. Navigate to the Admin Settings tab and select the API Keys tab.

3. Click the Plus (+) button to create a new API key. This will open the Create API Key modal.

4. Enter the following details:

   • API Key Name: Provide a clear and descriptive name to easily identify the API key.

   • Role: Select the role for which you want to generate the API key. The roles available are:

     • DataApp Consumer

     • DataApp Power User

     • DataApp View

     • User

   • Expiry Date: Select the date when the API key will expire. The expiry date must be minimum of 1 month and maximum of 2 years.

1. Click Save. The system will generate an API key, which you can either copy immediately or download as a markdown file for safekeeping.

2. Once you have copied or downloaded the key, click Done to close the modal. Use the Copy option to copy the token or the Download option to save the key to your device.

If you're unsure how to use the API key, click Syntax. This will display the correct format and examples showing how to include the key in an endpoint for both cURL and Python requests.

Syntax for different scenarios

Syntax to call Prediction service and other endpoints

Example of cURL syntax to call Prediction service and any API endpoint:

curl -X POST 'https://test.dev.rapidcanvas.net/api/v2/predict/MyPredictionService' \
--header 'content-type: application/json' \
--header 'X-API-KEY: <RC_APIKEY>' \
--data-raw <JSON_DATA>

Explanation:

API Key

An API key is a unique identifier required for authentication. It must be included in the request header. Example - <RC_APIKEY>

JSON Data

The JSON payload contains the input parameters required by the Prediction service. This data is passed in the POST request body. Example: <JSON_DATA>

Response Format

A successful request returns a JSON response with the generated prediction. If an error occurs, an appropriate error message is returned.

The following example demonstrates how to send a POST request to the Prediction service API using Curl:

curl -X POST 'https://staging.dev.rapidcanvas.net/api/v2/predict/MyPredictionService' --header 'content-type: application/json' --header 'X-API-KEY: abc-43534534-56756654-werw-82ec-53454334' --data-raw '[{"PassengerId":1,"Pclass":3,"Name":"Braund, Mr. Owen Harris","Sex":"male","Age":22,"SibSp":1,"Parch":0,"Ticket":"A/5 21171","Fare":7.25,"Cabin":"","Embarked":"S"},{"PassengerId":2,"Pclass":1,"Name":"Cumings, Mrs. John Bradley (Florence Briggs Thayer)","Sex":"female","Age":38,"SibSp":1,"Parch":0,"Ticket":"PC 17599","Fare":71.2833,"Cabin":"C85","Embarked":"C"},{"PassengerId":3,"Pclass":3,"Name":"Heikkinen, Miss. Laina","Sex":"female","Age":26,"SibSp":0,"Parch":0,"Ticket":"STON/O2. 3101282","Fare":7.925,"Cabin":"","Embarked":"S"},{"PassengerId":4,"Pclass":1,"Name":"Futrelle, Mrs. Jacques Heath (Lily May Peel)","Sex":"female","Age":35,"SibSp":1,"Parch":0,"Ticket":113803,"Fare":53.1,"Cabin":"C123","Embarked":"S"}]'

Example of Python syntax to call Prediction service and any API endpoint:

import requests

url = "https://test.dev.rapidcanvas.net/api/v2/predict/MyPredictionService"
headers = {
    "content-type": "application/json",
    "X-API-KEY": "<RC_APIKEY>"
}
# Replace <JSON_DATA> with your actual JSON payload
data = {
    # Your JSON data here
}
response = requests.post(url, headers=headers, json=data)

Syntax to generate Auth token from API key

Example of cURL syntax to generate Auth token from API key

curl --location 'https://test.dev.rapidcanvas.net/api/access_key/token' \
--header 'accept: application/json' \
--header 'X-API-KEY: <RC_APIKEY>'

Explanation:

Description

This endpoint generates an authentication token using an API key. The token can be used to authenticate subsequent requests to the Prediction service and other API endpoints.

Endpoint URL

https://test.dev.rapidcanvas.net/api/access_key/token

Request Headers

Header	Type	Required	Description
accept	string	Yes	Specifies the response format. Set to application/json.
X-API-KEY	string	Yes	The API key required for authentication. Replace <RC_APIKEY> with your actual key. To generate this key, refer to Creating API keys

Example Request (cURL)

curl --location 'https://test.dev.rapidcanvas.net/api/access_key/token' \
--header 'accept: application/json' \
--header 'X-API-KEY: acdd-2323-23432'

Response

Success - 200 OK

Response Fields

Field	Type	Description
access_token	string	The generated token for authentication.
expires_in	integer	Token validity duration in seconds.

Example of Python syntax to generate Auth token from API key

import requests

url = "https://test.dev.rapidcanvas.net/api/access_key/token"
headers = {
    "accept": "application/json",
    "X-API-KEY": "<RC_APIKEY>"  # Replace with your actual API key
}
response = requests.get(url, headers=headers)
print("Token:", response.json()["token"])

Syntax to generate Auth token from API key with additional parameters

Example of cURL syntax to generate Auth token from API key with additional parameters

curl --location 'https://qa.dev.rapidcanvas.net/api/access_key/token' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <RC_APIKEY>' \
--data '{
    "extUserId":"ID",
    "customProps": {
        "rc-ext-ds": "SQL connector name",
        "table-name": "Table name in the SQL connector"
    }
}'

Explanation:

Endpoint URL

https://qa.dev.rapidcanvas.net/api/access_key/token

Description

This endpoint generates an authentication token using an API key with additional parameters. The token can be used to authenticate subsequent requests to the Prediction service and other API endpoints.

Request Headers

Header	Type	Required	Description
accept	string	Yes	Specifies the response format. Set to application/json.
X-API-KEY	string	Yes	The API key required for authentication. Replace <RC_APIKEY> with your actual key. To generate this key, refer to Creating API keys

Request body

Parameter	Type	Description
extUserId	String	A unique identifier from the platform, used to generate an authentication token for RapidCanvas
customProps	Object	Additional properties for customization.
rc-ext-ds	String	The SQL connector name that must exist in the platform for the tenant you are generating the auth token for.
table-name	String	The name of the table in the SQL based connector.

Example Request (cURL)

curl --location 'https://qa.dev.rapidcanvas.net/api/access_key/token' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: rc-23432423-23423-45645-3454-d72werwe3469' \
--data '{
    "extUserId":"32423423-3ae9-45343-88fa-b32423432",
    "customProps": {
        "rc-ext-ds": "mysql_abc",
        "table-name": "new"
    }
}'

Response

Success - 200 OK

Response Fields

Field	Type	Description
access_token	string	The generated token for authentication.
expires_in	integer	Token validity duration in seconds.

Example of Python syntax to generate API token from API key with additional parameters

```python
import requests

url = "https://qa.dev.rapidcanvas.net"
headers = {
    "Content-Type": "application/json",
    "X-API-KEY": "<RC_APIKEY>" # Replace with your actual API key
}
data = {
    "extUserId": "<EXT_USER_ID>", # A unique identifier from the platform, used to generate an authentication token for RapidCanvas
    "customProps": {
        "rc-ext-ds": "mysql_connector", #The SQL connector name that must exist in the platform for the tenant you are generating the auth token for. 
        "table-name": "mysql_table"     #The name of the table in the SQL based connector. 
    }
}

response = requests.post(url, headers=headers, json=data)

# Print the response
print(response.status_code)
print(response.json())
```

Managing API Keys

You can edit or delete API keys from the API Keys tab in the Admin Settings section.

Editing API Key Details

If you need to modify an API key’s expiry date or name, you can use the Edit option.

To edit API key details:

1. Click the current workspace drop-down and select Settings.

   • The Workspace Settings tab will be displayed by default.

2. Navigate to the Admin Settings tab and select the API Keys tab.

3. Click the kebab menu (⋮) next to the API key and select Edit.

   • The Edit API Key window will open.

4. Modify the expiry date and/or API key name as needed.

5. Click Update to save the changes.

Deleting an API Key

If an API key is no longer needed, you can permanently delete it.

To delete an API key:

1. Click the current workspace drop-down and select Settings.

   • The Workspace Settings tab will be displayed by default.

2. Navigate to the Admin Settings tab and select the API Keys tab.

3. Click the kebab menu (⋮) next to the API key and select Delete.

   • The Delete API Key window will open.

4. Click Yes to confirm and permanently delete the API key.

⚠ Note: Once deleted, an API key cannot be recovered. Ensure no active services depend on it before proceeding.

Viewing the list of Users

The workspace management screen allows you to view the list of users linked to a workspace.

List of users

To view list of users in a workspace:

1. Click the current workspace drop-down on the right-corner of the page and select Settings. This opens the workspace management screen.

2. Review the user details on the workspace Settings tab:

   Username- The name of the user who has access to this workspace.

   Status- The status of the workspace. Possible values:

   • Pending - The user is yet to sign up to the workspace.

   • Active - The user account is active.

   • Link Expired - The sign up link sent to the user has been expired and you must resend the invitation.

   • Canceled - The invitation sent to the user has been deleted by the admin.

   Role – The role assigned to the user for this workspace. Possible values:

   • Admin - User with this role can access all features on the platform.

   • DataApp-View - User with this role can only access the DataApp module.

   • User Role - User with this role can access all features on the platform, but cannot invite new users or edit the details of existing users.

   • Business User - User with this role can access projects, DataApps, AI-assisted recipe, Rapid Model Recipe, and Dataconnector modules only. These users cannot create scenarios, segments, workspaces, and add models and artifacts. Also, the global variables in projects are not visible. They cannot set the recipe timeout period for AI-assisted and Rapid model recipes.

   Created on- The date on which the user has been created.

   Last Login- The most recent login of the workspace with date and time is shown.

   Actions

   • Click the delete button to delete the user permanently. For more information, see Deleting a user.
   • Click the edit button to change the user role. For more information, see Editing a role.
   • Click the REINVITE button to resend an invitation to the user for joining the platform or workspace. This option appears only if the user's original invitation link has expired.

Note: You are allowed to change the details of other users, but not self.

Inviting users to join the platform

Use this procedure to invite a user to access the projects in a workspace by giving them a role. Only users with Admin role can send the invitation emails.

To invite users:

1. Select the workspace drop-down on the right-corner of the page and select Invite user. This opens the Invite users window for the workspace.

   

   Invite users
2. Select a User Role. Possible values:

   • Admin

   • DataApp-View

   • User Role

   • Business Role

3. Select Invite type. Possible values:

   • Email Invite – An email invite is sent to the users.

   • Using Link (URL) – An auth link is shared with users.

   Here, we are selecting the Invite type as Email Invite.

   

   Invite users
4. Provide the email address of the user in the User Emails field.

Note: This field is only displayed when the invite type is set to Email Invite. You can also enter multiple email addresses separated by comma or space at once.

Note: Use the cross button to clear the provided email addresses in this field.

1. Click Send Invite. An invite is sent to the user to the provided email address(es).

In the Users section, view the list of users and the invitations sent to them. The status of invited users is displayed as Pending until they accept the invitation. Once accepted, the status updates to Active.

Inviting users through link

Use this procedure to send an invite to users through link.

1. Select the Invite type as Using Link (URL).

2. Provide the email address of the user and click Generate Auth Link. The Auth link is populated in the Auth link field.

   

   Invite users through link
3. Click the Copy icon corresponding to the Auth link field to copy the link and share with the user(s).

Note: You can send invitation for one user to join multiple workspaces.

Editing a role

Use this procedure to change the user roles.

To edit a role:

1. Select the current workspace and select switch workspace to switch to the workspace in which you want to change the user role.

2. Select workspace Settings. The workspace Management page appears.

3. Click the Edit icon corresponding to the user whose role must be changed. The role Column is enabled with the drop-down to change the user role.

   

   Edit role
4. Select the appropriate role of the invited user. Possible values:

   • Admin- Can invite new users and remove users and have all permissions.

   • DataApp-View - Can only view the DataApp module.

   • User role - Can access all the features on the platform, but cannot invite new users or edit the details of existing users.

   • Business user - Can access projects, DataApps, and Connectors modules. The user with this role will not have permission to create, edit, and view some of the features on the platform. See details in this table User roles and permissions

   

   Edit role
5. Click Save once done.

   

   Edit role

Note: Click Cancel to discard the changes.

Deleting a user

Only Admin users have permissions to delete a user from the workspace.

To delete users from a workspace, follow these steps:

1. Select the workspace and select Switch workspace. This opens the list of workspaces to which the admin has access to.

2. Select the workspace to which you would like to add the user.

3. Select workspace Settings of a workspace from which you want to delete a user. The workspace Management page appears.

4. Click the delete icon corresponding to the user whom you want to delete. The following prompt is displayed.

   

   Delete user
5. Click Remove to permanently remove the user from the workspace.

Reinviting the users

Administrators can resend the invitation to users in case the user has not received, deleted or could not sign up or join the workspace.

Note: The invitation link will be valid only for 14 days.

1. Select the workspace and select Switch workspace. This opens the list of workspaces to which the admin has access to.

2. Select the workspace to which you would like to add the user.

3. Select workspace Settings of a workspace from which you want to re-invite any user. The workspace Management page appears.

4. Click Re invite corresponding to the user to which the invitation must be resent. The Reinvite modal displays the email address to which the authentication link has been sent.

Switching between Workspaces

Some user accounts may have access to multiple workspaces. When logged in to the platform, the user will see the active workspace name on the dashboard. The switch workspace feature enables you to switch between multiple workspaces without having to log out. This is only for users who have access to more than one workspace.

Switching between workspaces from the dashboard

To switch to another workspace from the dashboard:

1. Select the current workspace drop-down and select the arrow corresponding to this workspace to open the list of workspaces to which the user has access to.

   Here, you can see the list of workspaces under workspace switch, workspaces with invalid license, and new workspaces.

   

   Switch workspace
2. Select the desired workspace from the Workspace Switch to access resources associated with it. If there are multiple workspaces, you can use the search function to quickly locate the specific workspace you need.

Note:

• You can also view the workspaces with invalid license.

• You can also accept to join the new workspaces from here.

Switching between workspaces from Profile Settings:

To switch workspaces from settings:

1. Click the Profile icon on the dashboard and select Settings. The profile page appears.

   

   Switch workspace
2. Review this information in the workspaces section:

   • Workspace Name: The name of the workspace.

   • Projects: The number of projects linked to the workspace or available in this workspace.

   • Users: The total number of users associated with this workspace.

   • Role: The role of the logged in user.

3. Perform any of the following actions:

   • Switch - You can use this option to switch to another workspace in this environment.

   • Leave - You can leave the workspace. This option is displayed against the currently active workspace in an instance.

   • Accept - You can view and accept the invitation you received to join a new workspace from here.

4. Click Switch corresponding to the workspace to which you want to make a switch.

You can use the table settings icon to select only the columns you want to view and reorder them in the table using the reordering icon.

Changing the memory and CPU usage limit for Notebook

Use this procedure to change the CPU and memory resources allocated for Notebook based on the projects you are running.

To change the memory and CPU usage:

1. Click the Profile icon on the dashboard and select Settings. The profile page appears.

2. Allocate resources to run projects in Jupyter Notebook by specifying the desired RAM and CPU. You can allocate up to a maximum of 16GB RAM and 8 GHz CPU.

   

   Notebook settings
3. Click Apply to allocate the resources. Once allocated, the settings are saved automatically. However, you have to relaunch the Notebook if you are already on Notebook after changing the settings.

Note: You can change the allocated resources for the Notebook user whenever you want.