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

# Get a Digital Twin's settings

> Returns one Digital Twin's settings as the twin editor loads them. The caller needs the institutions.edit entitlement on that twin. The twin's secret fields (its provider API keys, `mcpServerSecret`, `mcpSigningSecret`, `curationSecret`, `canvasClientSecret`, `kalturaSecret`, `aws_secret_access_key` and `canvasFacultyAccessToken`) are returned only to an administrator signed in to the app. A request made with a session obtained from an API key (`POST /api/auth/api-key-signin`) receives the settings without any of these fields. A `PUT` made with such a session ignores a blank value for any of them, so it cannot clear a stored secret; a non-empty value still replaces it. To rotate a secret from a script, send the new value with `PUT`: the current value is never needed.




## OpenAPI

````yaml /mdx/api-reference/admin/admin-api.json get /api/admin/institution/{id}
openapi: 3.0.0
info:
  title: Pria Admin API
  version: 2.0.282
  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://hiimpria.ai
    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 account managers (/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/admin/institution/{id}:
    get:
      tags:
        - Admin Institutions
      summary: Get a Digital Twin's settings
      description: >
        Returns one Digital Twin's settings as the twin editor loads them. The
        caller needs the institutions.edit entitlement on that twin. The twin's
        secret fields (its provider API keys, `mcpServerSecret`,
        `mcpSigningSecret`, `curationSecret`, `canvasClientSecret`,
        `kalturaSecret`, `aws_secret_access_key` and `canvasFacultyAccessToken`)
        are returned only to an administrator signed in to the app. A request
        made with a session obtained from an API key (`POST
        /api/auth/api-key-signin`) receives the settings without any of these
        fields. A `PUT` made with such a session ignores a blank value for any
        of them, so it cannot clear a stored secret; a non-empty value still
        replaces it. To rotate a secret from a script, send the new value with
        `PUT`: the current value is never needed.
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
          description: Institution ID
      responses:
        '200':
          description: >-
            The twin's settings in `data`; without the secret fields for a
            session obtained from an API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    description: The Digital Twin's settings
        '400':
          description: >-
            Invalid instance id, or the caller does not hold institutions.edit
            on this twin
        '401':
          description: Authentication required
        '404':
          description: Instance not found
      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.