> ## 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.
# Retrieve branding information for a digital twin
> Gets branding details for an institution's digital twin instance.
Use this API to personalize your embedded application with the institution's
custom avatar, background images, AI name, and description.
**No authentication required** when providing a valid `publicId`.
## Use Cases
- SDK/widget embedding customization
- White-label application theming
- Voice-enabled digital twin configuration
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json post /api/agent/branding
openapi: 3.0.0
info:
title: Pria Runtime 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: 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/agent/branding:
post:
tags:
- Branding
summary: Retrieve branding information for a digital twin
description: >
Gets branding details for an institution's digital twin instance.
Use this API to personalize your embedded application with the
institution's
custom avatar, background images, AI name, and description.
**No authentication required** when providing a valid `publicId`.
## Use Cases
- SDK/widget embedding customization
- White-label application theming
- Voice-enabled digital twin configuration
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/AgentBrandingRequest'
example:
publicId: 5f03e5e6-9dde-4ddc-b686-7a77ac617e52
responses:
'200':
description: Branding information retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/AgentBrandingResponse'
example:
picture: https://pria.praxislxp.com/logo192_v3.webp
picture_animated: ''
picture_bg: https://pria.praxislxp.com/pria_bg2.webp
picture_dark_bg: ''
elevenlabs_agent_id: agent_0201kedjfdgee87bjke8acq3pcbg
about: I am an AI-powered virtual mentor...
ainame: Pria
status: active
'404':
description: Digital twin not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
AgentBrandingRequest:
type: object
description: Request to retrieve institution branding for SDK/web embedding
properties:
publicId:
type: string
format: uuid
description: The public identifier (UUID) for the digital twin instance
example: 5f03e5e6-9dde-4ddc-b686-7a77ac617e52
AgentBrandingResponse:
type: object
description: Institution branding and configuration for UI customization
properties:
picture:
type: string
format: uri
description: URL to the agent's profile picture (avatar)
example: https://pria.praxislxp.com/logo192_v3.webp
picture_animated:
type: string
format: uri
description: URL to the agent's animated avatar (GIF/WebP)
example: ''
picture_bg:
type: string
format: uri
description: URL to the agent's background image (light mode)
example: https://pria.praxislxp.com/pria_bg2.webp
picture_dark_bg:
type: string
format: uri
description: URL to the agent's background image (dark mode)
example: ''
elevenlabs_agent_id:
type: string
description: ElevenLabs Conversational AI Agent ID for voice-enabled digital twin
example: agent_0201kedjfdgee87bjke8acq3pcbg
about:
type: string
description: AI agent's purpose and capabilities description
example: >-
I am an AI-powered virtual mentor programmed to help experts,
students, faculty, and researchers with their digital corporate,
education, research, and career goals...
ainame:
type: string
description: Display name of the AI agent
example: Pria
status:
type: string
enum:
- active
- inactive
description: Current status of the digital twin
example: active
ErrorResponse:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
description: Human-readable error message
error:
type: string
description: Technical error details
````