Exam Paper

PATCH - Exam

This API allows updating an existing exam. You can:

Mark an exam as final.
Upload associated documents.
Modify exam attributes such as examType.

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.

Scenario: Finalizing an Exam and Triggering AI Extraction

This API allows a teacher to finalize an exam by setting the final attribute to true using the PATCH Update Exams API.

Outcome:

Finalizing triggers the AI extraction process to analyze uploaded documents (e.g., PDFs or JPEGs) and extract key details such as questions, marks distribution, and instructions.
The extracted data is stored for workflows like grading and reporting.

Note:

After setting isFinal to true, the AI extraction process is initiated. This process may take some time to complete.
To facilitate seamless integration, we provide a webhook feature. Once the extraction is successfully completed, the system will send a notification to the configured webhook URL.
Only one of documents or isFinal can be processed at a time.

Example Workflow:

Create an exam and upload the question paper.
Finalize the exam with { "final": true }.
AI processes the content for automated and accurate extraction.
Receive a webhook notification upon successful extraction completion.

PATCH

evaluation-platform

exam

{id}

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form grade=12 \
  --form subject=1 \
  --form examType=1 \
  --form examSet=C \
  --form examDate=2023-12-25 \
  --form classSection=A \
  --form isFinal=true

{
  "examId": "4340132f-50fa-4877-9ffa-e9b7ee59d51f",
  "documents": [
    {
      "id": "628f10af-59b5-44f2-b27a-fdf30d254fd5",
      "status": 0,
      "pageNo": null,
      "uploadTime": "2025-01-02T11:03:30.034720Z",
      "url": "https://cgfblob.blob.core.windows.net/ielts/evaluation/CBSE_10_Maths_-_Mock_Test_A_SjFa0sA.pdf",
      "fileType": 1
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Example:

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

Body

multipart/form-data

The details to update for the exam paper.

documents

file

The exam paper file to be uploaded.

grade

integer

The class the exam paper belongs to.

Example:

12

subject

integer

The subject of the exam paper.

Example:

1

examType

integer

The type of the exam.

Example:

1

examSet

string

The set of the exam.

Example:

"C"

examDate

string

Date of the exam (should be in the format format - 'YYYY-MM-DD')

classSection

string

The section of the class.

Example:

"A"

isFinal

boolean

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

Example:

true

Response

200

application/json

Successfully updated exam details.

examId

string

The unique identifier for the updated exam.

Example:

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

documents

object[]

Details of the documents attached to the exam.

Example:

[
  {
    "id": "628f10af-59b5-44f2-b27a-fdf30d254fd5",
    "status": 0,
    "pageNo": null,
    "uploadTime": "2025-01-02T11:03:30.034720Z",
    "url": "https://cgfblob.blob.core.windows.net/ielts/evaluation/CBSE_10_Maths_-_Mock_Test_A_SjFa0sA.pdf",
    "fileType": 1
  }
]

POST - Exam GET - Exam Detail

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form grade=12 \
  --form subject=1 \
  --form examType=1 \
  --form examSet=C \
  --form examDate=2023-12-25 \
  --form classSection=A \
  --form isFinal=true

{
  "examId": "4340132f-50fa-4877-9ffa-e9b7ee59d51f",
  "documents": [
    {
      "id": "628f10af-59b5-44f2-b27a-fdf30d254fd5",
      "status": 0,
      "pageNo": null,
      "uploadTime": "2025-01-02T11:03:30.034720Z",
      "url": "https://cgfblob.blob.core.windows.net/ielts/evaluation/CBSE_10_Maths_-_Mock_Test_A_SjFa0sA.pdf",
      "fileType": 1
    }
  ]
}

Authentication

K12

Assessment Rubrics

Standardized Language Exams

PATCH - Exam

Authorizations

Path Parameters

Body

Response