> ## Documentation Index
> Fetch the complete documentation index at: https://docs.praxis-ai.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get KAG (knowledge graph) summary for a file
> Returns the latest knowledge_graph_job for the upload at the current
`graph-v2` extractionVersion: status, entities/relationships extracted,
segments processed, attempt count, and the latest error (if any).
Lazy-loaded by the File Preview > Knowledge Graph (KAG) sidebar
section so the lean upload list doesn't have to ship this for every
row. The endpoint is read-only and per-upload — ownership is enforced
by the existing vault scope on the upload list (callers can only
request summaries for uploads they can see).
Soft-200 with `{ notReady: true }` when the embeddings Atlas
connection is still opening — same convention as the embeddings
endpoint. Returns `{ exists: false }` when no KAG job has been
enqueued yet (e.g. file still in chunk/sanitize before KAG
enqueues).
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json get /api/user/files/{uploadId}/kag-summary
openapi: 3.0.0
info:
title: Pria Runtime API
version: 2.0.1
description: >-
Pria API Documentation Praxis's developer platform is a core part of our
mission to empower organizations to grow better. Our APIs are designed to
enable teams of any shape or size to build robust integrations that help
them customize and get the most value out of Pria. All Pria APIs are built
using REST conventions and designed to have a predictable URL structure.
They use many standard HTTP features, including methods (POST,
GET, PUT, DELETE) and error response codes.
All API calls are
made under https://hiimpria.ai/api and all responses return standard JSON.
In these docs, you'll find lists of all available endpoints for a given API,
along with interactive code blocks for building requests. For walkthroughs
of basic usage for these APIs, check out the API guides.
servers:
- url: https://pria.praxislxp.com
description: Pria API Server
security: []
tags:
- name: Authentication
description: User authentication, registration, and password management (/api/auth)
- name: OAuth
description: OAuth authentication providers - Google, GitHub, SSO (/api/auth/oauth)
- name: User
description: User profile management and account operations (/api/user)
- name: User Institutions
description: User institution memberships and switching (/api/user/institution)
- name: User Tools
description: Available tools for authenticated users (/api/user/tools)
- name: Institutions
description: Institution settings and configuration (/api/user/institution)
- name: Conversation
description: AI conversation and Q&A endpoints (/api/ai)
- name: Realtime
description: Real-time voice AI and WebRTC sessions (/api/ai/rt)
- name: Assistant
description: AI assistant configuration and management (/api/user/assistant)
- name: History
description: Conversation history and favorites (/api/user/history)
- name: RAG
description: >-
Document upload, embedding, and retrieval-augmented generation
(/api/user/files, /api/user/rag)
- name: Setting
description: Instance variables and settings management (/api/user/setting)
- name: Branding
description: Digital twin branding and customization (/api/agent/branding)
- name: Agent
description: Agent engagement and session management (/api/agent)
- name: SDK Launch
description: >-
SDK launch token signing and verification for secure iframe embedding
(/api/auth/sdk-sign, /api/auth/sdk-verify)
- name: Testing
description: Health checks, diagnostics, and test endpoints (/api/test)
- name: Admin Accounts
description: Account management for super admins (/api/admin/account)
- name: Admin Institutions
description: Institution management for admins (/api/admin/institution)
- name: Admin Users
description: User management for admins (/api/admin/user)
- name: Admin Entitlements
description: >-
User-institution relationships and permissions
(/api/admin/userInstitution)
- name: Admin Sessions
description: Session management for admins (/api/admin/session)
- name: Admin Histories
description: Conversation history management and analytics (/api/admin/history)
- name: Admin Assistants
description: AI assistant management for admins (/api/admin/assistant)
- name: Admin Questions
description: Institution question and prompt management (/api/admin/question)
- name: Admin Tools
description: Tool configuration management (/api/admin/tool)
- name: Admin AI Models
description: AI model configuration (/api/admin/aimodel)
- name: Admin MCP Servers
description: Model Context Protocol server management (/api/admin/mcpserver)
- name: Admin Feedbacks
description: User feedback management (/api/admin/feedback)
- name: Admin Uploads
description: Upload management (/api/admin/upload)
- name: Admin Charts
description: Analytics and visualization chart management (/api/admin/chart)
- name: Audio Notes
description: Capture and ingest spoken notes into the personal vault
- name: Memory
description: User-facing memory parameters (personal + shared instance memory).
- name: My Data
description: >-
GDPR controls — personal-scope counts, async ZIP-by-email export, and
scoped soft-delete. Every endpoint pins `user = req.user._id` AND
`institution: null`; institution-scoped data is governed by the
institution's own retention policy and never reached from here.
- name: Questions
description: >-
User-facing read of the onboarding question bank used by the "create a
digital twin" wizard.
- name: Transcription
description: >-
One-shot speech-to-text for in-place dictation. Audio blob in, transcript
out — no Upload / History / RAG embeddings are persisted. Use
`/audio-notes` for anything durable.
paths:
/api/user/files/{uploadId}/kag-summary:
get:
tags:
- IP Vault
summary: Get KAG (knowledge graph) summary for a file
description: |
Returns the latest knowledge_graph_job for the upload at the current
`graph-v2` extractionVersion: status, entities/relationships extracted,
segments processed, attempt count, and the latest error (if any).
Lazy-loaded by the File Preview > Knowledge Graph (KAG) sidebar
section so the lean upload list doesn't have to ship this for every
row. The endpoint is read-only and per-upload — ownership is enforced
by the existing vault scope on the upload list (callers can only
request summaries for uploads they can see).
Soft-200 with `{ notReady: true }` when the embeddings Atlas
connection is still opening — same convention as the embeddings
endpoint. Returns `{ exists: false }` when no KAG job has been
enqueued yet (e.g. file still in chunk/sanitize before KAG
enqueues).
parameters:
- in: path
name: uploadId
required: true
schema:
type: string
description: The upload ID
example: 6a145d0d269fc0a663eea267
responses:
'200':
description: KAG summary (may be `{exists:false}` or `{notReady:true}`)
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
exists:
type: boolean
description: false when no knowledge_graph_job has been enqueued yet
notReady:
type: boolean
description: >-
true when the embeddings DB connection is still opening;
client should re-poll
job:
type: object
description: Only present when exists=true
properties:
status:
type: string
enum:
- queued
- running
- done
- error
- skipped
progress:
type: object
properties:
percent:
type: number
message:
type: string
updatedAt:
type: string
format: date-time
chunksProcessed:
type: integer
example: 1
entitiesExtracted:
type: integer
example: 5
relationshipsExtracted:
type: integer
example: 4
recordsSeen:
type: integer
recordsValid:
type: integer
recordsInvalid:
type: integer
attempts:
type: integer
error:
type: string
description: >-
Latest error message (empty string when status !=
error)
nextAttemptAt:
type: string
format: date-time
nullable: true
created:
type: string
format: date-time
description: >-
Insertion timestamp — when kagEnqueue created the job
doc
updated:
type: string
format: date-time
description: >-
Last write timestamp. For status='done' jobs this is
effectively the completion stamp (no dedicated
completedAt on the schema).
startedAt:
type: string
format: date-time
nullable: true
description: >-
First-lease timestamp. Set ONCE by kagJobLease on the
queued→running transition (via $ifNull so re-leases
preserve it). Distinct from `created` (job insertion)
and `updated` (last write). Null on legacy rows that
predate the field.
llmProvider:
type: string
description: >-
Catalog group / routing target the job was dispatched
through (e.g. 'openrouter', 'inferx'). Stamped by
kagInlineProcessor at resolve time so re-runs after a
runtime config change show which provider each lease
used. Empty string for legacy rows.
example: openrouter
tokensIn:
type: integer
description: >-
Total prompt tokens spent by the graph extractor
across all chunks/subchunks/sliding-window batches.
Summed via writeJobProgress.
example: 1433
tokensOut:
type: integer
description: >-
Total completion tokens emitted by the extractor
across all chunks. Summed via writeJobProgress.
example: 571
'400':
description: Invalid upload ID
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- apiKeyAuth: []
components:
schemas:
ErrorResponse:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
description: Human-readable error message
error:
type: string
description: Technical error details
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````