> ## 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 the upgrade to create Digital Twins
> Where the signed-in account stands on the upgrade that lets a personal account create its own Digital Twins. An account that registered itself, belongs to no Digital Twin and has asked its personal Pria 5 questions can upgrade. `state` is `off` (the upgrade is not offered), `already` (the account can already create Digital Twins), `integration` (the account was created for a Digital Twin), `not-personal` (the account belongs to a Digital Twin), `revoked` (the upgrade was taken back), `progress` (fewer than 5 questions so far) or `eligible`.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json get /api/user/twin-upgrade
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-upgrade:
get:
tags:
- Institutions
summary: Check the upgrade to create Digital Twins
description: >
Where the signed-in account stands on the upgrade that lets a personal
account create its own Digital Twins. An account that registered itself,
belongs to no Digital Twin and has asked its personal Pria 5 questions
can upgrade. `state` is `off` (the upgrade is not offered), `already`
(the account can already create Digital Twins), `integration` (the
account was created for a Digital Twin), `not-personal` (the account
belongs to a Digital Twin), `revoked` (the upgrade was taken back),
`progress` (fewer than 5 questions so far) or `eligible`.
responses:
'200':
description: The account's state
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
state:
type: string
enum:
- 'off'
- already
- integration
- not-personal
- revoked
- progress
- eligible
dialogues:
type: integer
nullable: true
description: >-
Questions answered so far, counted up to 5 (progress and
eligible only)
required:
type: integer
example: 5
cap:
type: integer
example: 3
description: The Digital Twins an upgraded account can create
twinsCreated:
type: integer
nullable: true
description: The Digital Twins created since the upgrade
'401':
description: The signed-in account no longer exists
'500':
description: The account could not be checked; try again later
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.