> ## 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.

# Whether this Digital Twin can make presentation videos

> Whether presentation videos are available to you in your current Digital Twin (the feature is switched on for the platform and for this twin). `exportAvailable`: MP4 export is set up too (export task image, internal callback address and media bucket configured). `shareAudiences`: who a new share link may be for in this twin right now (`public` = anyone with the link, `twin` = people in this Digital Twin) — empty when share links are off for the platform or the twin's admins allow none; `shareAvailable` is false exactly then. `startAvailable`: you can start a new video from the chat in this session — videos are available, the twin runs multi-step answers (subagents), and you are signed in to the app as yourself (not through an API key, an agent or a consent link, not as a visitor of the twin's public page, and not in a Canvas launch as a student), and you have confirmed your sign-in with a code if the app asked you for one. `startEstimate`: about how many credits one 1-minute video costs you, as a range (`low`–`high`, about 10–15: writing the script, the voice-over and the presenter); present only with `startAvailable` and when it can be worked out. `startEstimateCredits`: the high end of that range, as one number. `cancelAvailable`: a video you are making can be stopped (`POST /api/user/presentations/{id}/cancel`). `startCostIncluded`: your plan includes videos (you are not charged for them), so no estimate is sent. `lengths`: only when videos can be made in more than one length (for example 1 and 3 minutes): each length with its label, its estimate (`null` when your plan includes videos or it cannot be worked out) and `affordable` (your credits — or the Digital Twin's, when it pays — cover what that length needs to start; a 3-minute video needs the high end of its range). To make a video of another length, send the chosen `seconds` as `requestArgs.presentationSeconds` (60 or 180) with the chat message (`POST /api/ai/personal/qanda`); without it the video is 1 minute. The server checks the length again and refuses one that is not available (nothing is started or charged).




## OpenAPI

````yaml /mdx/api-reference/runtime/runtime-api.json get /api/user/presentations/availability
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.
    <br/>  <br/>They use many standard HTTP features, including methods (POST,
    GET, PUT, DELETE) and error response codes.  <br/> <br/>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. <br/> <br/>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/availability:
    get:
      tags:
        - Presentations
      summary: Whether this Digital Twin can make presentation videos
      description: >
        Whether presentation videos are available to you in your current Digital
        Twin (the feature is switched on for the platform and for this twin).
        `exportAvailable`: MP4 export is set up too (export task image, internal
        callback address and media bucket configured). `shareAudiences`: who a
        new share link may be for in this twin right now (`public` = anyone with
        the link, `twin` = people in this Digital Twin) — empty when share links
        are off for the platform or the twin's admins allow none;
        `shareAvailable` is false exactly then. `startAvailable`: you can start
        a new video from the chat in this session — videos are available, the
        twin runs multi-step answers (subagents), and you are signed in to the
        app as yourself (not through an API key, an agent or a consent link, not
        as a visitor of the twin's public page, and not in a Canvas launch as a
        student), and you have confirmed your sign-in with a code if the app
        asked you for one. `startEstimate`: about how many credits one 1-minute
        video costs you, as a range (`low`–`high`, about 10–15: writing the
        script, the voice-over and the presenter); present only with
        `startAvailable` and when it can be worked out. `startEstimateCredits`:
        the high end of that range, as one number. `cancelAvailable`: a video
        you are making can be stopped (`POST
        /api/user/presentations/{id}/cancel`). `startCostIncluded`: your plan
        includes videos (you are not charged for them), so no estimate is sent.
        `lengths`: only when videos can be made in more than one length (for
        example 1 and 3 minutes): each length with its label, its estimate
        (`null` when your plan includes videos or it cannot be worked out) and
        `affordable` (your credits — or the Digital Twin's, when it pays — cover
        what that length needs to start; a 3-minute video needs the high end of
        its range). To make a video of another length, send the chosen `seconds`
        as `requestArgs.presentationSeconds` (60 or 180) with the chat message
        (`POST /api/ai/personal/qanda`); without it the video is 1 minute. The
        server checks the length again and refuses one that is not available
        (nothing is started or charged).
      responses:
        '200':
          description: Availability
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  available:
                    type: boolean
                    example: true
                  startAvailable:
                    type: boolean
                    example: true
                    description: You can start a new video from the chat in this session
                  startEstimate:
                    type: object
                    description: >-
                      About how many credits one 1-minute video costs you, as a
                      range (absent when it cannot be worked out)
                    properties:
                      low:
                        type: integer
                        example: 10
                      high:
                        type: integer
                        example: 15
                  startEstimateCredits:
                    type: integer
                    example: 15
                    description: >-
                      The high end of startEstimate, as one number (absent when
                      it cannot be worked out)
                  cancelAvailable:
                    type: boolean
                    example: true
                    description: >-
                      Present (true) where videos are available: a video can be
                      stopped with /{id}/cancel
                  startCostIncluded:
                    type: boolean
                    example: true
                    description: >-
                      Present (true) when your plan includes videos (you are not
                      charged for them); then there is no startEstimate or
                      startEstimateCredits
                  exportAvailable:
                    type: boolean
                    example: true
                  shareAvailable:
                    type: boolean
                    example: true
                  shareAudiences:
                    type: array
                    items:
                      type: string
                      enum:
                        - public
                        - twin
                    example:
                      - public
                      - twin
                  brandsAvailable:
                    type: boolean
                    example: true
                    description: >-
                      Present (true) only while brand colours are switched on:
                      the video page shows the Brand panel
                  brandImportAvailable:
                    type: boolean
                    example: true
                    description: >-
                      Present (true) only while importing brand colours from a
                      website is switched on too: the Brand panel shows Import
                      from website
                  lengths:
                    type: array
                    description: >-
                      Present only when more than one video length can be made;
                      shortest first
                    items:
                      type: object
                      properties:
                        seconds:
                          type: integer
                          example: 180
                        label:
                          type: string
                          example: 3 minutes
                        estimate:
                          type: object
                          nullable: true
                          description: >-
                            About how many credits a video of this length costs
                            you, as a range; null when your plan includes videos
                            or it cannot be worked out
                          properties:
                            low:
                              type: integer
                              example: 35
                            high:
                              type: integer
                              example: 50
                        gateCredits:
                          type: integer
                          example: 50
                          description: >-
                            How many credits must be available to start a video
                            of this length; absent when your plan includes
                            videos
                        affordable:
                          type: boolean
                          example: true
                          description: >-
                            Your credits (or the Digital Twin's, when it pays)
                            cover what this length needs to start
        '401':
          description: Not signed in
      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.