> ## 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.
# Mint a Deepgram streaming STT session
> Mints a short-lived Deepgram bearer token (`/v1/auth/grant`) plus the
WSS URL the browser should open. The long-lived account API key never
leaves the backend — the browser passes `access_token` via the WS
subprotocol and streams 16 kHz mono linear16 PCM directly to Deepgram.
The endpoint also resolves keyterm hints from `requestArgs`
(institution name/ainame are added automatically) so the streaming
STT is biased toward the conversation's terminology.
Dev fallback: when `DEEPGRAM_DEV_RAW_KEY=true`, the raw account key is
returned directly (visible in the browser) and `expires_in=0`. Never
enable that mode in production.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json post /api/ai/rtProxy/deepgram/sttSession
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/deepgram/sttSession:
post:
tags:
- Realtime
summary: Mint a Deepgram streaming STT session
description: |
Mints a short-lived Deepgram bearer token (`/v1/auth/grant`) plus the
WSS URL the browser should open. The long-lived account API key never
leaves the backend — the browser passes `access_token` via the WS
subprotocol and streams 16 kHz mono linear16 PCM directly to Deepgram.
The endpoint also resolves keyterm hints from `requestArgs`
(institution name/ainame are added automatically) so the streaming
STT is biased toward the conversation's terminology.
Dev fallback: when `DEEPGRAM_DEV_RAW_KEY=true`, the raw account key is
returned directly (visible in the browser) and `expires_in=0`. Never
enable that mode in production.
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/DeepgramSttSessionRequest'
responses:
'200':
description: STT session minted.
content:
application/json:
schema:
$ref: '#/components/schemas/DeepgramSttSessionResponse'
'400':
description: |
Token grant failed — bad request / missing creds / Deepgram
upstream error. The Deepgram error status code is propagated when
available (e.g. 401 from Deepgram becomes 401 here).
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
message:
type: string
'401':
description: Unauthorized — caller token missing/invalid or user not resolvable.
security:
- apiKeyAuth: []
components:
schemas:
DeepgramSttSessionRequest:
type: object
description: |
All fields optional. The endpoint only mines `requestArgs` for
keyterm hints — anything else is ignored.
properties:
requestArgs:
type: object
description: >-
Realtime context echoed from the client. Used to derive Deepgram
keyterm hints (assistant name, conversation title, explicit
`keyterms[]`).
properties:
selectedCourse:
type: object
properties:
course:
type: object
properties:
title:
type: string
description: Used as a keyterm boost.
assistant:
type: object
properties:
name:
type: string
description: Used as a keyterm boost.
assistantName:
type: string
description: >-
Explicit assistant name override (used when
`selectedCourse.assistant.name` is not set).
courseTitle:
type: string
description: Explicit course title override.
keyterms:
type: array
items:
type: string
description: >-
Additional keyterms merged with derived ones and the institution
name/ainame.
DeepgramSttSessionResponse:
type: object
properties:
provider:
type: string
enum:
- deepgram
access_token:
type: string
description: >-
Short-lived Deepgram bearer token. The browser passes this via the
WebSocket subprotocol when opening the WSS stream.
expires_in:
type: number
description: Token TTL in seconds. `0` in dev raw-key mode.
wss_url:
type: string
description: Deepgram listen WSS URL the client should connect to.
example: wss://api.deepgram.com/v1/listen
model:
type: string
description: Deepgram STT model in use (institution-tuned).
eot_threshold:
type: number
description: End-of-turn confidence threshold.
eot_timeout_ms:
type: number
description: End-of-turn timeout in ms.
eager_eot_threshold:
type: number
description: >-
Optional. Present only when speculative early-start is enabled (>0).
Lower confidence at which Flux emits EagerEndOfTurn/TurnResumed so
the client can start answering early.
local_vad:
type: object
description: >-
Client-side energy-VAD config for always-on fast barge-in (cut the
avatar on local speech onset instead of waiting for Deepgram
StartOfTurn). Always present on Anam sessions; client-only — does
not affect the WSS URL.
properties:
enabled:
type: boolean
threshold_db:
type: number
description: Onset RMS threshold in dBFS.
onset_ms:
type: number
description: Continuous above-threshold time to confirm onset.
hangover_ms:
type: number
description: Below-release time before re-arming.
hysteresis_db:
type: number
description: Release threshold is threshold_db minus this.
encoding:
type: string
enum:
- linear16
description: Fixed PCM encoding the client AudioWorklet emits.
sample_rate:
type: number
enum:
- 16000
description: Fixed sample rate (16 kHz mono int16).
keyterms:
type: array
items:
type: string
description: >-
Resolved keyterm list — institution name/ainame plus the
derived/explicit terms.
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````