OpenViSTAI · Agents · Blockchain · Crypto
Menu
RAG & Knowledge Systems

Graphrag API

Graphrag API is a Python FastAPI server that provides HTTP endpoints for global, local, DRIFT and basic text-unit search over an existing Microsoft GraphRAG project.

Independent OpenViST project profile, based on linked sources.

Graphrag API — OpenViST project profile in RAG & Knowledge Systems.
OpenViST project illustration. See the linked sources for product details.
Understand the project

Practical overview

When it fits

Use it when a prepared GraphRAG project needs an HTTP search interface that can be queried by the GraphRAG Visualizer or another compatible client.

Who it is for

  • Developers integrating GraphRAG search into a custom client.
  • Users connecting the GraphRAG Visualizer to a GraphRAG project.
  • Teams that already have a prepared GraphRAG project and want to expose its search modes through an API.

Documented uses

  • Expose global, local, DRIFT and basic text-unit search over project data.
  • Connect a GraphRAG Visualizer or custom client to a GraphRAG search server.
Before you choose

Requirements & limits

The repository is public and MIT-licensed. The README documents local setup and server access.

  • Requires an existing GraphRAG project directory containing output, prompts, settings.yaml and .env.
  • Requires Python dependency installation and configuration of PROJECT_DIRECTORY.
  • The documented search routes are /search/global, /search/local, /search/drift and /search/basic.

Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.

Source-based practical guide

Set up the API around an existing GraphRAG project

Install the server, point it at a prepared GraphRAG project and start the API.

Before you start

  • Python environment
  • GraphRAG project directory containing output, prompts, settings.yaml and .env

Steps

  1. Clone the repository and enter its directory.

  2. Create and activate a Python virtual environment, then install dependencies from requirements.txt.

  3. Place the GraphRAG project directory in the repository root and set PROJECT_DIRECTORY to its folder name in config.py.

  4. Start the server with python api.py and open the local /docs/ address to view API documentation.

Expected outcome

The API server starts with its documentation available locally, ready for queries from a compatible client.

Guide limitations

  • The guide documents setup and server start, but does not specify client configuration or provide example query payloads.
Evidence and transparency

Sources & review

Source record details
Source availability
Active
Sources checked
13 October 2026
Original website title
noworneverev/graphrag-api · Official homepage title · retained in its source language