> ## Documentation Index
> Fetch the complete documentation index at: https://docs.praxis-ai.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve filtered list of assistants
> Fetches a list of AI assistants based on specified filters, with optional minimal data return
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json post /api/admin/assistants
openapi: 3.0.0
info:
title: Pria Admin API
version: 2.0.1
description: >-
Pria API Documentation Praxis's developer platform is a core part of our
mission to empower organizations to grow better. Our APIs are designed to
enable teams of any shape or size to build robust integrations that help
them customize and get the most value out of Pria. All Pria APIs are built
using REST conventions and designed to have a predictable URL structure.
They use many standard HTTP features, including methods (POST,
GET, PUT, DELETE) and error response codes.
All API calls are
made under https://hiimpria.ai/api and all responses return standard JSON.
In these docs, you'll find lists of all available endpoints for a given API,
along with interactive code blocks for building requests. For walkthroughs
of basic usage for these APIs, check out the API guides.
servers:
- url: https://pria.praxislxp.com
description: Pria API Server
security: []
tags:
- name: Authentication
description: User authentication, registration, and password management (/api/auth)
- name: OAuth
description: OAuth authentication providers - Google, GitHub, SSO (/api/auth/oauth)
- name: User
description: User profile management and account operations (/api/user)
- name: User Institutions
description: User institution memberships and switching (/api/user/institution)
- name: User Tools
description: Available tools for authenticated users (/api/user/tools)
- name: Institutions
description: Institution settings and configuration (/api/user/institution)
- name: Conversation
description: AI conversation and Q&A endpoints (/api/ai)
- name: Realtime
description: Real-time voice AI and WebRTC sessions (/api/ai/rt)
- name: Assistant
description: AI assistant configuration and management (/api/user/assistant)
- name: History
description: Conversation history and favorites (/api/user/history)
- name: RAG
description: >-
Document upload, embedding, and retrieval-augmented generation
(/api/user/files, /api/user/rag)
- name: Setting
description: Instance variables and settings management (/api/user/setting)
- name: Branding
description: Digital twin branding and customization (/api/agent/branding)
- name: Agent
description: Agent engagement and session management (/api/agent)
- name: SDK Launch
description: >-
SDK launch token signing and verification for secure iframe embedding
(/api/auth/sdk-sign, /api/auth/sdk-verify)
- name: Testing
description: Health checks, diagnostics, and test endpoints (/api/test)
- name: Admin Accounts
description: Account management for super admins (/api/admin/account)
- name: Admin Institutions
description: Institution management for admins (/api/admin/institution)
- name: Admin Users
description: User management for admins (/api/admin/user)
- name: Admin Entitlements
description: >-
User-institution relationships and permissions
(/api/admin/userInstitution)
- name: Admin Sessions
description: Session management for admins (/api/admin/session)
- name: Admin Histories
description: Conversation history management and analytics (/api/admin/history)
- name: Admin Assistants
description: AI assistant management for admins (/api/admin/assistant)
- name: Admin Questions
description: Institution question and prompt management (/api/admin/question)
- name: Admin Tools
description: Tool configuration management (/api/admin/tool)
- name: Admin AI Models
description: AI model configuration (/api/admin/aimodel)
- name: Admin MCP Servers
description: Model Context Protocol server management (/api/admin/mcpserver)
- name: Admin Feedbacks
description: User feedback management (/api/admin/feedback)
- name: Admin Uploads
description: Upload management (/api/admin/upload)
- name: Admin Charts
description: Analytics and visualization chart management (/api/admin/chart)
- name: Admin Memory
description: Admin inspection and editing of user/instance memory parameters.
- name: Admin Usage Limits
description: Per-user usage-vs-cap reporting and account-wide at-limit counts.
paths:
/api/admin/assistants:
post:
tags:
- Admin Assistants
summary: Retrieve filtered list of assistants
description: >-
Fetches a list of AI assistants based on specified filters, with
optional minimal data return
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssistantFilterRequest'
example:
minimum: true
institution: 665653e9f7e4f4f1b5c6ef1b
responses:
'200':
description: Successfully retrieved assistants list
content:
application/json:
schema:
$ref: '#/components/schemas/AssistantListResponse'
'401':
description: Unauthorized - Invalid or missing access token
'403':
description: Forbidden - Insufficient permissions for admin endpoint
'500':
description: Internal server error
security:
- apiKeyAuth: []
components:
schemas:
AssistantFilterRequest:
type: object
properties:
minimum:
type: boolean
description: Whether to return minimal assistant data
institution:
type: string
description: Institution ID to filter assistants by
account:
type: string
description: Account ID(s) to filter assistants (space-separated for multiple)
usersearch:
type: string
description: Search term for users (matches email, first name, last name)
admin_only:
type: boolean
description: Filter for admin-only assistants
system_only:
type: boolean
description: Filter for system assistants (no owner)
page:
type: integer
minimum: 1
default: 1
description: Page number (1-based)
pageSize:
type: integer
minimum: 1
maximum: 5000
default: 100
description: Number of results per page
limitsearch:
type: integer
description: Alias for pageSize (deprecated, use pageSize)
AssistantListResponse:
type: object
properties:
success:
type: boolean
description: Indicates if the request was successful
data:
type: array
items:
$ref: '#/components/schemas/AssistantResponse'
description: Array of assistant objects
total:
type: integer
description: Total number of matching assistants
hasMore:
type: boolean
description: Whether more results are available
page:
type: integer
description: Current page number
pageSize:
type: integer
description: Number of results per page
message:
type: string
description: Response message
AssistantResponse:
type: object
properties:
_id:
type: string
description: Unique identifier for the assistant
name:
type: string
description: Name of the assistant
description:
type: string
description: Detailed description of the assistant's capabilities
instructions:
type: string
description: Detailed instructions for the assistant's behavior
picture_url:
type: string
description: URL path to the assistant's profile picture
status:
type: string
enum:
- active
- inactive
description: Current status of the assistant
liked_count:
type: integer
description: Number of likes the assistant has received
admin_only:
type: boolean
description: Whether the assistant is restricted to admin users only
institution_shared:
type: boolean
description: Whether the assistant is shared across institutions
remember_history:
type: integer
description: Number of conversation history items to remember
created:
type: string
format: date-time
description: Creation timestamp
argument_1:
type: string
nullable: true
description: Optional argument parameter
argument_5:
type: string
nullable: true
description: Optional argument parameter
editable_others:
type: boolean
description: Whether others can edit this assistant
ragCollections:
type: array
items:
type: string
description: >-
Array of Collection ObjectIds to restrict RAG retrieval scope. Empty
array means all collections (default behavior).
assistantToolMode:
type: string
enum:
- all
- whitelist
default: all
description: >-
Tool access mode — 'all' uses all institution tools (default),
'whitelist' restricts to tools listed in assistantTools.
assistantTools:
type: array
description: >-
Per-assistant tool configuration. Only used when assistantToolMode
is 'whitelist'.
items:
type: object
properties:
tool:
type: string
description: Tool ObjectId reference
instructionsOverride:
type: string
description: >-
Optional override for the tool's instructions field for this
assistant
history_count:
type: integer
description: Number of conversation histories for this assistant
user_data:
type: object
nullable: true
description: Resolved user information
properties:
email:
type: string
fname:
type: string
lname:
type: string
institution:
type: string
accountType:
type: string
institution_data:
type: object
nullable: true
description: Resolved institution information
properties:
name:
type: string
ainame:
type: string
status:
type: string
picture:
type: string
account_data:
type: object
nullable: true
description: Resolved account information
properties:
name:
type: string
status:
type: string
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````