PATCH - Model Answer
The API allows updating an existing model answer sheet for an exam. This API is used to:
- Add or replace associated documents for the model answer sheet.
- Update the isFinal status of the model answer sheet..
Key Notes:
- Only one type of document (pdf and jpeg) can be uploaded for an exam
- For jpeg files, multiple images can be uploaded sequentially, one at a time.
Scenarios:
-
Finalizing the Model Answer Sheet and Triggering AI Extraction:
- Teachers finalize the model answer sheet by setting
isFinaltotruein the PATCH API request. - Outcome:
- AI extracts structured data such as model answers, step-wise marking schemes, and instructions, readying them for evaluation workflows.
- Teachers finalize the model answer sheet by setting
-
Sequential Upload of JPEG Documents:
- For handwritten model answer sheets, teachers upload JPEG images one at a time via the API.
- After uploading all images,
isFinalis set totrueto initiate AI extraction. - Outcome:
- AI processes the images, extracting structured content for evaluation.
Example Workflow:
-
The teacher uploads a model answer document (PDF or JPEG) via this API.
-
Calls the API with
{ "isFinal": true }to trigger AI extraction. -
The extracted content is reviewed and used for grading purposes.
If both
documents and isFinal are provided in the same request, a validation error is returned. Use either documents to upload, or isFinal to trigger extraction — not both together. PATCH
Update model answer for an exam
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Example:
"4340132f-50fa-4877-9ffa-e9b7ee59d51f"
Example:
"287117d6-0135-4329-b5a7-d46e42948a14"
Body
multipart/form-data
The details to update for the model answer.
Previous
GET - Model Answer The retrieves details about the model answer sheet for a specific exam, including its metadata and associated documents. These documents can either be:
- A single PDF file, or
- Multiple images (JPEG), each with a specific sequence.
This API is useful for viewing, downloading, or validating model answer sheet documents.
**Scenarios:**
1. **Viewing Model Answer Sheet Details:**
- A teacher uses this API to review the details of the model answer sheet.
- **Outcome:**
- Retrieves a list of associated documents (PDF or sequential JPEGs).
- Provides a clear overview of the uploaded model answer sheet, including its structure and status.
2. **Validating Uploaded Documents:**
- A content moderator verifies whether the uploaded model answer sheet documents are complete and in the correct format.
- **Outcome:**
- Provides file type (PDF or JPEG).
- Displays file names and sequences for JPEGs.
Next
Update model answer for an exam