Skip to main content
POST
/
api
/
user
/
assistants
curl --request POST \
  --url https://pria.praxislxp.com/api/user/assistants \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '{}'
{
  "success": true,
  "data": [
    {
      "_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "instructions": "<string>",
      "picture_url": "<string>",
      "status": "active",
      "liked_count": 123,
      "admin_only": true,
      "institution_shared": true,
      "account_shared": true,
      "editable_others": true,
      "remember_history": 123,
      "ragEnabled": true,
      "bypassSystemContext": true,
      "conversationModel": "<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

Body

application/json
​
type
enum<string>

Type filter for assistants. "admin" returns system assistants (user=null, institution=null). "user" returns the requesting user's own non-shared assistants. "instance" returns institution-shared but not account-shared assistants. "account" returns assistants shared across the entire account. When omitted, returns all visible assistants using an $or query across categories.

Available options:
admin,
user,
instance,
account
​
name
string

Regex search filter applied to both name and description fields (case-insensitive)

​
limit
integer
default:100

Maximum number of assistants to return per query

​
lean
boolean
default:false

When true, omits the instructions field from all results

​
admin_only
boolean

When true and the requesting user is admin/super, filters to admin-only assistants. Regular users always have admin_only assistants excluded automatically.

Response

Successfully retrieved assistants list

​
success
boolean
Example:

true

​
data
(object | null)[]

Assistant associated with the course. Null if the assistant was deleted or not found.