Skip to main content
PUT
/
api
/
user
/
assistant
/
{id}
Update an existing assistant
curl --request PUT \
  --url https://pria.praxislxp.com/api/user/assistant/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "name": "New Assistant Updated",
  "status": "active",
  "description": "New Assistant Description",
  "instructions": "New Assistant Instructions",
  "argument_1": "<string>",
  "argument_2": "<string>",
  "argument_3": "<string>",
  "argument_4": "<string>",
  "argument_5": "<string>",
  "picture_url": "<string>",
  "admin_only": true,
  "remember_history": 123,
  "editable_others": true,
  "user": "6430d02554cd4e00403e8b05",
  "institution": "6631915765bb0a94cfd6ca99",
  "institution_shared": true,
  "account_shared": true,
  "ragEnabled": true,
  "bypassSystemContext": true,
  "conversationModel": "<string>"
}
'
{
  "success": true,
  "message": "Assistant updated!"
}

Authorizations

​
x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

​
id
string
required

The ObjectId of the assistant to update

Body

application/json

Any valid assistant fields. No required fields for update. Empty strings for user/institution trigger $unset.

​
name
string

Name of the assistant

Example:

"New Assistant Updated"

​
status
enum<string>

Status of the assistant

Available options:
active,
unpublished,
inactive,
deleted
Example:

"active"

​
description
string

Description of the assistant

Example:

"New Assistant Description"

​
instructions
string

Instructions for the assistant

Example:

"New Assistant Instructions"

​
argument_1
string | null
​
argument_2
string | null
​
argument_3
string | null
​
argument_4
string | null
​
argument_5
string | null
​
picture_url
string

URL for the assistant's profile picture

​
admin_only
boolean

Whether the assistant is admin-only

​
remember_history
integer

Number of conversation history items to remember

​
editable_others
boolean

Whether the assistant can be edited by others

​
user
string

User ObjectId. Empty string triggers $unset to remove the field.

Example:

"6430d02554cd4e00403e8b05"

​
institution
string

Institution ObjectId. Empty string triggers $unset to remove the field.

Example:

"6631915765bb0a94cfd6ca99"

​
institution_shared
boolean

Whether shared with the institution

​
account_shared
boolean

Whether shared across the account. Auto-reset to false if institution_shared is not true.

​
ragEnabled
boolean

Whether RAG is enabled

​
bypassSystemContext
boolean

Whether to bypass the system context prompt

​
conversationModel
string

Optional model override (max 200 chars)

Response

Assistant successfully updated

​
success
boolean
Example:

true

​
message
string
Example:

"Assistant updated!"