Skip to main content
GET
/
api
/
user
/
assistant
/
{id}
Get a single assistant by ID
curl --request GET \
  --url https://pria.praxislxp.com/api/user/assistant/{id} \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "data": {
    "_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "instructions": "<string>",
    "picture_url": "<string>",
    "liked_count": 123,
    "admin_only": true,
    "institution_shared": true,
    "account_shared": true,
    "editable_others": true,
    "remember_history": 123,
    "ragEnabled": true,
    "bypassSystemContext": true,
    "conversationModel": "<string>",
    "stsConversationModel": "<string>",
    "argument_5": "<string>",
    "user": "<string>",
    "institution": "<string>",
    "user_data": {
      "email": "<string>",
      "fname": "<string>",
      "lname": "<string>",
      "institution": "<string>",
      "accountType": "<string>"
    },
    "institution_data": {
      "name": "<string>",
      "ainame": "<string>",
      "status": "<string>",
      "picture": "<string>"
    },
    "account_data": {
      "_id": "<string>",
      "name": "<string>",
      "status": "<string>"
    },
    "created": "2023-11-07T05:31:56Z"
  }
}

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 retrieve

Response

Successfully retrieved assistant

​
success
boolean
Example:

true

​
data
object

Most recently used assistant in this course. Mobile/web use this to restore conversation context on the next turn. Null if the assistant was deleted or not found.