Skip to main content
PUT
/
api
/
user
/
institution
Update institution settings
curl --request PUT \
  --url https://pria.praxislxp.com/api/user/institution \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "conversationModel": "<string>",
  "maxCompletionTokens": 123,
  "reasoningEffort": "<string>",
  "extendedContext": true,
  "about": "<string>",
  "personalisationAsked": true,
  "disableToolUseInstructions": true,
  "kmeanScore": 123,
  "ragLimitChunks": 123,
  "toolsDisabled": true,
  "enableModeration": true,
  "alwaysCiteSources": true,
  "toolResultsMaxChars": 100500,
  "rtEnabled": true,
  "rtAdminOnly": true,
  "rtTextInputEnabled": true,
  "rtModel": "<string>",
  "rtVoice": "<string>",
  "gemini_rt_voice": "<string>",
  "xai_rt_voice": "<string>",
  "rtTranscriptionLanguage": "<string>",
  "disableClipboardForUser": true,
  "locationEnabled": true,
  "guestUI": true
}
'
{
  "success": true,
  "message": "Institution updated!"
}

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.

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json

Any combination of authorized institution properties

conversationModel
string

Default conversation model for the institution

maxCompletionTokens
integer

Maximum completion tokens for AI responses

reasoningEffort
string

Reasoning effort level (none, low, medium, high, max)

extendedContext
boolean

Whether extended context is enabled

about
string

About text for the institution

personalisationAsked
boolean

Whether personalisation has been asked

disableToolUseInstructions
boolean

Whether to disable tool use instructions

kmeanScore
number

K-means score threshold for RAG

ragLimitChunks
integer

Maximum number of RAG chunks to retrieve

toolsDisabled
boolean

Whether tools are disabled for AI conversations

enableModeration
boolean

Route incoming prompts through the moderation model before they reach the main LLM

alwaysCiteSources
boolean

Add an explicit citation directive to the system prompt so the model footnotes RAG / web sources in its answers

toolResultsMaxChars
integer

Character cap for individual tool / scrape / vault results before they are trimmed and saved to the IP Vault. Default 60000.

Required range: 1000 <= x <= 200000
rtEnabled
boolean

Enable Convo / Speech-to-Speech (realtime voice) mode for this instance

rtAdminOnly
boolean

Restrict Convo mode to admin users only

rtTextInputEnabled
boolean

Allow text input alongside speech while in Convo mode

rtModel
string

System model id for Convo / Speech-to-Speech (provider auto-derived from the model id)

rtVoice
string

OpenAI Realtime voice (alloy, ash, ballad, coral, echo, sage, shimmer, verse, cedar, marin)

gemini_rt_voice
string

Gemini Live voice (Puck, Charon, Kore, etc.)

xai_rt_voice
string

xAI realtime voice (eve, ara, rex, sal, leo)

rtVADEagerness
enum<string>

OpenAI realtime voice-activity-detection eagerness

Available options:
low,
medium,
high
rtNoiseReduction
enum<string>

OpenAI realtime noise reduction profile

Available options:
,
near_field,
far_field
rtTranscriptionLanguage
string

ISO 639-1 language hint for OpenAI realtime transcription (blank = auto-detect)

disableClipboardForUser
boolean

Hide clipboard controls from non-admin users in this institution

locationEnabled
boolean

Allow this institution's users to opt-in to sharing browser geolocation with the assistant for location-aware answers. Defaults to true.

guestUI
boolean

Strip the UI down to a chat-only minimum surface for non-admin users

theme
enum<string>

Forced UI theme for all users in this institution. '' = user directed, 'dark' = force dark mode, 'light' = force light mode

Available options:
,
dark,
light

Response

Institution updated successfully

success
boolean
Example:

true

message
string
Example:

"Institution updated!"