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.
You can supply a PDF using fileUrl instead of uploading via documents.
fileUrl must be a public HTTPS URL, and the URL path must end with .pdf.
Use only one of documents, fileUrl, or isFinal in a single request (do not combine them).

Scenarios:

Finalizing the Model Answer Sheet and Triggering AI Extraction:
- Teachers finalize the model answer sheet by setting isFinal to true in the PATCH API request.
- Outcome:
  - AI extracts structured data such as model answers, step-wise marking schemes, and instructions, readying them for evaluation workflows.
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, isFinal is set to true to 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

evaluation-platform

exam

{examId}

model-answer

{id}

Update model answer for an exam

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/model-answer/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form documents='@example-file' \
  --form isFinal=true \
  --form fileUrl=https://cdn.example.com/model-answer/model-answer-101.pdf

{
  "id": "287117d6-0135-4329-b5a7-d46e42948a14",
  "documents": [
    {
      "id": "10d5661d-df3a-4d22-aa58-fddfa1230040",
      "status": 1,
      "pageNo": null,
      "uploadTime": "2025-01-06T12:28:22.992639Z",
      "url": "https://cgfblob.blob.core.windows.net/ielts/evaluation/CBSE_10_Science_-_Mock_Test_A_Solutions.pdf",
      "fileType": 1
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

examId

string

required

Example:

"4340132f-50fa-4877-9ffa-e9b7ee59d51f"

string

required

Example:

"287117d6-0135-4329-b5a7-d46e42948a14"

Body

The details to update for the model answer.

documents

file

The model answer file to be uploaded.

isFinal

boolean

After successfully uploaded files pass this parameter as true for the extraction for your exam.

Example:

true

fileUrl

string<uri>

Public HTTPS URL to a PDF. Use instead of uploading documents. The URL must be publicly accessible without authentication and must end with a .pdf extension.

Example:

"https://cdn.example.com/model-answer/model-answer-101.pdf"

Response

Successful response

string

Unique identifier of the model answer

Example:

"287117d6-0135-4329-b5a7-d46e42948a14"

documents

object[]

List of documents associated with the model answer

Show child attributes

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.

Update model answer for an exam

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/model-answer/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form documents='@example-file' \
  --form isFinal=true \
  --form fileUrl=https://cdn.example.com/model-answer/model-answer-101.pdf

{
  "id": "287117d6-0135-4329-b5a7-d46e42948a14",
  "documents": [
    {
      "id": "10d5661d-df3a-4d22-aa58-fddfa1230040",
      "status": 1,
      "pageNo": null,
      "uploadTime": "2025-01-06T12:28:22.992639Z",
      "url": "https://cgfblob.blob.core.windows.net/ielts/evaluation/CBSE_10_Science_-_Mock_Test_A_Solutions.pdf",
      "fileType": 1
    }
  ]
}