> ## 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.
# Get session by ID
> Retrieves a single session by Mongo ObjectId. user and institution are populated with trimmed projections.
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json get /api/admin/session/{id}
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/session/{id}:
get:
tags:
- Admin Sessions
summary: Get session by ID
description: >-
Retrieves a single session by Mongo ObjectId. user and institution are
populated with trimmed projections.
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Session ID (Mongo ObjectId)
responses:
'200':
description: Session retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/SessionResponse'
'400':
description: >-
Bad request — missing or malformed session id, or an unexpected
error was thrown
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Invalid Session Id
'401':
description: Unauthorized — the authenticated user was not found
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Authentication required
'404':
description: Session not found
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Session not found
security:
- apiKeyAuth: []
components:
schemas:
SessionResponse:
type: object
properties:
success:
type: boolean
message:
type: string
data:
$ref: '#/components/schemas/Session'
Session:
type: object
description: >-
Web session row tracked per (userInstitution, sessionId) tuple. Created
on first request from a browser/UA and updated on every authenticated
hit (lastUpdated bump). Soft-deleted (status:'deleted') by DELETE
/api/admin/session/{id}.
properties:
_id:
type: string
description: Session ID (Mongo ObjectId)
sessionId:
type: string
description: >-
Opaque per-browser session identifier (cookie-bound). Unique within
a userInstitution.
userInstitution:
type: string
description: >-
UserInstitution ID — the (user, institution) pair this session
belongs to
user:
oneOf:
- type: string
- type: object
description: >-
User ID. Populated on GET /api/admin/session/{id} with { email,
fname, lname, accountType, status }.
properties:
_id:
type: string
email:
type: string
format: email
fname:
type: string
lname:
type: string
accountType:
type: string
status:
type: string
userEmail:
type: string
format: email
description: Denormalized owner email for search
userFirst:
type: string
description: Denormalized owner first name for search
userLast:
type: string
description: Denormalized owner last name for search
institution:
oneOf:
- type: string
- type: object
description: >-
Institution ID. Populated on GET /api/admin/session/{id} with {
name, ainame, credits, poolCredits, status } and on POST
/api/admin/sessions with { name, poolCredits, status, ainame }.
properties:
_id:
type: string
name:
type: string
ainame:
type: string
credits:
type: number
poolCredits:
type: number
status:
type: string
status:
type: string
enum:
- active
- deleted
description: >-
Persisted session status. Defaults to 'active' on create; the DELETE
endpoint flips it to 'deleted' (soft delete tombstone). The schema's
free-form String type can theoretically hold other values (e.g.
'inactive', 'error') but no live code path writes them.
sourceIp:
type: string
description: Source IP captured when the session was created
ua:
type: string
description: >-
Raw User-Agent header (omitted from POST /api/admin/sessions list
responses via -ua projection)
browserName:
type: string
description: Parsed browser name (ua-parser-js)
browserVersion:
type: string
description: Parsed browser version
engineName:
type: string
description: Parsed browser engine name
engineVersion:
type: string
description: Parsed browser engine version
osName:
type: string
description: Parsed operating system name
osVersion:
type: string
description: Parsed operating system version
deviceModel:
type: string
description: Parsed device model
deviceType:
type: string
description: >-
Parsed device type (e.g. mobile, tablet) — undefined for desktop
browsers
deviceVendor:
type: string
description: Parsed device vendor
cpuArchitecture:
type: string
description: Parsed CPU architecture
created:
type: string
format: date-time
description: Session creation timestamp
lastUpdated:
type: string
format: date-time
description: >-
Most recent activity timestamp (refreshed on every authenticated
request)
lastKA:
type: string
format: date-time
description: >-
Last known-active timestamp lifted from the related userInstitution
document (only present on POST /api/admin/sessions list responses,
sourced via the userInstitution populate)
user_data:
type: object
description: >-
Trimmed owner block shaped on the POST /api/admin/sessions list
response (built from denormalized userEmail/userFirst/userLast + the
user ObjectId)
properties:
_id:
type: string
email:
type: string
format: email
fname:
type: string
lname:
type: string
institution_data:
type: object
description: >-
Trimmed institution block shaped on the POST /api/admin/sessions
list response
properties:
_id:
type: string
name:
type: string
ainame:
type: string
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````