> ## 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.
# Per-server RAG ingestion load
> Returns per-server RAG ingestion throughput, keyed on the persisted ingestion.processedBy attribution (hostname:pid). Two DocumentDB-safe $group aggregations over the uploads collection (running uploads, plus done/error within the last hour) are merged with the serverInstance roster for host liveness + worker CPU. Backs the System -> RAG Jobs 'Servers' card (IngestionServersCard). Mirrors GET /api/admin/kag/servers. Super-admin only.
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json get /api/admin/ingestion/servers
openapi: 3.0.0
info:
title: Pria Admin 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: Admin Memory
description: Admin inspection and editing of user/instance memory parameters.
- name: Admin Usage Limits
description: Per-user usage-vs-cap reporting and account-wide at-limit counts.
paths:
/api/admin/ingestion/servers:
get:
tags:
- Admin Ingestion
summary: Per-server RAG ingestion load
description: >-
Returns per-server RAG ingestion throughput, keyed on the persisted
ingestion.processedBy attribution (hostname:pid). Two DocumentDB-safe
$group aggregations over the uploads collection (running uploads, plus
done/error within the last hour) are merged with the serverInstance
roster for host liveness + worker CPU. Backs the System -> RAG Jobs
'Servers' card (IngestionServersCard). Mirrors GET
/api/admin/kag/servers. Super-admin only.
responses:
'200':
description: Per-server ingestion load retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/IngestionServersResponse'
'401':
description: Unauthorized — missing or invalid authentication
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Authentication Required
'403':
description: Forbidden — the authenticated user is not a super-admin
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Super admin only.
'500':
description: Server error while computing the per-server rollup
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Ingestion servers failed
security:
- apiKeyAuth: []
components:
schemas:
IngestionServersResponse:
type: object
properties:
success:
type: boolean
example: true
servers:
type: array
items:
$ref: '#/components/schemas/IngestionServerRow'
generatedAt:
type: string
format: date-time
description: Server-side timestamp the rollup was computed.
IngestionServerRow:
type: object
description: >-
Per-server RAG ingestion load row. Keyed on ingestion.processedBy (the
persisted hostname:pid that last claimed the job), joined to the
serverInstance roster for liveness + CPU. Legacy uploads with a null
processedBy are skipped in the rollup.
properties:
server:
type: string
description: >-
Server identity (hostname:pid) that processed the job — the
persisted ingestion.processedBy value.
example: ip-10-0-1-42:1734
running:
type: integer
description: >-
Count of uploads this server currently owns in a non-terminal phase
(extract | chunk | sanitize | embed | finalize).
done:
type: integer
description: >-
Count of uploads this server completed (phase 'done') within the
recent window (last 1h).
error:
type: integer
description: >-
Count of uploads this server terminal-failed (phase 'error') within
the recent window (last 1h).
chunks:
type: integer
description: >-
Sum of ingestion.counts.total across this server's currently-running
uploads (total chunks in flight).
sanitized:
type: integer
description: >-
Sum of ingestion.counts.sanitized across this server's
currently-running uploads.
embedded:
type: integer
description: >-
Sum of ingestion.counts.embedded across this server's
currently-running uploads.
liveness:
type: string
enum:
- live
- stale
- dead
- unknown
description: >-
Host-level liveness rolled up from the serverInstance roster: 'live'
if any worker on the host has a fresh heartbeat, else 'stale', else
'dead'; 'unknown' when the host is absent from the roster.
cpuPct:
type: number
nullable: true
description: >-
Most recent CPU percent for the matching worker instance, or null
when the worker is not in the roster.
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````