Skip to main content
PUT
/
api
/
admin
/
institution
/
{institutionId}
Update an institution configuration
curl --request PUT \
  --url https://pria.praxislxp.com/api/admin/institution/{institutionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "28615560.marcodivittorio.utoronto-dev.instructure.com",
  "account": "66cffaa6b359c109fb06d839",
  "status": "inactive",
  "credits": 50,
  "publicId": "c98291e9-12e7-4304-b47b-ab18b0968a02",
  "publicAuthorizedUrls": [
    "https://utoronto-dev.instructure.com",
    "https://canvas.instructure.com"
  ],
  "picture": "<string>",
  "picture_bg": "<string>",
  "picture_animated": "<string>",
  "ainame": "Pria",
  "prompt": "What can I do for you?",
  "contactEmail": "marco.divittorio@utoronto.ca",
  "creditAward": 0,
  "poolCredits": true,
  "kmeanScore": 0.45,
  "disableFileUploadForUser": false,
  "disableAssistantsForUser": false,
  "ltiContextIds": [
    "<string>"
  ],
  "personalisationAsked": false,
  "kalturaIsAdminSecret": false,
  "kalturaUserId": "<string>",
  "entitleNewAdmins": false,
  "locationEnabled": true,
  "enableModeration": false,
  "ragLimitChunks": 2,
  "maxFiles": 300,
  "alwaysCiteSources": true,
  "canvasAPIScope": [
    "<string>"
  ],
  "rtEnabled": false,
  "rtAdminOnly": true,
  "displayAgentDetails": true,
  "rtVoice": "<string>",
  "maxCompletionTokens": -1,
  "allowJoining": "disabled",
  "joiningAdminOnly": false,
  "questionType": "INSTITUTION"
}'
{
  "success": true,
  "message": "Instance updated!"
}

Authorizations

​
Authorization
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:
[
  "https://utoronto-dev.instructure.com",
  "https://canvas.instructure.com"
]
​
picture
string

Institution picture URL

​
picture_bg
string

Background picture URL

​
picture_animated
string

Animated picture URL

​
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

K-means clustering score

Example:

0.45

​
disableFileUploadForUser
boolean

Disable file upload for users

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

​
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 agent details

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>

Question type classification

Available options:
INSTITUTION,
CORPORATE

Response

Institution successfully updated

​
success
boolean
Example:

true

​
message
string
Example:

"Instance updated!"