> ## 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.
# Read brand colours from a website
> Reads a public website (its page, up to 3 of its own stylesheets and its web manifest) and answers its brand colours, name and logo address, for the Appearance settings to build a theme from. Nothing is saved. Only public addresses are read; the whole read is limited in size and time. Limited to 5 requests a minute per user. A session opened from a course page must first confirm it is the person (403 LAUNCH_SCOPE_STEP_UP).
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json post /api/user/appearance/brand-import
openapi: 3.0.0
info:
title: Pria Runtime API
version: 2.0.343
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/appearance/brand-import:
post:
tags:
- User
summary: Read brand colours from a website
description: >-
Reads a public website (its page, up to 3 of its own stylesheets and its
web manifest) and answers its brand colours, name and logo address, for
the Appearance settings to build a theme from. Nothing is saved. Only
public addresses are read; the whole read is limited in size and time.
Limited to 5 requests a minute per user. A session opened from a course
page must first confirm it is the person (403 LAUNCH_SCOPE_STEP_UP).
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- url
properties:
url:
type: string
maxLength: 2048
description: >-
A public website address. A bare domain (example.com) is
read as https://example.com.
example: example.com
responses:
'200':
description: The colours found
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
$ref: '#/components/schemas/BrandImportResult'
'400':
description: Not a website address, or one that is not public
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Not signed in
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: The page was read but no brand colours were found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Too many imports in a short time
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'502':
description: >-
The website could not be opened (unreachable, too slow, too large or
an error page)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- apiKeyAuth: []
components:
schemas:
BrandImportResult:
type: object
properties:
siteUrl:
type: string
description: The page that was read (after redirects).
name:
type: string
description: >-
The site name: og:site_name, application-name or the page title (at
most 60 characters), else the host name.
logo:
type: string
nullable: true
description: >-
An https address of the site icon or share image. Pria does not
download it.
themeColor:
type: string
nullable: true
description: >-
The theme colour the site declares (theme-color meta tag or web
manifest).
background:
type: string
nullable: true
description: The best guess of the page background colour.
palette:
type: array
maxItems: 10
description: >-
The brand colours found, strongest first. Greys, black and white are
left out; near-identical colours are merged.
items:
$ref: '#/components/schemas/BrandImportColor'
ErrorResponse:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
description: Human-readable error message
error:
type: string
description: Technical error details
BrandImportColor:
type: object
properties:
hex:
type: string
pattern: ^#[0-9a-f]{6}$
example: '#1a73e8'
weight:
type: number
description: >-
How strongly the site signals this colour (higher is stronger). The
palette is sorted by it.
sources:
type: array
description: Where the colour was found.
items:
type: string
enum:
- theme-color
- manifest
- css-variable
- frequency
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.