/api/v1/ai-features/provider-statusAI configuration status; does not contact the provider or expose secrets
dashboard:viewUse assisted writing, learning support and forecasts while reviewing the provider state and human decisions.
Intended access: Assigned account with the required permissions.
dashboard:viewexam:updateattendance:viewfee:viewexam:createstudent:viewlms:viewtimetable:viewinventory:viewcommunication:createattendance:createhostel:viewexam:viewstudent:managefee:manageattendance:updatetransport:viewhealth:managesettings:updateUse the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
An assigned school account with the required permissions.
Academic assistance is part of the documented workflow.
Learning gaps is part of the documented workflow.
Review the result in the connected record or workspace before moving on.
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
studentId | string | Required by declaration |
examId | string | Optional |
subject | string | Required by declaration |
topic | string | Optional |
difficulty | string | Optional |
count | number | Optional |
questionType | string | Optional |
question | string | Required by declaration |
lessonId | string | Required by declaration |
bulletPoints | string | Required by declaration |
language | string | Optional |
interestArea | string | Optional |
sectionId | string | Required by declaration |
transcript | string | Required by declaration |
date | string | Optional |
imageUrl | string | Required by declaration |
claimedName | string | Optional |
visitorLogId | string | Optional |
referenceImageUrl | string | Optional |
sourceImageUrl | string | Required by declaration |
targetImageUrl | string | Required by declaration |
days | number | Optional |
regenerate | boolean | Optional |
status | 'DRAFT' | 'PUBLISHED' | 'PRIVATE' | 'ARCHIVED' | Required by declaration |
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.
/api/v1/ai-features/provider-statusAI configuration status; does not contact the provider or expose secrets
dashboard:view/api/v1/ai-features/remarksGenerate Remark
exam:updateDeclared request fields: studentId (required), examId (optional).
/api/v1/ai-features/attendance-anomaliesAttendance Anomalies
attendance:view/api/v1/ai-features/fee-riskFee Risk
fee:view/api/v1/ai-features/question-paperGenerate Question Paper
exam:createDeclared request fields: subject (required), topic (required), difficulty (optional), count (optional), questionType (optional).
/api/v1/ai-features/discipline-riskDiscipline Risk
student:view/api/v1/ai-features/parent-chatParent Chat
dashboard:viewDeclared request fields: studentId (required), question (required).
/api/v1/ai-features/staff-copilotGeneric AI Assistant for staff — grounded in real, live school numbers
dashboard:viewDeclared request fields: question (required).
/api/v1/ai-features/study-buddyStudy Buddy
lms:viewDeclared request fields: lessonId (required), question (required).
/api/v1/ai-features/career-counsel/:studentIdCareer Counsel
student:view/api/v1/ai-features/timetable-suggestSuggest Timetable
timetable:view/api/v1/ai-features/inventory-reorderInventory Reorder
inventory:view/api/v1/ai-features/notice-draftDraft Notice
communication:createDeclared request fields: bulletPoints (required), language (optional).
/api/v1/ai-features/alumni-matchMatch Alumni
student:viewDeclared request fields: studentId (required), interestArea (required).
/api/v1/ai-features/voice-attendanceVoice Attendance
attendance:createDeclared request fields: sectionId (required), transcript (required), date (optional).
/api/v1/ai-features/visitor-verifyVerify Visitor Photo
hostel:viewDeclared request fields: imageUrl (required), claimedName (optional), visitorLogId (optional), referenceImageUrl (optional).
/api/v1/ai-features/dropout-riskDropout Risk
student:view/api/v1/ai-features/repeat-visitorsRepeat Visitors
hostel:view/api/v1/ai-features/face-matchCompare Faces
hostel:viewDeclared request fields: sourceImageUrl (required), targetImageUrl (required).
/api/v1/ai-features/learning-pathLearning Path
lms:viewDeclared request fields: studentId (required), days (optional), regenerate (optional).
/api/v1/ai-features/learning-path/:studentIdGet Learning Path
lms:view/api/v1/ai-features/learning-path/:studentId/historyLearning Path History
lms:view/api/v1/ai-features/learning-path-items/:itemIdUpdate Learning Path Item
lms:viewDeclared request fields: status (required), reflection (optional).
/api/v1/ai-features/learning-gapsList Learning Gaps
student:view/api/v1/ai-features/learning-gaps/latestLatest Learning Gap Scan
student:view/api/v1/ai-features/learning-gaps/scanRun Learning Gap Scan
student:viewDeclared request fields: sectionId (optional), weeks (optional).
/api/v1/ai-features/learning-gaps/alerts/:alertIdUpdate Learning Gap Alert
student:viewDeclared request fields: status (required), note (optional).
/api/v1/ai-features/learning-gaps/alerts/:alertId/learning-pathLearning Path From Gap
lms:view/api/v1/ai-features/adaptive-examAdaptive Exam
exam:viewDeclared request fields: studentId (required), subjectId (required), answers (optional).
/api/v1/ai-features/lesson-plannerList Lesson Plans
timetable:view/api/v1/ai-features/lesson-plannerGenerate Lesson Plan
timetable:viewDeclared request fields: classId (required), subjectId (required), topic (optional), weekOf (optional), sectionId (optional), regenerate (optional).
/api/v1/ai-features/lesson-planner/days/:dayIdUpdate Lesson Plan Day
timetable:viewDeclared request fields: objectives (optional), activities (optional), worksheet (optional), exitTicket (optional), notes (optional).
/api/v1/ai-features/lesson-planner/:planIdGet Lesson Plan
timetable:view/api/v1/ai-features/lesson-planner/:planIdUpdate Lesson Plan Meta
timetable:viewDeclared request fields: homework (optional), assessmentTip (optional), summary (optional), topic (optional).
/api/v1/ai-features/lesson-planner/:planId/statusSet Lesson Plan Status
timetable:viewDeclared request fields: status (required).
/api/v1/ai-features/multilingual-explainList Multilingual Explain
lms:view/api/v1/ai-features/multilingual-explainGenerate Multilingual Explain
lms:viewDeclared request fields: concept (required), level (optional), languages (optional), subjectId (optional), classId (optional), audience (optional), publish (optional).
/api/v1/ai-features/multilingual-explain/langs/:langIdUpdate Multilingual Explain Lang
lms:viewDeclared request fields: title (optional), body (optional), parentTip (optional).
/api/v1/ai-features/multilingual-explain/:idGet Multilingual Explain
lms:view/api/v1/ai-features/multilingual-explain/:idUpdate Multilingual Explain Meta
lms:viewDeclared request fields: concept (optional), level (optional), subjectId (optional), classId (optional), audience (optional).
/api/v1/ai-features/multilingual-explain/:id/statusSet Multilingual Explain Status
lms:viewDeclared request fields: status (required).
/api/v1/ai-features/enrolment-forecastList Enrolment Forecast
student:manage/api/v1/ai-features/enrolment-forecast/latestLatest Enrolment Forecast
student:manage/api/v1/ai-features/enrolment-forecast/compareCompare Enrolment Forecast
student:manage/api/v1/ai-features/enrolment-forecastRun Enrolment Forecast
student:manageDeclared request fields: conversionPct (optional), defaultSectionCapacity (optional), studentsPerTeacher (optional), label (optional).
/api/v1/ai-features/enrolment-forecast/:idGet Enrolment Forecast
student:manage/api/v1/ai-features/cashflow-predictionList Cashflow
fee:manage/api/v1/ai-features/cashflow-prediction/latestLatest Cashflow
fee:manage/api/v1/ai-features/cashflow-prediction/compareCompare Cashflow
fee:manage/api/v1/ai-features/cashflow-predictionRun Cashflow
fee:manageDeclared request fields: scholarshipPct (optional), months (optional), collectionRatePct (optional), label (optional).
/api/v1/ai-features/cashflow-prediction/:idGet Cashflow
fee:manage/api/v1/ai-features/staff-workloadList Staff Workload
timetable:view, attendance:update/api/v1/ai-features/staff-workload/latestLatest Staff Workload
timetable:view, attendance:update/api/v1/ai-features/staff-workloadRun Staff Workload
timetable:view, attendance:updateDeclared request fields: overloadThreshold (optional), mediumThreshold (optional), underutilizedRatio (optional), label (optional).
/api/v1/ai-features/staff-workload/substitutionsSuggest Substitutions
timetable:view, attendance:updateDeclared request fields: absentStaffId (required), date (optional), apply (optional).
/api/v1/ai-features/staff-workload/:idGet Staff Workload
timetable:view, attendance:update/api/v1/ai-features/transport-etaList Transport Eta
transport:view/api/v1/ai-features/transport-eta/latestLatest Transport Eta
transport:view/api/v1/ai-features/transport-eta/live/:vehicleIdLive Transport Eta
transport:view/api/v1/ai-features/transport-etaRun Transport Eta
transport:viewDeclared request fields: vehicleId (optional), routeId (optional), scope (optional), lateThresholdMin (optional), stalePingMin (optional), label (optional).
/api/v1/ai-features/transport-eta/:idGet Transport Eta
transport:view/api/v1/ai-features/hostel-inventory-forecastList Inventory Forecast
inventory:view/api/v1/ai-features/hostel-inventory-forecast/latestLatest Inventory Forecast
inventory:view/api/v1/ai-features/hostel-inventory-forecastRun Inventory Forecast
inventory:viewDeclared request fields: lookbackDays (optional), horizonDays (optional), occupancyBoostPct (optional), category (optional), label (optional).
/api/v1/ai-features/hostel-inventory-forecast/:id/draft-poDraft Po From Forecast
inventory:view/api/v1/ai-features/hostel-inventory-forecast/:idGet Inventory Forecast
inventory:view/api/v1/ai-features/parent-copilotParent Copilot
dashboard:viewDeclared request fields: studentId (required), question (required), channel (optional).
/api/v1/ai-features/voice-assistantVoice Assistant
dashboard:viewDeclared request fields: studentId (required), transcript (required).
/api/v1/ai-features/progress-storyProgress Story
student:viewDeclared request fields: studentId (required), language (optional).
/api/v1/ai-features/career-twinCareer Twin
student:viewDeclared request fields: studentId (required), interests (optional), psychometric (optional).
/api/v1/ai-features/alumni-opportunityAlumni Opportunity
student:viewDeclared request fields: studentId (required), opportunityType (optional), interestArea (optional).
/api/v1/ai-features/campus-safetyCampus Safety
hostel:viewDeclared request fields: visitorLogId (optional), studentId (optional), vehicleId (optional), days (optional).
/api/v1/ai-features/wellbeing-radarWellbeing Radar
health:manage/api/v1/ai-features/ai-auditAi Audit
dashboard:view/api/v1/ai-features/ai-audit/feedbackAi Audit Feedback
dashboard:viewDeclared request fields: requestId (required), decision (required), note (optional), correctedText (optional).
/api/v1/ai-features/fairness-monitorFairness Monitor
student:manage/api/v1/ai-features/data-minimizationGet Data Minimization
dashboard:view/api/v1/ai-features/data-minimizationUpdate Data Minimization
settings:updateDeclared request fields: biometricEnabled (optional), faceMatchEnabled (optional), biometricRetentionDays (optional), parentOptOutDefault (optional), consentRequiredFeatures (optional).
/api/v1/ai-features/auto-gradeAuto Grade
exam:updateDeclared request fields: assignmentId (required), studentId (required), submissionText (optional), publish (optional).
/api/v1/ai-features/classroom-insightsClassroom Insights
attendance:viewDeclared request fields: sectionId (required).
/api/v1/ai-features/substitution-brainSubstitution Brain
timetable:viewDeclared request fields: absentStaffId (required), date (optional), apply (optional).
/api/v1/ai-features/question-bank-intelQuestion Bank Intel
exam:viewDeclared request fields: subjectId (optional), paperSize (optional).
/api/v1/ai-features/meeting-notesMeeting Notes
communication:createDeclared request fields: transcript (required), meetingType (optional).
/api/v1/ai-features/school-twin-benchmarkSchool Twin Benchmark
dashboard:view/api/v1/ai-features/policy-copilotPolicy Copilot
dashboard:viewDeclared request fields: question (required), board (optional).
/api/v1/ai-features/accreditation-packAccreditation Pack
dashboard:viewDeclared request fields: purpose (optional).
/api/v1/ai-features/branch-performanceBranch Performance
dashboard:view/api/v1/webhooks/whatsappVerify
Public/capability access as implemented/api/v1/webhooks/whatsappInbound
Public/capability access as implemented/api/v1/ai-features/whatsapp-parent-copilot/simulateSimulate
dashboard:viewDeclared request fields: from (required), text (required), replyTo (optional), dryRun (optional).
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.