> ## 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.
# Clear history records (soft delete)
> Soft-deletes history records by setting forgotten=true. Two operation modes: (1) course_id deletes a conversation within the resolved institution scope and detaches its favorites, (2) id deletes a single record. Favorites in a course are detached (course_id/course_name removed) rather than deleted. 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/clearHistory
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/clearHistory:
post:
tags:
- History
summary: Clear history records (soft delete)
description: >-
Soft-deletes history records by setting forgotten=true. Two operation
modes: (1) course_id deletes a conversation within the resolved
institution scope and detaches its favorites, (2) id deletes a single
record. Favorites in a course are detached (course_id/course_name
removed) rather than deleted. 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/ClearHistoryRequest'
examples:
clearCourse:
summary: Clear a specific conversation in the current twin (fallback)
value:
course_id: 1750532703472
clearCourseInTwin:
summary: Clear a conversation explicitly scoped to a twin
value:
course_id: 1750532703472
institution: 60d5ec49f1b2c80015a4d1a1
clearCoursePersonal:
summary: >-
Clear a personal-history conversation (regardless of
user.institution)
value:
course_id: 1750532703472
institution: null
clearUnassigned:
summary: Sweep the unassigned bucket (course_id 0/null/missing)
value:
course_id: 0
clearSingle:
summary: Clear a single history record
value:
id: 688b024f7db6fe6e921399e3
responses:
'200':
description: History records successfully cleared
content:
application/json:
schema:
$ref: '#/components/schemas/ClearHistoryResponse'
examples:
clearCourseResponse:
summary: Response when clearing by course_id
value:
success: true
message: History updated!
clearSingleResponse:
summary: Response when clearing a single record by id
value:
success: true
message: History updated!
'400':
description: >-
Bad request - invalid course_id (must be a number), malformed
institution ObjectId, or allInstitutions:true was supplied (not
supported on course-level destructive operations).
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: >-
allInstitutions is not supported on course-level
destructive operations.
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:
ClearHistoryRequest:
type: object
description: >-
Two mutually exclusive modes. Provide exactly one of: course_id, or id.
The course_id mode also accepts an optional institution scope.
properties:
course_id:
type: number
description: >-
Course identifier. Detaches favorites from the course (unsets
course_id/course_name) then soft-deletes remaining course records
within the resolved institution scope. course_id=0 sweeps the
unassigned bucket (records with course_id 0, null, or missing).
example: 1750532703472
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 the user
is not an active member), (2) explicit null/empty scopes to
personal/null history, (3) field omitted falls back to the user's
current institution. Malformed ObjectId returns 400.
id:
type: string
description: >-
ObjectId of a single history record to soft-delete. Single-record
operations are not institution-scoped (the _id is globally unique).
example: 688b024f7db6fe6e921399e3
ClearHistoryResponse:
type: object
properties:
success:
type: boolean
example: true
message:
type: string
example: History updated!
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````