Retrieve filtered list of assistants

Fetches a list of AI assistants based on specified filters, with optional minimal data return

POST /api/admin/assistants

Retrieve filtered list of assistants

cURL

curl --request POST \
  --url https://pria.praxislxp.com/api/admin/assistants \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "minimum": true,
  "institution": "665653e9f7e4f4f1b5c6ef1b"
}
'

200

{
  "success": true,
  "data": [
    {
      "_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "instructions": "<string>",
      "picture_url": "<string>",
      "liked_count": 123,
      "admin_only": true,
      "institution_shared": true,
      "remember_history": 123,
      "created": "2023-11-07T05:31:56Z",
      "argument_1": "<string>",
      "argument_5": "<string>",
      "editable_others": true,
      "ragCollections": [
        "<string>"
      ],
      "assistantToolMode": "all",
      "assistantTools": [
        {
          "tool": "<string>",
          "instructionsOverride": "<string>"
        }
      ],
      "history_count": 123,
      "user_data": {
        "email": "<string>",
        "fname": "<string>",
        "lname": "<string>",
        "institution": "<string>",
        "accountType": "<string>"
      },
      "institution_data": {
        "name": "<string>",
        "ainame": "<string>",
        "status": "<string>",
        "picture": "<string>"
      },
      "account_data": {
        "name": "<string>",
        "status": "<string>"
      }
    }
  ],
  "total": 123,
  "hasMore": true,
  "page": 123,
  "pageSize": 123,
  "message": "<string>"
}

Authorizations

x-access-token · string · header · required

JWT token passed in x-access-token header

Body

application/json

minimum · boolean

Whether to return minimal assistant data

institution · string

Institution ID to filter assistants by

account · string

Account ID(s) to filter assistants (space-separated for multiple)

usersearch · string

Search term for users (matches email, first name, last name)

admin_only · boolean

Filter for admin-only assistants

system_only · boolean

Filter for system assistants (no owner)

page · integer · default: 1

Page number (1-based)

Required range: x >= 1

pageSize · integer · default: 100

Number of results per page

Required range: 1 <= x <= 5000

limitsearch · integer

Alias for pageSize (deprecated, use pageSize)

Response

200

application/json

Successfully retrieved assistants list

success · boolean

Indicates if the request was successful

data · object[]

Array of assistant objects

Show child attributes

total · integer

Total number of matching assistants

hasMore · boolean

Whether more results are available

page · integer

Current page number

pageSize · integer

Number of results per page

message · string

Response message