Skip to main content
The following information applies only to Unstructured organizational accounts. To request an organizational account to be created, contact your Unstructured sales representative, email Unstructured Sales at sales@unstructured.io, or complete the online Unstructured contact form.
A workspace is a collection of resources such as connectors, workflows, jobs, and API keys. Each workspace operates independently of all other workspaces.

​
Workspace architecture

A workspace can belong to an organizational account or to a user’s personal account. Every organizational account begins with one default workspace. An organizational account can have multiple workspaces. (A user’s personal account always has one and only one workspace.) Users can have access to multiple workspaces within an organizational account. Each user must be explicitly added to each workspace that they are allowed to access. (A user always has access to their personal workspace within their personal account.) This assumes that the user has first been added to the workspace’s parent organizational account. To make programmatic API calls to a workspace instead of using the UI, an API key must first exist for that workspace. The caller then uses that API key to make API calls to that workspace. Each API key is valid only for its related workspace.

​
Create a workspace

To create a workspace, you must first have an available Unstructured organizational account. Currently, only Unstructured representatives can create organizational accounts. To request an organizational account to be created, contact your Unstructured sales representative, email Unstructured Sales at sales@unstructured.io, or complete the online Unstructured contact form.
Your user must have the Super Admin role in the intended workspace’s parent organizational account to create workspaces in that organizational account.(A user always has one and only one personal workspace within their personal account. You cannot create additional workspaces in personal accounts.)
  1. Depending on the location of the organizational account that you want to access, sign in to https://platform.unstructured.io, or sign in by using the URL for your organization’s self-hosted deployment of Unstructured.
  2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that you want to add a workspace to.
  3. In the sidebar, above your user icon, click the Settings (gear) icon.
  4. Click View All Workspaces.
  5. Click New Workspace.
  6. In the Create New Workspace dialog, enter a name for the new workspace.
  7. Optionally, enter a budget limit for the new workspace. If you do not want to set a budget limit, leave this field blank.
    This workspace budget limit is for informational purposes only. Workspace usage is not stopped if this limit is exceeded.
  8. Click Continue.

​
Access a workspace

  1. Depending on the location of the organizational account that you want to access, sign in to https://platform.unstructured.io, or sign in by using the URL for your organization’s self-hosted deployment of Unstructured.
  2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to access.
  3. In the workspace selector, select the name of the workspace that you want to access. If the workspace selector does not show the workspace you want to access, then your user has not been added to that workspace. To be added to the workspace, contact one of the workspace’s administrators or its parent organizational account’s administrators.

​
Add a member to a workspace

Your user must have either the Super Admin role in the workspace’s parent organizational account or the Workspace Admin role in the workspace to add members to that workspace.The user to be added must also have the Developer role in the workspace’s parent organizational account.(A user always has access to their personal workspace within their personal account.)
To add a user to a workspace as a member:
  1. Make sure the account user that you want to add has already been added as a member of the workspace’s parent organizational account. Learn how.
  2. Depending on the location of the organizational account that you want to access, sign in to https://platform.unstructured.io, or sign in by using the URL for your organization’s self-hosted deployment of Unstructured.
  3. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to add a member to.
  4. In the workspace selector, select the name of the workspace that you want to add a member to.
  5. In the sidebar, above your user icon, click the Settings (gear) icon.
  6. Click Manage Workspace.
  7. In the top navigation bar, click Members.
  8. Click Add New Member.
  9. In the Add New Member dialog, select one of the organizational account’s members to add to this workspace as a member.
  10. In the role selector, select the new team member’s role for this workspace.
  11. Click Continue.

​
Change a workspace role for a member

Your user must have either the Super Admin role in the workspace’s parent organizational account or the Workspace Admin role in the workspace to change the roles for that workspace’s members.
  1. Depending on the location of the organizational account that you want to access, sign in to https://platform.unstructured.io, or sign in by using the URL for your organization’s self-hosted deployment of Unstructured.
  2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace for the member you want to change roles for.
  3. In the workspace selector, select the name of the workspace that contains the member you want to change roles for.
  4. In the sidebar, above your user icon, click the Settings (gear) icon.
  5. Click Manage Workspace.
  6. In the top navigation bar, click Members.
  7. Next to the member you want to change roles for, click the ellipses.
  8. Click Edit Permissions.
  9. Select the new role.
  10. Click Continue.

​
Remove a member from a workspace

A member who is removed from a workspace will no longer have access to the workspace. The member will continue to be able to use their personal account and personal workspace.Any connectors, workflows, jobs, or other resources that were created by the member within the workspace will not be removed.The only way to reverse removing a member from a workspace is to add the member back to the workspace.
Your user must have either the Super Admin role in the workspace’s parent organizational account or the Workspace Admin role in the workspace to remove members from that workspace.(A user cannot be removed from their personal workspace within their personal account.)
  1. Depending on the location of the organizational account that you want to access, sign in to https://platform.unstructured.io, or sign in by using the URL for your organization’s self-hosted deployment of Unstructured.
  2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to remove a member from.
  3. In the workspace selector, select the name of the workspace that you want to remove a member from.
  4. In the sidebar, above your user icon, click the Settings (gear) icon.
  5. Click Manage Workspace.
  6. In the top navigation bar, click Members.
  7. In the list of members, click the ellipses next to the member that you want to remove.
  8. Click Remove Member.
  9. Confirm the removal by clicking Continue.

​
Create an API key for a workspace

Your user must have either the Super Admin role in the workspace’s parent organizational account or the Workspace Admin or Developer role in the workspace to create API keys for that workspace.
To make programmatic API calls to a workspace instead of using the UI, an API key must first exist for that workspace, and then the caller uses that API key to make API calls to that workspace. An API key can be used only with the workspace for which it was created.
  1. Depending on the location of the organizational account that you want to access, sign in to https://platform.unstructured.io, or sign in by using the URL for your organization’s self-hosted deployment of Unstructured.
  2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to create an API key for.
  3. In the workspace selector, select the name of the workspace that you want to create an API key for.
  4. In the sidebar, above your user icon, click the Settings (gear) icon.
  5. Click Manage Workspace.
  6. In the top navigation bar, click API Keys.
  7. Click Generate New Key.
  8. Enter some name for the key, and click Continue.
  9. To get the key’s value, in the list of available keys, click the Copy icon next to the newly created key. The key’s value is copies to your system’s clipboard.

​
Delete an API key for a workspace

An API key is valid only for the workspace for which it was created.
Deleting an existing API key is a permanent operation. Deleted API keys cannot be recovered.You cannot use a deleted API key to call the Unstructured APIs.
Your user must have either the Super Admin role in the workspace’s parent organizational account or the Workspace Admin or Developer role in the workspace to delete API keys from that workspace.
  1. Depending on the location of the organizational account that you want to access, sign in to https://platform.unstructured.io, or sign in by using the URL for your organization’s self-hosted deployment of Unstructured.
  2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to delete an API key for.
  3. In the workspace selector, select the name of the workspace that you want to delete an API key for.
  4. In the sidebar, above your user icon, click the Settings (gear) icon.
  5. Click Manage Workspace.
  6. In the top navigation bar, click API Keys.
  7. n the list of available keys, click the ellipses next to the key you want to delete.
  8. Click Delete.
  9. Confirm the deletion by clicking Continue.

​
Permanently delete a workspace

Deleting a workspace is a permanent action and is not recoverable. Once a workspace is deleted, all connectors, workflows, jobs, and API keys that are associated with that workspace are also deleted and are not recoverable.The workspace’s members are not deleted, but they will no longer have access to the deleted workspace’s connectors, workflows, jobs, and API keys.Any code or scripts that reference the deleted workspace’s connectors, workflows, jobs, or workspace API keys will fail.
A user’s personal workspace cannot be deleted from their personal account.
Only authorized Unstructured representatives can delete workspaces. To request a workspace to be permanently deleted, contact your Unstructured sales representative, email Unstructured Sales at sales@unstructured.io, or complete the online Unstructured contact form.