> ## 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.
# Twin Home — a Digital Twin's week at a glance (twin admins)
> Activity (30 UTC days; this week vs last week), credits left and runway, satisfaction
(👍 vs 👎 over 30 days), needs-attention counts and the launch checklist.
- Requires `histories.list` on the twin (supers pass). The feedback count additionally
needs `feedbacks.list`; without it `attention.feedbackOpen` is `null`.
- Activity uses the daily rollup (the same source as the Histories charts) plus a live
count for the days the rollup has not reached (at most 3); `activity.stale` is true
when the rollup is further behind. Weekly people are distinct across the week.
- The first request for a twin starts a one-time background collection of its past
ratings and "couldn't answer" replies (last 90 days, newest 5,000 conversations);
`seeding` is true while it runs.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json get /api/user/twin-home/{institutionId}
openapi: 3.0.0
info:
title: Pria Runtime API
version: 2.0.199
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/twin-home/{institutionId}:
get:
tags:
- User
summary: Twin Home — a Digital Twin's week at a glance (twin admins)
description: >
Activity (30 UTC days; this week vs last week), credits left and runway,
satisfaction
(👍 vs 👎 over 30 days), needs-attention counts and the launch
checklist.
- Requires `histories.list` on the twin (supers pass). The feedback
count additionally
needs `feedbacks.list`; without it `attention.feedbackOpen` is `null`.
- Activity uses the daily rollup (the same source as the Histories
charts) plus a live
count for the days the rollup has not reached (at most 3); `activity.stale` is true
when the rollup is further behind. Weekly people are distinct across the week.
- The first request for a twin starts a one-time background collection
of its past
ratings and "couldn't answer" replies (last 90 days, newest 5,000 conversations);
`seeding` is true while it runs.
parameters:
- name: institutionId
in: path
required: true
schema:
type: string
pattern: ^[a-f0-9]{24}$
responses:
'200':
description: The Twin Home data.
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: object
properties:
twin:
type: object
properties:
_id:
type: string
name:
type: string
ainame:
type: string
example: RAI
picture:
type: string
status:
type: string
activity:
type: object
properties:
days:
type: array
items:
type: object
properties:
date:
type: string
example: '2026-09-28'
count:
type: integer
credits:
type: integer
people:
type: integer
thisWeek:
type: object
properties:
conversations:
type: integer
people:
type: integer
credits:
type: integer
lastWeek:
type: object
properties:
conversations:
type: integer
people:
type: integer
credits:
type: integer
stale:
type: boolean
credits:
type: object
properties:
pooled:
type: boolean
description: false = each person uses their own credits.
left:
type: integer
nullable: true
burnPerDay:
type: integer
description: Mean daily credits over the last 14 days.
runwayDays:
type: integer
nullable: true
low:
type: boolean
description: >-
No credits left, or under 14 days at the current
rate.
satisfaction:
type: object
properties:
up:
type: integer
down:
type: integer
windowDays:
type: integer
example: 30
attention:
type: object
properties:
reviewOpen:
type: integer
feedbackOpen:
type: integer
nullable: true
creditsLow:
type: boolean
checklist:
type: array
items:
type: object
properties:
id:
type: string
enum:
- identity
- instructions
- knowledge
- access
- share
label:
type: string
done:
type: boolean
section:
type: string
enum:
- identity
- persona
- knowledge
- access
- developer
description: The twin editor section to open.
seededAt:
type: string
format: date-time
nullable: true
seeding:
type: boolean
'400':
description: Invalid twin id.
'403':
description: No histories.list on this twin.
'404':
description: Twin not found.
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.