> ## 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 realtime AI session
> Creates a new realtime AI session for voice/WebRTC communication.
Provider, model, and voice are resolved server-side from the user's
institution `rtModel` setting (OpenAI / Google Gemini Live / xAI /
ElevenLabs). Returns either an ephemeral WebRTC key
(OpenAI / Gemini / xAI) or a signed-agent configuration (ElevenLabs).
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json post /api/ai/rtProxy/rtSession
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/ai/rtProxy/rtSession:
post:
tags:
- Realtime
summary: Create realtime AI session
description: |
Creates a new realtime AI session for voice/WebRTC communication.
Provider, model, and voice are resolved server-side from the user's
institution `rtModel` setting (OpenAI / Google Gemini Live / xAI /
ElevenLabs). Returns either an ephemeral WebRTC key
(OpenAI / Gemini / xAI) or a signed-agent configuration (ElevenLabs).
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RTSessionRequest'
responses:
'200':
description: Realtime session created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/RTSessionResponse'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Realtime not enabled for this institution
security:
- apiKeyAuth: []
components:
schemas:
RTSessionRequest:
type: object
description: |
Provider, model, and voice are NOT accepted from the request — they
are resolved server-side from the user's `institution.rtModel`
setting. The client only needs to send `requestArgs` carrying the
realtime context (assistant, course, user clock) so the server can
build the right system prompt. An optional top-level `token` is
accepted as an alternative to the `Authorization` /
`x-access-token` headers for browser clients that cannot set
custom headers.
properties:
token:
type: string
description: >-
Optional auth JWT — alternative to `Authorization` /
`x-access-token` headers.
requestArgs:
type: object
description: >-
Realtime context bag merged into the user object before context
build.
properties:
assistantId:
type: string
description: ObjectId of the active assistant; influences the system prompt.
selectedCourse:
type: object
description: >-
Currently selected conversation/course (course_id, course_name,
assistant, etc.).
userISODate:
type: string
format: date-time
description: >-
Client clock at request time (drives "now" in the system
prompt).
userTimezone:
type: string
description: IANA timezone (e.g. `America/New_York`).
socketId:
type: string
description: Optional Socket.IO id for streaming side-channel events.
RTSessionResponse:
oneOf:
- type: object
description: OpenAI/Gemini/xAI realtime session response
properties:
provider:
type: string
sessionId:
type: string
description: Realtime session identifier
ephemeralKey:
type: string
description: Ephemeral key for WebRTC connection
model:
type: string
description: AI model being used
- type: object
description: Anam Pria-direct Custom LLM (CUSTOMER_CLIENT_V1) session response
properties:
provider:
type: string
example: anam_pria_custom_llm
adapterMode:
type: string
example: anam-client-custom-llm
llmId:
type: string
example: CUSTOMER_CLIENT_V1
anam_session_token:
type: string
description: Short-lived Anam session token (browser-safe; no API key)
anam_avatar_id:
type: string
image_url:
type: string
loading_video_url:
type: string
intro_message:
type: string
capabilities:
type: object
audio_metadata:
type: object
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````