Workspace Management
Overview
Hyperia stores and indexes analyzed meetings and uploaded media files in a searchable online index. Workspaces are provided to partition uploaded files into multiple separate indices, enabling easier segmented analysis, search, aggregation, and document management. Multiple workspaces can be created, deleted, or used to contain uploaded recordings for performing searches and other analysis (aggregations, etc).
Create a Workspace
Creates a Hyperia Workspace. Workspaces are used to encapsulate documents, automations, labels, and more.
Endpoint:
/v1/management/workspace/create
HTTP Method:
PUT
Parameters:
| Name | Description |
|---|---|
| workspace_name | Name of the workspace |
Returns:
If successful: HTTP 200
Return Payload:
{
"status": "ok",
"result": {
"workspace_id": "GUID_OF_CREATED_WORKSPACE"
}
}Code Sample:
from hyperia import Hyperia
import sys
hyperia = Hyperia()
result = hyperia.workspace_create("Sample Workspace")
if not response:
sys.exit(-1)
workspace_id = response['workspace_id']Delete A Workspace
Deletes a Hyperia Workspace. Deletes any documents, automations, labels, or other resources stored in the Workspace.
Endpoint:
/v1/management/workspace/delete/<workspace_id>
HTTP Method:
DELETE
Parameters:
None
Returns:
If successful: HTTP 200
Return Payload:
{
"status": "ok"
}Code Sample:
from hyperia import Hyperia
import sys
workspace_id = "SOME_WORKSPACE_GUID"
hyperia = Hyperia()
result = hyperia.workspace_delete(workspace_id)
if not response:
sys.exit(-1)
// success!List Accessible Workspaces
Lists accessible Workspaces. Does not include "public" Hyperia content repository Workspaces. Please use the List Public Workspaces endpoint for accessing information on accessible public workspaces.
Endpoint:
/v1/workspace/list
HTTP Method:
GET
Parameters:
None
Returns:
If successful: HTTP 200
Return Payload:
{
"status": "ok",
"results": [
{
"workspace_id": "GUID_OF_WORKSPACE",
"workspace_name": "NAME_OF_WORKSPACE",
"workspace_description": "DESCRIPTION_OF_WORKSPACE",
"num_docs": NUM_DOCS_IN_WORKSPACE,
"creation_datetime": "DATETIME_OF_WORKSPACE_CREATION"
}
]
}Code Sample:
from hyperia import Hyperia
import sys
hyperia = Hyperia()
result = hyperia.workspace_list()
if not response:
sys.exit(-1)
for workspace in result['results']:
print(workspace)List Public Workspaces
Lists accessible public Workspaces. Does not include "non-public" Hyperia content repository Workspaces. Please use the List Workspaces endpoint for accessing information on accessible non-public workspaces.
Endpoint:
/v1/workspace/public/list
HTTP Method:
GET
Parameters:
None
Returns:
If successful: HTTP 200
Return Payload:
{
"status": "ok",
"results": [
{
"workspace_id": "GUID_OF_WORKSPACE",
"workspace_name": "NAME_OF_WORKSPACE",
"workspace_description": "DESCRIPTION_OF_WORKSPACE",
"num_docs": NUM_DOCS_IN_WORKSPACE,
"creation_datetime": "DATETIME_OF_WORKSPACE_CREATION"
}
]
}Code Sample:
from hyperia import Hyperia
import sys
hyperia = Hyperia()
result = hyperia.workspace_public_list()
if not response:
sys.exit(-1)
for workspace in result['results']:
print(workspace)