Document Management
Overview
Hyperia stores and indexes analyzed meetings and uploaded media files in a searchable online index. Document management APIs are provided to manage upload recordings. This includes APIs to list documents in a workspace, check for document existence (useful for determining whether analysis of an uploaded file has completed), and deleting currently documents from the online index.
List Documents In Workspace
Lists documents in a Hyperia workspace. Optional search filters may be applied to restrict document list results (by date, document title, etc). NOTE: All filter parameters supported by Hyperia's Search APIs can be applied when performing the document list operation.
Endpoint:
/v1/workspace/<workspace_id>/doc/list
HTTP Method:
PUT
PUT Payload:
{} or a JSON payload containing search filter parameters.
URI Parameters:
| Name | Description |
|---|---|
| workspace_id | Workspace ID to list documents within |
Returns:
If successful: HTTP 200
Return Payload:
{
"results": [
{
"id": "GUID_OF_DOCUMENT",
"date": "YYYY-MM-DDTHH:MM:SS-ZZZZ"
"ingest_date": "YYYY-MM-DDTHH:MM:SS-ZZZZ",
"description": "DESCRIPTION_OF_DOCUMENT",
"title": "TITLE_OF_DOCUMENT",
"duration": DURATION_OF_DOCUMENT_IN_MILLISECONDS,
"tags": [
"LIST", "OF", "TRIGGERED", "TAGS", "IN", "DOCUMENT"
],
"labels": [
{
"label_id": "LABEL_ID",
"label_name": "LABEL_NAME",
"workspace_id": "WORKSPACE_ID"
}
],
"participants": [
{
"email": "EMAIL_ADDRESS_OF_SPEAKER_IF_KNOWN",
"id": "GUID_OF_SPEAKER",
"longestMonologue": DURATION_IN_SECONDS,
"name": "NAME_OF_SPEAKER",
"totalTalkTime": DURATION_IN_SECONDS,
"totalWordCount": TOTAL_NUMBER_OF_WORDS
}
]
}
]
}Code Sample:
from hyperia import Hyperia
import sys
workspace_id = "SOME_WORKSPACE_ID"
hyperia = Hyperia()
result = hyperia.workspace_doc_list(workspace_id)
if not response:
sys.exit(-1)
exists = result['exists']Check Document Exists
Checks to see if a document matching a particular doc ID exists within the specified Hyperia workspace.
Endpoint:
/v1/workspace/<workspace_id>/doc/id/<doc-id>/exists
HTTP Method:
GET
URI Parameters:
| Name | Description |
|---|---|
| workspace_id | Workspace ID within which to check for a document |
| doc_id | Document ID to check for |
Returns:
If successful: HTTP 200
Return Payload:
{
"status": "ok",
"exists": true | false
}Code Sample:
from hyperia import Hyperia
import sys
workspace_id = "SOME_WORKSPACE_ID"
doc_id = "SOME_DOC_ID"
hyperia = Hyperia()
result = hyperia.workspace_doc_exists(workspace_id, doc_id)
if not response:
sys.exit(-1)
exists = result['exists']Delete Document
Deletes a document from a Hyperia Workspace.
Endpoint:
/v1/workspace/<workspace_id>/doc/id/<doc-id>
HTTP Method:
DELETE
URI Parameters:
| Name | Description |
|---|---|
| workspace_id | Workspace ID to delete a document from |
| doc_id | Document ID to delete |
Returns:
If successful: HTTP 200
Return Payload:
{
"status": "ok"
}Code Sample:
from hyperia import Hyperia
import sys
workspace_id = "SOME_WORKSPACE_ID"
doc_id = "SOME_DOC_ID"
hyperia = Hyperia()
result = hyperia.workspace_doc_delete(workspace_id, doc_id)
if not response:
sys.exit(-1)
// SUCCESS