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 isFinal=true

{
  "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
    }
  ]
}

Model Answer Sheet

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 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.

Note:

Once isFinal is set to true, the AI extraction process begins, which may take time.
To support seamless integration, a webhook feature is available. Upon successful extraction, the system sends a notification to the configured webhook URL.
Only one of documents or isFinal can be processed at a time.

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 isFinal=true

{
  "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

multipart/form-data

The details to update for the model answer.

The body is of type object.

Response

200

application/json

Successful response

The response is of type object.

POST - Model Answer GET - Model Answer

Authentication

K12

Assessment Rubrics

Standardized Language Exams

PATCH - Model Answer

Authorizations

Path Parameters

Body

Response