> ## 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.
# Private files an HTML page points to
> For an HTML page in the vault, lists the pictures, videos, sounds, fonts and style sheets the page points to that are still private, so they will not show to someone who opens the page. Files the caller may not change are left out. A confidential file, and a file of another type (a document, a script), is listed under `kept` with the reason: it is never made public this way. Nothing is changed by this request.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json get /api/user/upload/{id}/page-media
openapi: 3.0.0
info:
title: Pria Runtime API
version: 2.0.343
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.
A
session that a course page (Canvas) opened for an administrator — or that a
Digital Twin's sign-in provider opened for one of its people — starts with
user rights in that twin only: until the person confirms it's them with a
code (POST /api/user/launch-scope/challenge, then /api/auth/mfa-resend and
/api/auth/mfa-verify), every route outside that twin's day-to-day work
answers 403 with code LAUNCH_SCOPE_STEP_UP and the twin's id.
servers:
- url: https://hiimpria.ai
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 account managers (/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/upload/{id}/page-media:
get:
tags:
- IP Vault
summary: Private files an HTML page points to
description: >-
For an HTML page in the vault, lists the pictures, videos, sounds, fonts
and style sheets the page points to that are still private, so they will
not show to someone who opens the page. Files the caller may not change
are left out. A confidential file, and a file of another type (a
document, a script), is listed under `kept` with the reason: it is never
made public this way. Nothing is changed by this request.
parameters:
- in: path
name: id
required: true
schema:
type: string
description: The id of the page's file
responses:
'200':
description: What the page points to
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
page:
type: boolean
description: >-
False when the file is not an HTML page; the lists are
then empty.
public:
type: boolean
description: >-
Whether the page itself is public. When it is not, the
POST below is refused.
files:
type: array
description: Private files that can be made public with the page.
items:
type: object
properties:
_id:
type: string
name:
type: string
kept:
type: array
description: Files that stay private.
items:
type: object
properties:
name:
type: string
reason:
type: string
enum:
- confidential
- not_media
notChecked:
type: boolean
description: >-
True when some of the files the page points to could not
be checked (the page points to more than 200 files, a file
has too many records, or a lookup did not finish in time).
Those files are left as they are.
tooLarge:
type: boolean
description: >-
True when the page is larger than 1,000,000 bytes and was
not read.
'400':
description: The id is malformed
'401':
description: Authentication required
'403':
description: The caller may not change this page
'404':
description: No such file, or it is in the Trash
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.