> ## 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.
# Create a new assistant
> Creates a new AI assistant with the specified configuration. The request body is passed directly to the Mongoose model constructor. Only the name field is required by the schema (other fields have defaults). If institution is an empty string it is removed from the body. Auto-reset logic is applied before saving. If institution_shared is true but no institution is provided, institution_shared is reset to false. If account_shared is true but institution_shared is not true, account_shared is reset to false. Duplicate assistants (same name + user + institution) are caught as a 400 error by the unique index constraint, not as a 409.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json post /api/user/assistant
openapi: 3.0.0
info:
title: Pria Runtime 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: Audio Notes
description: Capture and ingest spoken notes into the personal vault
- name: Memory
description: User-facing memory parameters (personal + shared instance memory).
- name: My Data
description: >-
GDPR controls — personal-scope counts, async ZIP-by-email export, and
scoped soft-delete. Every endpoint pins `user = req.user._id` AND
`institution: null`; institution-scoped data is governed by the
institution's own retention policy and never reached from here.
- name: Questions
description: >-
User-facing read of the onboarding question bank used by the "create a
digital twin" wizard.
- name: Transcription
description: >-
One-shot speech-to-text for in-place dictation. Audio blob in, transcript
out — no Upload / History / RAG embeddings are persisted. Use
`/audio-notes` for anything durable.
paths:
/api/user/assistant:
post:
tags:
- Assistants
summary: Create a new assistant
description: >
Creates a new AI assistant with the specified configuration. The request
body is passed directly to the Mongoose model constructor. Only the name
field is required by the schema (other fields have defaults). If
institution is an empty string it is removed from the body. Auto-reset
logic is applied before saving. If institution_shared is true but no
institution is provided, institution_shared is reset to false. If
account_shared is true but institution_shared is not true,
account_shared is reset to false. Duplicate assistants (same name + user
+ institution) are caught as a 400 error by the unique index constraint,
not as a 409.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
type: string
description: >-
Name of the assistant (required, must be unique per
user+institution)
example: New Assistant 1
status:
type: string
enum:
- active
- unpublished
- inactive
- deleted
description: Status of the assistant
default: active
example: active
description:
type: string
description: Description of the assistant
default: ''
example: New Assistant Description
instructions:
type: string
description: Behavioral instructions for the assistant
default: ''
example: New Assistant Instructions
argument_1:
type: string
nullable: true
description: Optional argument 1
argument_2:
type: string
nullable: true
description: Optional argument 2
argument_3:
type: string
nullable: true
description: Optional argument 3
argument_4:
type: string
nullable: true
description: Optional argument 4
argument_5:
type: string
nullable: true
description: Optional argument 5
picture_url:
type: string
description: URL for the assistant's profile picture
example: https://example.com/image.jpeg
admin_only:
type: boolean
description: Whether the assistant is restricted to admin users
default: false
example: true
remember_history:
type: integer
description: Number of conversation history items to remember
default: 3
example: 3
editable_others:
type: boolean
description: Whether the assistant can be edited by other users
default: false
example: true
user:
type: string
description: User ObjectId who owns this assistant
example: 6430d02554cd4e00403e8b05
institution:
type: string
description: Institution ObjectId. If empty string, field is removed.
example: 6631915765bb0a94cfd6ca99
institution_shared:
type: boolean
description: >-
Whether shared with the institution. Auto-reset to false if
no institution provided.
default: false
example: true
account_shared:
type: boolean
description: >-
Whether shared across the account. Auto-reset to false if
institution_shared is not true.
default: false
example: false
ragEnabled:
type: boolean
description: Whether RAG is enabled for this assistant
default: true
bypassSystemContext:
type: boolean
description: Whether to bypass the system context prompt
default: false
conversationModel:
type: string
description: Optional model override for this assistant (max 200 chars)
stsConversationModel:
type: string
description: >-
Optional STS/voice conversation model; used only in
ElevenLabs/Anam voice mode (max 200 chars)
responses:
'201':
description: Assistant successfully created
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
id:
type: string
description: ObjectId of the created assistant
example: 687e761093c797174459c651
message:
type: string
example: Assistant created!
'400':
description: >-
Bad request - empty body, invalid properties, or duplicate name
(unique index violation)
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
error:
type: object
description: The raw error object
message:
type: string
example: Error creating assistant
'401':
description: Unauthorized - user not found
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Authentication Required
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````