Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Saurabh-07586/examplatform/llms.txt

Use this file to discover all available pages before exploring further.

This page is a complete reference for every field available when creating or editing an exam on ExamPlatform. Use it to understand what each setting controls, which fields are required, and how the evaluation workflow options interact with AI and manual review. All fields are available through the Exam Builder UI and the ExamPlatform API.

Core Exam Fields

exam_title
string
required
The display name of the exam, shown to students on the dashboard, the instructions page, and in all generated reports. Choose a clear, descriptive title that uniquely identifies the exam session.
subject
string
required
The subject this exam covers. The value must match a subject that exists in your question bank; ExamPlatform uses this to filter the available question pool when building the exam.
start_time
datetime
required
The date and time at which the exam window opens. Students cannot launch the exam before this time. Stored in ISO 8601 format and evaluated against the server clock, not the student’s local device time.
end_time
datetime
required
The date and time at which the exam window closes. Students cannot begin a new attempt after this time. Any in-progress sessions are auto-submitted when the server-side timer expires, regardless of the window closing time.
duration_minutes
integer
required
The total time a student is allowed to spend on the exam, measured in minutes. The countdown is server-controlled and starts the moment the student clicks Start Exam. See the note below for details on pause behaviour.
total_questions
integer
required
The number of questions to include from the selected subject pool. Questions are drawn according to the difficulty distribution and topic filters you configure in the question selection step.
passing_percentage
float
The minimum score percentage a student must achieve to receive a Pass result. Accepts values between 0 and 100. If this field is left blank, no pass/fail threshold is applied and only a raw score is reported.
negative_marking
boolean
default:"false"
When set to true, incorrect answers deduct marks from the student’s total score. The exact deduction per question is configured in the Question Fields section below using the negative field. Has no effect on short-answer, long-answer, or image-upload question types.
instructions
string
Custom instructions displayed on the exam instructions page before the student clicks Start Exam. Use this field to communicate rules, calculator policies, language requirements, or any exam-specific guidance. Supports plain text; HTML is not rendered.
The timer is server-controlled and cannot be paused. The exam auto-submits when time expires. This means the countdown continues running during any connectivity drop — students should ensure a stable connection and a charged device before starting.

Evaluation Workflow

These settings control how student responses are assessed after the exam window closes. AI evaluation and manual review can be used independently or in combination.
enable_ai_evaluation
boolean
When enabled, ExamPlatform’s AI engine performs a first-pass evaluation of all subjective answers (short-answer, long-answer, and image-upload) immediately after submission. AI scores are provisional — the examiner always has final say.
allow_manual_examiner_review
boolean
When enabled, assigned examiners can open individual responses, view AI-suggested scores, leave comments, and override the final grade. If this is disabled, AI scores are published directly as final grades without a review step.
route_to_manual_after_ai
boolean
When enabled, every subjective answer is automatically added to the manual review queue after the AI evaluation completes — even if the AI returned a high-confidence score. Recommended for high-stakes exams where human sign-off is required on all responses.

Question Fields Reference

These fields are set individually on each question when building or importing a question bank. They apply to all question types unless otherwise noted.
question_type
enum
required
The type of question. Accepted values:
ValueLabelDescription
mcqMCQ (single correct)Single correct answer from multiple choices
multiselectMulti-selectOne or more correct answers from multiple choices
short_answerShort answerShort free-text response, evaluated by AI and/or examiner
long_answerLong answerExtended free-text response, evaluated by AI and/or examiner
image_uploadImage uploadStudent uploads an image (e.g., a hand-drawn diagram or solved problem)
difficulty
enum
required
The difficulty level of the question. Used for difficulty-balanced question pool selection.
ValueLabelDescription
easyEasyFoundational recall or comprehension
mediumMediumApplication or analysis
hardHardSynthesis, evaluation, or complex problem-solving
marks
float
required
The number of points awarded when this question is answered correctly. Accepts decimal values (e.g., 0.5, 1.0, 2.5). Used for AI-assisted first-pass grading — the examiner always has final say.
negative
float
default:"0"
The number of points deducted for an incorrect answer. Only applies to mcq and multiselect question types, and only when negative_marking is enabled at the exam level. Set to 0 to exempt an individual question from negative marking even when the exam-level flag is on.
min_word_count
integer
The minimum number of words a student must write before they can submit this question. Applies to short_answer and long_answer types only. The exam interface shows a live word counter and prevents submission until the threshold is met.
max_word_count
integer
The maximum number of words a student is allowed to write for this question. Applies to short_answer and long_answer types only. The exam interface stops accepting input once this limit is reached.
topic
string
A topic tag used to organise questions within a subject (e.g., "Photosynthesis", "The French Revolution", "Quadratic Equations"). Topic tags drive the topic-based filtering in the question pool selector and appear in per-topic analytics reports.

Build docs developers (and LLMs) love