> ## 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.
# Check status of the middleware application
> Returns the current health status of the service including uptime, memory usage, and dependency status
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json get /api/test/health
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/test/health:
get:
tags:
- Testing
summary: Check status of the middleware application
description: >-
Returns the current health status of the service including uptime,
memory usage, and dependency status
responses:
'200':
description: Service is healthy and operational
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
example:
status: ok
uptime: 112.368138
timestamp: 1750534150795
summary: >-
Event loop lag: 12ms | RSS: 280MB | heap: 158MB/170MB | mongo:
connected
eventLoopLag:
meanMs: 1.2
p50Ms: 0.4
p95Ms: 6.1
p99Ms: 15
maxMs: 42
mongo:
state: 1
label: connected
memory:
rss: 128008192
heapTotal: 72105984
heapUsed: 67442352
external: 23693540
arrayBuffers: 19882176
limitBytes: 17179869184
rssRatio: 0.0075
dependencies:
database: 1
components:
schemas:
HealthResponse:
type: object
properties:
status:
type: string
description: Overall health status
example: ok
uptime:
type: number
description: Server uptime in seconds
timestamp:
type: number
description: Current timestamp in milliseconds
summary:
type: string
description: Human-readable one-line digest matching the heartbeat log format
example: >-
Event loop lag: 1.9s | RSS: 1.7GB | heap: 506MB/1.1GB | mongo:
connected
eventLoopLag:
$ref: '#/components/schemas/EventLoopLag'
mongo:
$ref: '#/components/schemas/MongoInfo'
memory:
$ref: '#/components/schemas/MemoryInfo'
dependencies:
$ref: '#/components/schemas/Dependencies'
EventLoopLag:
type: object
nullable: true
description: >-
Event loop lag percentiles in ms over the current sampling window. Null
until the monitor's histogram has data.
properties:
meanMs:
type: number
description: Mean event loop lag (ms)
p50Ms:
type: number
description: P50 event loop lag (ms)
p95Ms:
type: number
description: P95 event loop lag (ms)
p99Ms:
type: number
description: P99 event loop lag (ms)
maxMs:
type: number
description: Max event loop lag (ms) since last reset
MongoInfo:
type: object
properties:
state:
type: number
description: 0=disconnected, 1=connected, 2=connecting, 3=disconnecting
label:
type: string
example: connected
MemoryInfo:
type: object
properties:
rss:
type: number
description: Resident Set Size - total memory allocated for the process
heapTotal:
type: number
description: Total heap memory allocated
heapUsed:
type: number
description: Heap memory currently in use
external:
type: number
description: Memory used by C++ objects bound to JavaScript objects
arrayBuffers:
type: number
description: Memory allocated for ArrayBuffers and SharedArrayBuffers
Dependencies:
type: object
properties:
database:
type: number
description: Database connection status (1 = connected)
````