> ## 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.
# Adjust an institution's credit balance (super admin only)
> Adds or subtracts credits from the given institution. Records an AccountTransfer with a mandatory note for audit. If the institution has a parent account, by default credits are transferred zero-sum from that account (the account's balance is decremented by the same amount and the AccountTransfer record has both institution and account set). For standalone institutions OR when skipParentDebit is true, credits are injected directly into the institution with no account adjustment, and the AccountTransfer record omits the account field. skipParentDebit is intended for promo/compensation credits funded by the platform. Reserved for super administrators - regular admins and account managers receive 403.
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json post /api/admin/institution/{id}/credits
openapi: 3.0.0
info:
title: Pria Admin API
version: 2.0.1
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.
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/admin/institution/{id}/credits:
post:
tags:
- Admin Institutions
summary: Adjust an institution's credit balance (super admin only)
description: >-
Adds or subtracts credits from the given institution. Records an
AccountTransfer with a mandatory note for audit. If the institution has
a parent account, by default credits are transferred zero-sum from that
account (the account's balance is decremented by the same amount and the
AccountTransfer record has both institution and account set). For
standalone institutions OR when skipParentDebit is true, credits are
injected directly into the institution with no account adjustment, and
the AccountTransfer record omits the account field. skipParentDebit is
intended for promo/compensation credits funded by the platform. Reserved
for super administrators - regular admins and account managers receive
403.
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Institution ID
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- credits
- note
properties:
credits:
type: integer
description: Non-zero integer. Positive adds, negative subtracts.
example: 100
note:
type: string
description: Mandatory reason for the adjustment. Max 2000 chars.
example: compensation for outage
skipParentDebit:
type: boolean
default: false
description: >-
If true, inject credits directly into the institution
without debiting the parent account. Only meaningful when
the institution has a parent account. Intended for
promo/compensation credits funded by the platform rather
than the client account.
responses:
'200':
description: Credits adjusted and transfer recorded
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: object
properties:
institution:
type: object
properties:
id:
type: string
credits:
type: number
account:
type: object
description: >-
Present only on zero-sum transfers (parent account
existed and skipParentDebit was not set).
properties:
id:
type: string
credits:
type: number
transfer:
$ref: '#/components/schemas/AccountTransfer'
message:
type: string
example: Institution credits adjusted!
'400':
description: >-
Validation failure (invalid id, credits, or note) or insufficient
balance
'401':
description: Authentication required
'403':
description: Not a super admin
'404':
description: Institution not found
'409':
description: >-
Parent account reference is dangling - resolve before adjusting
credits
security:
- apiKeyAuth: []
components:
schemas:
AccountTransfer:
type: object
properties:
_id:
type: string
description: Transfer ID
institution:
type: string
description: >-
Institution ObjectId (optional - present for institution-scoped
transfers)
account:
type: string
description: >-
Account ObjectId (optional - present for account-scoped transfers
and zero-sum institution transfers)
user:
type: string
description: User ObjectId of the admin who made the change
credits:
type: number
description: Credit delta (can be negative)
status:
type: string
description: active, inactive, or deleted
example: active
created:
type: string
format: date-time
description: Transfer timestamp
transferMode:
type: integer
description: 1 = manual by admin, 2 = auto, 3 = on delete (institution)
example: 1
note:
type: string
description: Reason provided by the admin (required for manual adjustments)
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````