> ## 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.
# Stop making a presentation video
> Stops your video while it is being made: the voice-over stops before its next scene, and a presenter recording that has not started yet never starts. Nothing is refunded and nothing new is charged — what was already made is still charged, and a presenter recording that has already started finishes and is charged. A video stopped before it could be previewed ends as `failed` with `failureCode` `STOPPED`; one that could already be previewed stays previewable without a presenter. Only your own video; asking again answers the same. The chat answer that was making the video ends too: it stops at once and its answer is "Video stopped." with the video's card. To reach that answer quickly, send the answer's `turn_id` (the video's `buildTurnKey`) and, when you have it, its `execution_id` from `GET /api/ai/personal/subagent/active`. Both are optional and are checked: a `turn_id` that is not this video's answer is ignored. Without them the answer is still ended, at its next step.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json post /api/user/presentations/{id}/cancel
openapi: 3.0.0
info:
title: Pria Runtime API
version: 2.0.236
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://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/presentations/{id}/cancel:
post:
tags:
- Presentations
summary: Stop making a presentation video
description: >
Stops your video while it is being made: the voice-over stops before its
next scene, and a presenter recording that has not started yet never
starts. Nothing is refunded and nothing new is charged — what was
already made is still charged, and a presenter recording that has
already started finishes and is charged. A video stopped before it could
be previewed ends as `failed` with `failureCode` `STOPPED`; one that
could already be previewed stays previewable without a presenter. Only
your own video; asking again answers the same. The chat answer that was
making the video ends too: it stops at once and its answer is "Video
stopped." with the video's card. To reach that answer quickly, send the
answer's `turn_id` (the video's `buildTurnKey`) and, when you have it,
its `execution_id` from `GET /api/ai/personal/subagent/active`. Both are
optional and are checked: a `turn_id` that is not this video's answer is
ignored. Without them the answer is still ended, at its next step.
parameters:
- in: path
name: id
required: true
schema:
type: string
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
turn_id:
type: string
example: 1760000000000-ab12
description: >-
The answer that is making the video: the video's
buildTurnKey
execution_id:
type: string
pattern: ^[0-9a-f]{32}$
description: >-
That answer's execution_id as GET
/api/ai/personal/subagent/active shows it
responses:
'200':
description: Stopped (now or before)
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
stopped:
type: boolean
example: true
status:
type: string
enum:
- building
- previewable
- failed
example: failed
stopReason:
type: string
enum:
- STOP
- CANCEL
example: CANCEL
stoppedAt:
type: string
format: date-time
'401':
description: Not signed in
'404':
description: No such video of yours (code NOT_FOUND)
'409':
description: >-
Nothing left to stop (code NOT_STOPPABLE). reason: RECORDING_STARTED
= its presenter recording has started (it finishes and is charged);
FINISHED = the video finished before the stop; FAILED = the video
failed
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
code:
type: string
example: NOT_STOPPABLE
reason:
type: string
enum:
- RECORDING_STARTED
- FINISHED
- FAILED
example: RECORDING_STARTED
'500':
description: The stop could not be recorded (code CANCEL_FAILED)
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.