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

# Course-wide Hide Pria for everyone toggle

> Hides (or restores) Pria for an entire Canvas course. Teacher-gated both ways: students can
neither hide a course nor show it again. Identity and course come from the VERIFIED launch
or the ticket — never free body fields.

A course already connected to a USABLE Digital Twin cannot be hidden (409). A course whose
only holder is a DISABLED Digital Twin stays connected to it (it is freed only by a
teacher's Disconnect or an administrator's edit); hiding it still works, because only a
USABLE holder blocks the hide.




## OpenAPI

````yaml /mdx/api-reference/admin/admin-api.json post /api/auth/sdk-hide
openapi: 3.0.0
info:
  title: Pria Admin API
  version: 2.0.183
  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.
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: Admin Memory
    description: Admin inspection and editing of user/instance memory parameters.
  - name: Admin Usage Limits
    description: Per-user usage-vs-cap reporting and account-wide at-limit counts.
paths:
  /api/auth/sdk-hide:
    post:
      tags:
        - SDK Launch
      summary: Course-wide Hide Pria for everyone toggle
      description: >
        Hides (or restores) Pria for an entire Canvas course. Teacher-gated both
        ways: students can

        neither hide a course nor show it again. Identity and course come from
        the VERIFIED launch

        or the ticket — never free body fields.


        A course already connected to a USABLE Digital Twin cannot be hidden
        (409). A course whose

        only holder is a DISABLED Digital Twin stays connected to it (it is
        freed only by a

        teacher's Disconnect or an administrator's edit); hiding it still works,
        because only a

        USABLE holder blocks the hide.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SdkHideRequest'
      responses:
        '200':
          description: Preference saved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SdkHideResponse'
        '400':
          description: >-
            `"Missing verification parameters"`, or `"Launch is missing course
            context"` (a signed launch without a course).
        '401':
          description: >-
            Launch proof only — a ticket never answers 401: `"Launch token
            expired"` (outside its 10-minute window) or `"Invalid launch token"`
            (tampered or malformed).
        '403':
          description: '"Only teachers or administrators can change this setting."'
        '409':
          description: >-
            "This course is already connected to a digital twin, so it cannot be
            hidden here. Contact your administrator."
        '410':
          description: >-
            The ticket is expired or invalid: `{ success: false, code:
            "COURSE_TICKET_EXPIRED" | "COURSE_TICKET_INVALID", message: "This
            page has expired" }`.
        '500':
          description: >-
            `"Failed to save preference"`, or `"Server configuration error"`
            (the server has no `SDK_LAUNCH_SECRET`).
components:
  schemas:
    SdkHideRequest:
      type: object
      description: >
        Either a fresh signed launch
        (`params`/`launch_token`/`nonce`/`timestamp`, as verified by

        `/api/auth/sdk-verify`) OR a `ticket` minted earlier by this same
        endpoint or by

        `POST /api/auth/getInstitutionsForContextid` — never both required. When
        both a `ticket`

        and a launch proof are sent, the ticket wins and the launch proof is
        ignored. A ticket

        carries the same identity/course facts as the launch it came from for up
        to 4 hours

        (design 2026-09-28 D4/D7), so a teacher can return to the panel after
        the 10-minute

        launch signature has expired.
      properties:
        params:
          type: object
          description: >-
            Launch parameters, when authenticating by fresh launch (see
            `SdkVerifyRequest`).
        launch_token:
          type: string
          description: >-
            HMAC-SHA256 token returned from sdk-sign, when authenticating by
            fresh launch.
        nonce:
          type: string
          description: >-
            The nonce returned from sdk-sign, when authenticating by fresh
            launch.
        timestamp:
          type: integer
          description: >-
            The timestamp returned from sdk-sign, when authenticating by fresh
            launch.
        ticket:
          type: string
          description: >-
            A course ticket, when authenticating by ticket instead of a fresh
            launch.
        hidden:
          type: boolean
          default: true
          description: Set the course-wide hide (default). `false` shows Pria again.
    SdkHideResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        hidden:
          type: boolean
        ticket:
          type: string
          nullable: true
          description: >
            By ticket: the SAME ticket handed back unchanged (a ticket never
            renews itself). By a

            fresh launch: a freshly minted 4-hour course ticket, so the caller
            can act again

            without re-launching. `null` in the rare case no ticket could be
            minted (for example,

            an over-long course id); the caller keeps using its launch proof.

````