Get an exam

GET

evaluation-platform

exam

{id}

Get an exam

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

import requests

url = "https://api.crazygoldfish.com/evaluation-platform/v1/exam/{id}/"

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

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

print(response.text)

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

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

{
  "id": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
  "examName": "Pre Board 1 - Science",
  "overallDuration": "180",
  "grade": 10,
  "classSection": "A",
  "subject": 1,
  "examType": 1,
  "examSet": "A",
  "documents": [
    {
      "id": "0f2a7c61-9b48-4d3e-8a15-6c7d8e9f0a1b",
      "status": 2,
      "pageNo": null,
      "uploadTime": "2026-03-18T09:14:02.481293Z",
      "url": "https://<storage-host>/media/evaluation/paper.pdf",
      "fileType": 1
    }
  ],
  "createdAt": "2026-03-18T09:12:44.113204Z",
  "modifiedAt": "2026-03-18T09:31:08.902551Z",
  "examDate": "2026-03-14",
  "isFinalPublish": false,
  "isProvisionalPublished": false,
  "status": 2
}

Use this call to follow question extraction, and to see which files an exam holds.

Reading the response

status is the question extraction status:

`status`	Meaning	What to do
`0`	Open. Nothing has been submitted.	Upload the paper, then send `isFinal`
`1`	In Progress	Wait, then check again
`2`	Completed	Call Get extracted exam questions
`3`	Failed	Send `{"isFinal": true}` again to retry

Each entry in documents carries the same four status values for that one file.

Instead of polling, register a webhook for exam_evaluation_question_paper_extraction. See Async jobs and webhooks.

Authorizations

Authorization

string

header

required

Access token from Get an access token. A missing, invalid, or expired token returns 403.

Path Parameters

string<uuid>

required

The exam id returned by Create an exam.

Example:

"d19e6868-98dd-4274-a2a5-4a616dd93ea7"

Response

The exam.

An exam with its metadata, its files, and its extraction status.

string<uuid>

The exam ID.

examName

string | null

The name you gave the exam.

overallDuration

string | null

Duration in minutes, read from the question paper. null until extraction completes.

grade

integer

Grade code, 1 to 13.

classSection

string | null

Class section, such as A.

subject

integer

Subject code.

examType

integer

Exam type code, 1 to 5.

examSet

string | null

Your label for the paper set, such as A.

documents

object[]

Show child attributes

createdAt

string<date-time>

modifiedAt

string<date-time>

examDate

string<date> | null

isFinalPublish

boolean

true once you publish the final result.

isProvisionalPublished

boolean

true once you publish the provisional result.

status

enum<integer>

Question extraction status. Wait for 2 before you create a model answer sheet.

Available options:

0,

1,

2,

3

Get an exam

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

import requests

url = "https://api.crazygoldfish.com/evaluation-platform/v1/exam/{id}/"

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

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

print(response.text)

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

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

{
  "id": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
  "examName": "Pre Board 1 - Science",
  "overallDuration": "180",
  "grade": 10,
  "classSection": "A",
  "subject": 1,
  "examType": 1,
  "examSet": "A",
  "documents": [
    {
      "id": "0f2a7c61-9b48-4d3e-8a15-6c7d8e9f0a1b",
      "status": 2,
      "pageNo": null,
      "uploadTime": "2026-03-18T09:14:02.481293Z",
      "url": "https://<storage-host>/media/evaluation/paper.pdf",
      "fileType": 1
    }
  ],
  "createdAt": "2026-03-18T09:12:44.113204Z",
  "modifiedAt": "2026-03-18T09:31:08.902551Z",
  "examDate": "2026-03-14",
  "isFinalPublish": false,
  "isProvisionalPublished": false,
  "status": 2
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Reading the response

Authorizations

Path Parameters

Response

​Reading the response

Authorizations

Path Parameters

Response

Reading the response