> ## 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.
# Generate an AI summary title for a history record or conversation
> Uses AI to generate a concise title that describes the benefit or outcome of the conversation. The AI provider is determined by the institution's summaryModel configuration. When 'id' is supplied, reads a single history record (input, inputs, output, outputs, code) and returns up to 200 chars. When 'course_id' is supplied, summarizes the first 2 + last 3 dialogues of the conversation within the resolved institution scope (all dialogues if ≤5 total) and returns up to 50 chars. course_id mode supports institution scoping (ObjectId / explicit null = personal / omitted = user.institution fallback); allInstitutions:true is rejected with 400.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json post /api/user/summarizeHistory
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/user/summarizeHistory:
post:
tags:
- History
summary: Generate an AI summary title for a history record or conversation
description: >-
Uses AI to generate a concise title that describes the benefit or
outcome of the conversation. The AI provider is determined by the
institution's summaryModel configuration. When 'id' is supplied, reads a
single history record (input, inputs, output, outputs, code) and returns
up to 200 chars. When 'course_id' is supplied, summarizes the first 2 +
last 3 dialogues of the conversation within the resolved institution
scope (all dialogues if ≤5 total) and returns up to 50 chars. course_id
mode supports institution scoping (ObjectId / explicit null = personal /
omitted = user.institution fallback); allInstitutions:true is rejected
with 400.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizeHistoryRequest'
example:
id: 688b024f7db6fe6e921399e3
responses:
'200':
description: Summary successfully generated
content:
application/json:
schema:
$ref: '#/components/schemas/SummarizeHistoryResponse'
examples:
successResponse:
summary: AI-generated title returned
value:
success: true
message: Summary generated
data: How to deploy a Node.js application to AWS with Docker
'400':
description: >-
Bad request - missing id/course_id, invalid id, no dialogues for
course_id, malformed institution ObjectId, allInstitutions:true, or
AI provider error
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: >-
Invalid parameter. You must supply a valid id or
course_id.
error:
type: object
'401':
description: Unauthorized - user not found or invalid token
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Authentication Required!
'403':
description: >-
Forbidden - the supplied institution ObjectId is not an active
UserInstitution membership for this user.
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: You are not a member of this institution
security:
- apiKeyAuth: []
components:
schemas:
SummarizeHistoryRequest:
type: object
description: >-
Supply either 'id' to summarize a single history record (favorite), or
'course_id' to summarize a whole conversation. course_id mode supports
institution scoping.
properties:
id:
type: string
description: >-
ObjectId of the history record to summarize. Single-record
operations are not institution-scoped (_id is globally unique).
example: 688b024f7db6fe6e921399e3
course_id:
type: integer
description: >-
Conversation course_id to summarize (first 2 + last 3 dialogues; all
if ≤5 total). course_id=0 covers the unassigned bucket (course_id
0/null/missing).
example: 1712345678901
institution:
type: string
nullable: true
description: >-
Institution scope (course_id mode only). Three-state: (1) valid
ObjectId scopes to that twin (membership-checked — 403 if not
active), (2) explicit null/empty scopes to personal/null history,
(3) field omitted falls back to user.institution. Malformed ObjectId
returns 400.
SummarizeHistoryResponse:
type: object
properties:
success:
type: boolean
example: true
message:
type: string
example: Summary generated
data:
type: string
description: >-
AI-generated title. Favorites (id mode): ≤200 chars. Conversations
(course_id mode): ≤50 chars.
example: How to deploy a Node.js application to AWS with Docker
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````