Skip to main content
Version: 2025-02-27
API docs by Redocly

VKG API Reference

Download OpenAPI specification:Download

VKG API Reference

All VKG Management

Management for all the VKGs

Get All VKG Overview

Provides an overview of all the VKGs in the system. Filters that can be applied on metadata during search or to limit nodes on a certain VKG. Multiple filters can be applied at once (E.g. 'One of' + 'More Than'). Supported filters are in the metadata filter section of the documentation.

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Responses

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "vkgs": {
    }
}

Delete All VKGs

Delete all existing VKGs.

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Responses

Export All VKGs

Export all the VKGs into CSVs as a ZIP file.

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Request Body schema: application/json
filename
string
Default: "[ISO Datetime]_export.csv"
includeTsne
boolean
Default: false
includeMetadata
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "filename": "export",
  • "include_tsne": false,
  • "include_metadata": false
}

Duplicate VKG

Duplicate a VKG from another, preserving the nodes and metadata schema.

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Request Body schema: application/json
fromVkg
required
string (VKG ID)

VKG's ID.

toVkg
required
string (VKG ID)

VKG's ID.

Responses

Request samples

Content type
application/json
{
  • "fromVkg": "UMAPtest",
  • "toVkg": "copy"
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "fromVkg": "string",
  • "toVkg": "string",
  • "expected": 0,
  • "added": 0,
  • "nodesAdded": [
    ]
}

Single VKG Management

Management for a specific VKG

Create VKG

Create a single VKG and instantiate optional metadata.

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Request Body schema: application/json
vkgId
required
string (VKG ID)

VKG's ID.

object (Metadata Config)

Configuration for the metadata schema.

Responses

Request samples

Content type
application/json
{
  • "vkgId": "numbers",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "created": true,
  • "vkgId": "string",
  • "metadata": {
    }
}

Get VKG Overview

Provides an overview of the specified VKG.

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Responses

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "vkgId": "string",
  • "statistics": {
    }
}

Edit VKG

Edit a VKG's name and/or it's metadata schema.

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Request Body schema: application/json

Provides two functionalities:

  1. Renaming the VKG (When given newVkgId)
  2. Updating the VKG's metadata (When given metadata)

When given both newVkgId and metadata, both functions will be run

newVkgId
string (VKG ID)

VKG's ID.

object (Metadata Config)

Configuration for the metadata schema.

Responses

Request samples

Content type
application/json
{
  • "newVkgId": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "vkgId": {
    },
  • "metadata": [
    ]
}

Delete VKG

Delete a single VKG.

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Responses

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "expected": 0,
  • "deleted": 0
}

Search VKG

Perform a search on the VKG. To read about the supported filters for metadataFilters, refer to the Searching the VKG: metadataFilters page.

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Request Body schema: application/json

Note: Setting the numClosest parameter too high can result in unwanted results. They may be dissimilar, yet still are within the numClosest nodes (E.g. A VKG with 5 nodes with numClosest set to 5 nodes will retrieve them all)

queries
Array of strings

Queries to search on.

numClosest
integer

Number of nodes to retrieve.

object

Filter where METADATA_NAME is the name of the metadata field to filter on

Responses

Request samples

Content type
application/json
{
  • "queries": [
    ],
  • "numClosest": 0,
  • "metadataFilter": {
    }
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "vkgId": "string",
  • "queryResults": [
    ],
  • "numClosest": 0
}

Compute TSNE

Compute the TSNE of the VKG. TSNE is the metric used to visualize nodes as a graph. Each node's TSNE needs to be calculated in order to create a visualization.

query Parameters
return_tsne
boolean
Default: false

Whether or not to return the TSNE values

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Responses

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "vkgId": "string",
  • "tsne": {
    }
}

Export VKG

Export the VKG into a CSV.

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Request Body schema: application/json
filename
string
includeTsne
boolean
includeMetadata
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "includeTsne": true,
  • "includeMetadata": true
}

Nodes

Management for a specific VKG's nodes

Get Nodes

Retrieve all nodes.

query Parameters
do_tsne
boolean

Perform TSNE (Essentially runs /compute as well)

include_stats
boolean

Include the VKG's statistics

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Responses

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "vkgId": "string",
  • "nodes": {
    },
  • "calculateTsne": true,
  • "includeMetadata": true,
  • "statistics": {
    }
}

Delete All Nodes

Delete all nodes in the VKG.

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Responses

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "expected": 0,
  • "deleted": 0
}

Delete Specific Nodes

Delete Nodes in batch by specific node IDs.

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Request Body schema: application/json
nodes
Array of strings

Array of node IDs

Responses

Request samples

Content type
application/json
{
  • "nodes": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "expected": 0,
  • "deleted": 0
}

Add Nodes via Body

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Request Body schema: application/json
Array of objects (Node Data)
Array
text
required
string

Node's text contents.

object

Key-value pairs of the metadata items.

Responses

Request samples

Content type
application/json
{
  • "nodes": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "vkgId": "string",
  • "expected": 0,
  • "added": 0,
  • "nodesAdded": [
    ]
}

Edit Nodes via Body

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Request Body schema: application/json
object
additional property
object (Node Data)
text
required
string

Node's text contents.

object

Key-value pairs of the metadata items.

Responses

Request samples

Content type
application/json
{
  • "nodes": {
    }
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "expected": 0,
  • "modified": 0,
  • "modifiedNodes": {
    }
}

Add Nodes via Files

For documentation on file formatting, refer to Formatting.

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Request Body schema: multipart/form-data
file
object (File)

File as a CSV or JSON.

Responses

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "vkgId": "string",
  • "expected": 0,
  • "added": 0,
  • "nodesAdded": [
    ]
}

Edit Nodes via Files

For documentation on file formatting, refer to Formatting.

header Parameters
orgId
required
string

Organization Identifier

authKey
required
string

Organization Authorization Key

userId
required
string

User Identifier

Request Body schema: multipart/form-data
file
object (File)

File as a CSV or JSON.

Responses

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { },
  • "expected": 0,
  • "modified": 0,
  • "modifiedNodes": {
    }
}

Status Check

Endpoint to check that the server and all dependencies are healthy.

Responses

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "errors": { }
}