> ## 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.
# Connect this Digital Twin to Power BI (read-only)
> Saves the Azure tenant id and one or more Power BI connections. Each connection is an Azure app (service principal) with Build permission on one dataset. Every connection is verified before anything is saved: a client-credentials token, then `EVALUATE ROW("ok", 1)` through executeQueries. The response reports each connection's outcome. On success the configuration is stored encrypted and the twin's Power BI tool is switched on for its signed-in members. Leave `client_secret` empty to keep a connection's stored secret (same tenant, name, client id, workspace and dataset). The whole list replaces the previous one. Instance administrators only; at most 5 attempts per 10 minutes per twin. Nothing is ever written to Power BI: the server's client can only make four requests (the token mint, executeQueries, GET dataset, GET refreshes?$top=1) and refuses any other method or path before it is sent.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json post /api/user/agents/connect/powerbi/key
openapi: 3.0.0
info:
title: Pria Runtime 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.
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.
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: 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/agents/connect/powerbi/key:
post:
tags:
- Power BI connection
summary: Connect this Digital Twin to Power BI (read-only)
description: >
Saves the Azure tenant id and one or more Power BI connections. Each
connection is an Azure app (service principal) with Build permission on
one dataset. Every connection is verified before anything is saved: a
client-credentials token, then `EVALUATE ROW("ok", 1)` through
executeQueries. The response reports each connection's outcome. On
success the configuration is stored encrypted and the twin's Power BI
tool is switched on for its signed-in members. Leave `client_secret`
empty to keep a connection's stored secret (same tenant, name, client
id, workspace and dataset). The whole list replaces the previous one.
Instance administrators only; at most 5 attempts per 10 minutes per
twin. Nothing is ever written to Power BI: the server's client can only
make four requests (the token mint, executeQueries, GET dataset, GET
refreshes?$top=1) and refuses any other method or path before it is
sent.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- tenant_id
- connections
properties:
tenant_id:
type: string
description: >-
Directory (tenant) GUID or a domain like
example.onmicrosoft.com
connections:
type: array
minItems: 1
maxItems: 10
items:
type: object
required:
- name
- client_id
- group_id
- dataset_id
properties:
name:
type: string
pattern: ^[a-z0-9][a-z0-9_-]{0,39}$
description: Unique slug the twin uses to pick the dataset
example: jobcost
label:
type: string
maxLength: 80
example: Riverside job cost
client_id:
type: string
format: uuid
client_secret:
type: string
format: password
description: Write-only. Empty keeps the stored secret.
group_id:
type: string
format: uuid
description: Workspace id
dataset_id:
type: string
format: uuid
responses:
'200':
description: Every connection verified; saved and connected
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
connected:
type: boolean
example: true
results:
type: array
items:
type: object
properties:
name:
type: string
ok:
type: boolean
datasetName:
type: string
error:
type: object
properties:
code:
type: string
message:
type: string
'400':
description: >-
Invalid configuration (MISSING_TENANT, INVALID_TENANT,
MISSING_CONNECTIONS, INVALID_NAME, DUPLICATE_NAME,
INVALID_CLIENT_ID, MISSING_SECRET, INVALID_GROUP_ID,
INVALID_DATASET_ID, …) or a connection failed verification
(VERIFY_FAILED, with per-connection results; nothing saved)
'403':
description: Not an instance administrator of this twin
'429':
description: Too many connection attempts
'502':
description: Power BI could not be reached
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.