{
"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>",
"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"
}
]
}{
"success": false,
"error": {},
"message": "Error getting assistants <details>"
}{
"success": false,
"message": "Authentication Required"
}Search and retrieve assistants
Retrieves a filtered list of assistants based on type, name, and the requesting user’s permissions. Results include system assistants (user=null), the user’s own assistants, institution-shared assistants, and account-shared assistants from sibling institutions. Assistants with status “deleted” are always excluded. Unpublished assistants from other users are excluded. Non-shared assistants from other users are excluded for regular users. Assistants disabled by the user’s institution are excluded. For non-super users viewing system assistants, the instructions field is omitted. Fields argument_1 through argument_4 are always stripped from each result. Response includes denormalized user_data, institution_data, and account_data objects for display purposes.
{
"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>",
"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"
}
]
}{
"success": false,
"error": {},
"message": "Error getting assistants <details>"
}{
"success": false,
"message": "Authentication Required"
}Authorizations
JWT token passed in x-access-token header
Body
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.
admin, user, instance, account Regex search filter applied to both name and description fields (case-insensitive)
Maximum number of assistants to return per query
When true, omits the instructions field from all results
When true and the requesting user is admin/super, filters to admin-only assistants. Regular users always have admin_only assistants excluded automatically.
Was this page helpful?