Get GraphRAG statistics

GET

vault

{id}

graphrag

stats

{
  "entities": 1247,
  "relationships": 3521,
  "communities": 89,
  "documents": 156,
  "lastProcessed": "2024-01-15T10:30:00Z",
  "status": "completed"
}

Authorizations

Authorization

string

header

required

API key starting with sk_case_

Path Parameters

string

required

The unique identifier of the vault

Response

GraphRAG statistics retrieved successfully

entities

integer

Total number of entities extracted from documents

relationships

integer

Total number of relationships between entities

communities

integer

Number of entity communities identified

documents

integer

Number of processed documents

lastProcessed

string<date-time>

Timestamp of last GraphRAG processing

status

enum<string>

Current processing status

Available options:

processing,

completed,

error

Ingest vault objectTriggers ingestion workflow for a vault object to extract text, generate chunks, and create embeddings. For supported file types (PDF, DOCX, PPTX, XLSX, TXT, RTF, XML, HTML, Markdown, CSV/TSV, JSON/YAML/TOML, common source code files, ZIP, audio, video), processing happens asynchronously. ZIP archives are unpacked recursively up to 5 levels, and each extracted file is created as an independent vault object and ingested via the normal pipeline. For unsupported types (images, etc.), the file is marked as completed immediately without text extraction. GraphRAG indexing must be triggered separately via POST /vault/:id/graphrag/:objectId.

⌘I

{
  "entities": 1247,
  "relationships": 3521,
  "communities": 89,
  "documents": 156,
  "lastProcessed": "2024-01-15T10:30:00Z",
  "status": "completed"
}