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:

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

GET

evaluation-platform

exam

{examId}

model-answer

Retrieve model answer for an exam

curl --request GET \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/model-answer/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/model-answer/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/model-answer/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/model-answer/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/model-answer/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/model-answer/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "287117d6-0135-4329-b5a7-d46e42948a14",
  "documents": [
    {
      "id": "10d5661d-df3a-4d22-aa58-fddfa1230040",
      "status": 2,
      "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
    }
  ]
}

{
  "detail": "Token has expired"
}

{
  "error:": {
    "code": 400,
    "message": {
      "non_field_errors": [
        "Model Answer not found"
      ]
    }
  }
}

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"

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 - Extracted Model Answer The GET Model Answer Sheet Answers API allows clients to retrieve the detailed structure of the answers provided in the model answer sheet for a specific exam. This includes: - Exam-level metadata such as total marks, duration, and instructions. - Sections of the exam with parent and sub-questions. - Model answers and their step-wise marking schemes. **Scenarios:** 1. **Reviewing AI-Extracted Model Answers and Mapping:** - Teachers use this API to validate AI-extracted model answers and their mapping to the corresponding exam questions. - **Outcome:** - The API provides exam metadata (e.g., total marks, duration), section-wise breakdowns, and model answers with marking schemes. - Teachers ensure the structure is accurate and ready for evaluation. 2. **Verifying Step-Wise Marking for Evaluation:** - Content moderators review step-wise marking schemes to confirm alignment with the provided answers. - **Outcome:** - The API delivers detailed model answers and marks allocated for individual steps in multi-part answers. - Moderators ensure fair and accurate marking schemes, facilitating consistent evaluation by graders. <Tip> Want to receive automatic notifications when model answer sheets are processed? Set up webhooks to get real-time updates on model answer extraction. Check out the [Webhooks](/api-reference/endpoint/webhook/v1-get-webhook-template). </Tip>

Retrieve model answer for an exam

curl --request GET \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/model-answer/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/model-answer/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/model-answer/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/model-answer/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/model-answer/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/model-answer/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "287117d6-0135-4329-b5a7-d46e42948a14",
  "documents": [
    {
      "id": "10d5661d-df3a-4d22-aa58-fddfa1230040",
      "status": 2,
      "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
    }
  ]
}

{
  "detail": "Token has expired"
}

{
  "error:": {
    "code": 400,
    "message": {
      "non_field_errors": [
        "Model Answer not found"
      ]
    }
  }
}

Overview

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

GET - Model Answer

Authorizations

Path Parameters

Response