> ## 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 a single assistant by ID
> Retrieves a single assistant by its ObjectId. Accessible to (a) the assistant owner, (b) admin users with the relevant entitlement on the assistant's institution, or (c) super users. Standard users who don't own the assistant get 403. The response includes populated user_data (email, fname, lname, institution, accountType), institution_data (name, ainame, status, picture), and account_data (name, status) objects. For non-super users viewing system assistants (user=null), the instructions field is omitted.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json get /api/user/assistant/{id}
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/assistant/{id}:
get:
tags:
- Assistants
summary: Get a single assistant by ID
description: >
Retrieves a single assistant by its ObjectId. Accessible to (a) the
assistant owner, (b) admin users with the relevant entitlement on the
assistant's institution, or (c) super users. Standard users who don't
own the assistant get 403. The response includes populated user_data
(email, fname, lname, institution, accountType), institution_data (name,
ainame, status, picture), and account_data (name, status) objects. For
non-super users viewing system assistants (user=null), the instructions
field is omitted.
parameters:
- in: path
name: id
required: true
schema:
type: string
description: The ObjectId of the assistant to retrieve
example: 687e761093c797174459c651
responses:
'200':
description: Successfully retrieved assistant
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
$ref: '#/components/schemas/Assistant'
'400':
description: Invalid assistant ID or server error
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: object
message:
type: string
example: Invalid Assistant Id
'401':
description: Unauthorized - user not found
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Authentication Required
'403':
description: >-
Forbidden - caller is not the owner and does not have admin/super
access for this assistant's institution
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Not authorized to view this assistant
'404':
description: Assistant not found
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Assistant not found
security:
- apiKeyAuth: []
components:
schemas:
Assistant:
type: object
properties:
_id:
type: string
description: Unique identifier for the assistant
name:
type: string
description: Name of the assistant
description:
type: string
description: Description of the assistant's functionality
instructions:
type: string
description: >-
Detailed instructions for the assistant. Omitted for non-super users
viewing system assistants (user=null), and omitted when lean=true.
picture_url:
type: string
description: URL to the assistant's picture
status:
type: string
enum:
- active
- unpublished
- inactive
- deleted
description: Current status of the assistant
liked_count:
type: integer
description: Number of likes for this assistant
admin_only:
type: boolean
description: Whether the assistant is restricted to admin users only
institution_shared:
type: boolean
description: Whether the assistant is shared with the institution
account_shared:
type: boolean
description: >-
Whether the assistant is shared across all institutions in the same
account. Requires institution_shared to be true.
editable_others:
type: boolean
description: Whether other users can edit this assistant
remember_history:
type: integer
description: Number of conversation history items to remember
ragEnabled:
type: boolean
description: Whether RAG (retrieval-augmented generation) is enabled
bypassSystemContext:
type: boolean
description: Whether to bypass the system context prompt
conversationModel:
type: string
description: Optional model override for this assistant (max 200 chars)
stsConversationModel:
type: string
description: >-
Optional STS/voice conversation model; used only in ElevenLabs/Anam
voice mode (max 200 chars)
argument_5:
type: string
nullable: true
description: >-
Optional argument field. Note: argument_1 through argument_4 are
stripped from list responses.
user:
type: string
description: User ObjectId who created the assistant. Null for system assistants.
nullable: true
institution:
type: string
description: Institution ObjectId this assistant belongs to
nullable: true
user_data:
$ref: '#/components/schemas/AssistantUserData'
institution_data:
$ref: '#/components/schemas/AssistantInstitutionData'
account_data:
$ref: '#/components/schemas/AssistantAccountData'
created:
type: string
format: date-time
description: Creation timestamp
nullable: true
description: >-
Most recently used assistant in this course. Mobile/web use this to
restore conversation context on the next turn. Null if the assistant was
deleted or not found.
AssistantUserData:
type: object
description: Denormalized user data populated from the user reference
properties:
email:
type: string
fname:
type: string
lname:
type: string
institution:
type: string
description: Institution ObjectId from the user record
accountType:
type: string
AssistantInstitutionData:
type: object
description: Denormalized institution data populated from the institution reference
properties:
name:
type: string
ainame:
type: string
status:
type: string
picture:
type: string
AssistantAccountData:
type: object
description: >-
Denormalized account data resolved from the institution's account
reference
properties:
_id:
type: string
name:
type: string
status:
type: string
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````