Jump to Content

v1.0

API Reference

v1.0API Reference

All

Pages

Start typing to search…

Overview

LiteGraph Overview

Deployment

Running Server from Source
Running Server from Docker

REST API Overview

Basics
Authentication
Error Responses
Best Practices

User Authentication

Retrieve Tenants for an Email Address
Generate Authentication Token
Read Token Details

Tenants

Overview
Create Tenant
Read and Enumerate Tenants
Update Tenant
Delete Tenant
Check Tenant Existence

Users

Overview
Create User
Read and Enumerate Users
Update User
Delete User
Check User Existence

Credentials

Overview
Create Credential
Read and Enumerate Credentials
Update Credential
Delete Credential
Check Credential Existence
Read Credential By BearerToken
Delete All Credentials In Tenant
Delete Credential By User

Graph

Overview
Create Graph
Read and Enumerate Graphs
Delete Graph
Vector Search
Check Graph Existence
Export Graph
Vector Index Management
Exist
Sub Graph

Nodes

Overview
Create Node
Read and Enumerate Nodes
Update Node
Delete Node
Search Nodes
Check Node Existence

Edges

Overview
Create Edge
Read and Enumerate Edges
Update Edge
Delete Edge
Vector Search
Check Edge Existence
Read All Edge In Tenant
Read All Edge In Graph
Delete All Edge In Tenant
Delete Node Edges (Single)
Delete Node Edges (Bulk)

Routes & Traversal

Get Routes
Get Edges From Node
Get Edges To Node
Get Edges Between Nodes
Get Node Edges
Get Node Neighbors
Get Node Parents
Get Node Children

Labels

Overview
Create Label
Read and Enumerate Labels
Update Label
Delete Label
Check Label Existence

Tags

Overview
Create Tag
Read and Enumerate Tags
Update Tag
Delete Tag
Check Tag Existence

Vectors

Overview
Create Vector
Read and Enumerate Vectors
Update Vector
Delete Vector
Check Vector Existence

Administration

Backup and Restore
In-Memory Operation

Powered by

Running Server from Docker

This guide explains how to run LiteGraph Server using Docker containers.