> ## 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.
# Retrieve settings for the current institution
> Fetches settings scoped to the authenticated user's institution, with institution and user metadata. Results are sorted by key ascending and limited to 100 records. Requires the user to belong to an institution.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json post /api/user/settings
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/settings:
post:
tags:
- Setting
summary: Retrieve settings for the current institution
description: >-
Fetches settings scoped to the authenticated user's institution, with
institution and user metadata. Results are sorted by key ascending and
limited to 100 records. Requires the user to belong to an institution.
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: >-
Filter by status. When omitted, excludes settings with
status 'deleted'.
enum:
- active
- inactive
- deleted
example: active
key:
type: string
description: Filter by exact key name
example: variable-2
responses:
'200':
description: Successfully retrieved settings
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: array
items:
$ref: '#/components/schemas/UserSetting'
'400':
description: Bad request - general error
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Error getting setting
'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 - user does not belong to an institution
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: This functionality is reserved to instance users
security:
- apiKeyAuth: []
components:
schemas:
UserSetting:
type: object
properties:
_id:
type: string
description: Setting unique identifier
example: 687e6ee393c79717445848de
key:
type: string
description: Setting key name
example: variable-2
value:
type: string
description: Setting value
example: variable value
institution:
type: string
description: Institution ID this setting belongs to
example: 6631915765bb0a94cfd6ca99
user:
type: string
description: User ID this setting belongs to
example: 6430d02554cd4e00403e8b05
status:
type: string
enum:
- active
- inactive
description: Setting status
example: active
admin_only:
type: boolean
description: Whether setting is admin-only
example: true
institution_shared:
type: boolean
description: Whether setting is shared across institution
example: true
editable_others:
type: boolean
description: Whether setting can be edited by others
example: true
created:
type: string
format: date-time
description: Setting creation timestamp
institution_data:
$ref: '#/components/schemas/InstitutionData'
user_data:
$ref: '#/components/schemas/UserData'
index:
type: integer
description: Position index assigned during retrieval, starting at 1
example: 1
InstitutionData:
type: object
properties:
_id:
type: string
description: Institution unique identifier
example: 6631915765bb0a94cfd6ca99
name:
type: string
description: Institution domain name
example: scarlet.hugo.praxis-ai.instructure.com
ainame:
type: string
description: AI assistant name for the institution
example: Scarlet
UserData:
type: object
properties:
_id:
type: string
description: User unique identifier
example: 6430d02554cd4e00403e8b05
email:
type: string
format: email
description: User email address
example: hugo.lebegue@gmail.com
fname:
type: string
description: User first name
example: Hugo
lname:
type: string
description: User last name
example: Lebegue
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````