Skip to main content
PUT
Update an institution configuration

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

institutionId
string
required

The institution ID

Body

application/json
name
string
required

Institution domain name

Example:

"28615560.marcodivittorio.utoronto-dev.instructure.com"

account
string
required

Account ID reference

Example:

"66cffaa6b359c109fb06d839"

status
enum<string>
required

Institution status

Available options:
active,
inactive
Example:

"inactive"

credits
integer
required

Number of credits allocated

Example:

50

publicId
string
required

Public UUID identifier

Example:

"c98291e9-12e7-4304-b47b-ab18b0968a02"

publicAuthorizedUrls
string[]

List of authorized URLs

Example:
picture
string

Institution picture URL

picture_bg
string

Background picture URL

picture_dark_bg
string

Dark mode background picture URL

picture_animated
string

Animated picture URL

elevenlabs_agent_id
string

ElevenLabs Conversational AI Agent ID for voice-enabled digital twin

Example:

"agent_0201kedjfdgee87bjke8acq3pcbg"

ainame
string

AI assistant name

Example:

"Pria"

prompt
string

Default AI prompt

Example:

"What can I do for you?"

contactEmail
string<email>

Contact email address

Example:

"marco.divittorio@utoronto.ca"

creditAward
integer

Credit award amount

Example:

0

poolCredits
boolean

Whether to pool credits

Example:

true

kmeanScore
number<float>

K-means clustering score

Example:

0.45

disableFileUploadForUser
boolean

Disable file upload for users

Example:

false

disableAudioNotesForUser
boolean

Disable Audio Notes capture (microphone icon in toolbar) for standard users in this institution. Admins are unaffected. Audio Notes is also hidden when guestUI or disableFileUploadForUser is on.

Example:

false

disableAssistantsForUser
boolean

Disable assistants for users

Example:

false

ltiContextIds
string[]

LTI context identifiers

personalisationAsked
boolean

Whether personalization was asked

Example:

false

kalturaIsAdminSecret
boolean

Kaltura admin secret flag

Example:

false

kalturaUserId
string

Kaltura user ID

entitleNewAdmins
boolean

Entitle new administrators

Example:

false

locationEnabled
boolean

Location services enabled

Example:

true

enableModeration
boolean

Content moderation enabled

Example:

false

ragLimitChunks
integer

RAG limit chunks

Example:

2

ragChunkChars
integer

Per-chunk character budget for RAG embedding/retrieval, shared by KAG extraction. Admin preset 2000/4000/6000 (~512/1024/1536 tokens). Falls back to the system default (4000) when unset.

Example:

4000

ragChunkOverlapRatio
number<float>

Chunk overlap as a fraction of ragChunkChars (bounded 0–0.5). Falls back to the system default (0.15) when unset.

Example:

0.15

kagFusionEnabled
boolean

When true, RAG fans out to dense + graph retrievers and fuses via Reciprocal Rank Fusion (KAG). Default false; opt-in per institution.

Example:

false

planScoringEnabled
boolean

Plan scoring tools switch. true declares direct-chat scoring tools and gates uploads from the conversation model. Mutually exclusive with subagents (enabling scoring atomically disables them); returns 409 if admitted subagent work has not drained. No plan session or workspace project is created for scoring. false is the default. Super admins only - stripped from other admins' updates.

Example:

false

twinWorkflowManagement
boolean

Twin workflows switch ("Twin workflows" in the editor). When true (the default), this Digital Twin's admins can ask it in web chat to create, change, run and schedule read-only workflows (the feature also needs the TWIN_WORKFLOW_TOOLS server flag). false removes the chat tools; workflows made earlier stay on the Workflows page and keep their schedules. Any admin with institutions.edit may set it (not super-only).

Example:

true

maxFiles
integer

Maximum number of files

Example:

300

alwaysCiteSources
boolean

Always cite sources

Example:

true

canvasAPIScope
string[]

Canvas API scope permissions

rtEnabled
boolean

Real-time features enabled

Example:

false

rtAdminOnly
boolean

Real-time admin only

Example:

true

displayAgentDetails
boolean

Display persisted tool details on saved History records

Example:

true

displayThinkingDetails
boolean

Display persisted model thinking/reasoning details on saved History records

Example:

true

displayRagSearchDetails
boolean

Display persisted RAG/KAG retrieval segments (file + relevance + chunk preview) on saved History records

Example:

true

displayMemoryDetails
boolean

Display the recalled memories (which long-term memories shaped the answer) in the "Memory" row on saved History records. Saved-memory receipts are always shown. Default true.

Example:

true

displayThinkingExecution
boolean

Display the live thinking trace while a response is streaming (independent of displayThinkingDetails)

Example:

true

displayToolExecution
boolean

Display live tool execution indicators while a response is streaming (independent of displayAgentDetails)

Example:

true

rtVoice
string

Real-time voice setting

maxCompletionTokens
integer

Maximum completion tokens (-1 for unlimited)

Example:

-1

allowJoining
enum<string>

Allow joining setting

Available options:
enabled,
disabled
Example:

"disabled"

joiningAdminOnly
boolean

Joining admin only

Example:

false

questionType
enum<string>

Onboarding question bank this institution uses (single live bank — "PERSONA"; legacy INSTITUTION/CORPORATE banks are retired)

Available options:
PERSONA
creditCaps
object

Per-institution user-quota configuration. Editable by admins with the institutions.edit entitlement when the account has not enabled caps; read-only (inherited) when the account owns caps.

Response

Institution successfully updated

success
boolean
Example:

true

id
string

ID of the updated institution

Example:

"67826dfe5d387207aabd6fc1"