> ## 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.
# Start, reconcile, or release bounded RunPod warm-up demand
> Explicit demand only; this operation can allocate paid GPU capacity. Reuse the same demandId on reconciliation requests (approximately every ten seconds). Each demand has a fixed server-bounded deadline; polling does not extend it indefinitely. Readiness includes acquisition phase and deadline. A hostless job may transfer to another approved datacenter only after the exact owned warm-up job is safely cancelled. Existing initializing or ready hosts are reused. Ownership uncertainty blocks new launches. No speculative dual-datacenter warming or endpoint-wide queue purge is performed. Set release to true to detach only this caller's demand; it never terminates a serving worker or cancels another caller's inference. Client-supplied endpoint ids, job ids and deadlines are not acquisition authority.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json post /api/user/runpod/warm
openapi: 3.0.0
info:
title: Pria Runtime API
version: 2.0.148
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/runpod/warm:
post:
tags:
- User
summary: Start, reconcile, or release bounded RunPod warm-up demand
description: >
Explicit demand only; this operation can allocate paid GPU capacity.
Reuse the same demandId on reconciliation requests (approximately every
ten seconds). Each demand has a fixed server-bounded deadline; polling
does not extend it indefinitely. Readiness includes acquisition phase
and deadline. A hostless job may transfer to another approved datacenter
only after the exact owned warm-up job is safely cancelled. Existing
initializing or ready hosts are reused. Ownership uncertainty blocks new
launches. No speculative dual-datacenter warming or endpoint-wide queue
purge is performed. Set release to true to detach only this caller's
demand; it never terminates a serving worker or cancels another caller's
inference. Client-supplied endpoint ids, job ids and deadlines are not
acquisition authority.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- aimodelId
properties:
aimodelId:
type: string
institution:
type: string
description: Optional authorized institution override.
demandId:
type: string
description: >-
Opaque caller token, reused for reconciliation and release;
scoped by the server to the authenticated user.
release:
type: boolean
default: false
responses:
'200':
description: >-
success plus data containing model state and bounded acquisition
metadata; inspect acquisition phase/error, not HTTP success alone.
'400':
description: Invalid demand token/request or unavailable acquisition service.
'401':
description: Authentication required.
'403':
description: Requested institution is not authorized.
'404':
description: No active RunPod model in the authorized institution.
security:
- bearerAuth: []
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT token passed in authorization header
````