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

# Change a share link — audience, version, expiry, label — or turn it off

> `revision` moves the link to another version (normally the latest). `off: true` turns the link off for good (anything else in the body is ignored); a turned-off link cannot be changed or turned back on (`off: false` → 409 SHARE_OFF): create a new link instead. A new `expiresAt` on an EXPIRED link brings it back: the 20-live cap applies again (409 SHARE_LIMIT { cap }) and its version must still be shareable (409 NOT_SHAREABLE). If a move is refused and the link's old version was removed meanwhile, the link is turned off (`reason: pruned`).




## OpenAPI

````yaml /mdx/api-reference/runtime/runtime-api.json patch /api/user/presentations/{id}/shares/{shareId}
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/{id}/shares/{shareId}:
    patch:
      tags:
        - Presentations
      summary: Change a share link — audience, version, expiry, label — or turn it off
      description: >
        `revision` moves the link to another version (normally the latest).
        `off: true` turns the link off for good (anything else in the body is
        ignored); a turned-off link cannot be changed or turned back on (`off:
        false` → 409 SHARE_OFF): create a new link instead. A new `expiresAt` on
        an EXPIRED link brings it back: the 20-live cap applies again (409
        SHARE_LIMIT { cap }) and its version must still be shareable (409
        NOT_SHAREABLE). If a move is refused and the link's old version was
        removed meanwhile, the link is turned off (`reason: pruned`).
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
        - in: path
          name: shareId
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                audience:
                  type: string
                  enum:
                    - public
                    - twin
                revision:
                  type: integer
                  minimum: 1
                expiresAt:
                  type: string
                  format: date-time
                  nullable: true
                label:
                  type: string
                  maxLength: 80
                'off':
                  type: boolean
                  enum:
                    - true
      responses:
        '200':
          description: The link after the change
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  share:
                    $ref: '#/components/schemas/PresentationShare'
        '400':
          description: INVALID
        '403':
          description: AUDIENCE_NOT_ALLOWED
        '404':
          description: NOT_FOUND
        '409':
          description: >-
            NOT_SHAREABLE (the version is not ready, not its version's newest
            revision, or being cleaned up — retry), SHARE_OFF, SHARE_LIMIT { cap
            } (reviving an expired link)
        '429':
          description: RATE_LIMITED
        '503':
          description: SHARES_UNAVAILABLE
      security:
        - apiKeyAuth: []
components:
  schemas:
    PresentationShare:
      type: object
      properties:
        shareId:
          type: string
        url:
          type: string
          nullable: true
          description: >-
            Absolute link (the app's configured origin + path); null when no
            origin is configured or the link can no longer open (reason reset)
          example: >-
            https://pria.praxis-ai.com/share#3q2-7wAbCdEfGhIjKlMnOpQrStUvWxYz0123456789_-A
        path:
          type: string
          nullable: true
          description: null when the link can no longer open (reason reset)
          example: /share#3q2-7wAbCdEfGhIjKlMnOpQrStUvWxYz0123456789_-A
        label:
          type: string
          example: Acme — Bob
        audience:
          type: string
          enum:
            - public
            - twin
        revision:
          type: object
          properties:
            number:
              type: integer
            version:
              type: integer
        expiresAt:
          type: string
          format: date-time
          nullable: true
        revokedAt:
          type: string
          format: date-time
          nullable: true
        state:
          type: string
          enum:
            - live
            - 'off'
            - expired
        reason:
          type: string
          nullable: true
          enum:
            - turned_off
            - pruned
            - reset
          description: >-
            Why an off link is off — turned_off (by you), pruned (a refused move
            found its old version removed), reset (share links were reset for
            the platform: it can never open again). null while live or expired.
        viewCount:
          type: integer
          description: Plays started (nothing about viewers is stored)
        lastViewedAt:
          type: string
          format: date-time
          nullable: true
        createdAt:
          type: string
          format: date-time
        download:
          type: object
          description: >-
            What a viewer may download (a share-safe export of this version);
            always false for an off or expired link
          properties:
            mp4:
              type: boolean
            vtt:
              type: boolean
  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.