Get an assignment

GET

assignment-evaluation

assignment

{id}

Get an assignment

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

import requests

url = "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/{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/assignment-evaluation/v1/assignment/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d",
  "assignmentName": "Unit 3 English essay",
  "status": 2,
  "grade": "7",
  "marks": 2,
  "section": "A",
  "parentInstituteId": "100",
  "instituteId": "200",
  "courseId": "300",
  "documents": [
    {
      "id": "bec0d0bf-fff6-40de-9750-65f5dcaf470d",
      "status": 2,
      "pageNo": null,
      "uploadTime": "2025-04-06T09:04:11.716434Z",
      "url": "https://<storage-host>/documents/assignment-evaluation/unit-3-question-paper.pdf",
      "fileType": 1,
      "audio_link": null
    }
  ],
  "createdAt": "2025-04-06T09:03:42.099207Z",
  "modifiedAt": "2025-04-06T09:06:19.351379Z"
}

Step 2 of 6 in Evaluate an assignment. Poll this call every 5 seconds until status is 2 (Completed).

Reading the response

`status`	Meaning	What to do
`0`	Open	Upload the question paper, then send `isFinal`
`1`	In Progress	The AI is reading the paper. Poll again.
`2`	Completed	Get the extracted questions
`3`	Failed	The AI could not read the paper. Create a new assignment and upload clearer files.

marks stays null until extraction completes, then holds the total marks the AI read from the paper.

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

Next step

Get extracted assignment questions

Read the questions the AI found, with their marks.

Authorizations

Authorization

string

header

required

Access token from Get an access token.

Path Parameters

string<uuid>

required

The assignment id returned by Create an assignment. Use it exactly as returned: the lowercase form is the only one the nested paths accept.

Example:

"3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d"

Response

The assignment.

string<uuid>

ID of the assignment.

Example:

"3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d"

assignmentName

string

Name of the assignment.

Example:

"Unit 3 English essay"

status

enum<integer>

0 Open, 1 In Progress, 2 Completed, 3 Failed.

Available options:

0,

1,

2,

3

Example:

2

grade

string | null

Grade or class.

Example:

"7"

marks

number<float> | null

Total marks the AI read from the question paper. null until questions are extracted.

Example:

2

section

string | null

Section or division.

Example:

"A"

parentInstituteId

string | null

Your own ID for the parent institute.

Example:

"100"

instituteId

string | null

Your own ID for the school or institute.

Example:

"200"

courseId

string | null

Your own ID for the course.

Example:

"300"

documents

object[]

The question paper files, oldest first.

Show child attributes

createdAt

string<date-time>

Example:

"2025-04-06T09:03:42.099207Z"

modifiedAt

string<date-time>

Example:

"2025-04-06T09:06:19.351379Z"

Get an assignment

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

import requests

url = "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/{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/assignment-evaluation/v1/assignment/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d",
  "assignmentName": "Unit 3 English essay",
  "status": 2,
  "grade": "7",
  "marks": 2,
  "section": "A",
  "parentInstituteId": "100",
  "instituteId": "200",
  "courseId": "300",
  "documents": [
    {
      "id": "bec0d0bf-fff6-40de-9750-65f5dcaf470d",
      "status": 2,
      "pageNo": null,
      "uploadTime": "2025-04-06T09:04:11.716434Z",
      "url": "https://<storage-host>/documents/assignment-evaluation/unit-3-question-paper.pdf",
      "fileType": 1,
      "audio_link": null
    }
  ],
  "createdAt": "2025-04-06T09:03:42.099207Z",
  "modifiedAt": "2025-04-06T09:06:19.351379Z"
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Reading the response

Next step

Get extracted assignment questions

Authorizations

Path Parameters

Response

​Reading the response

​Next step

Get extracted assignment questions

Authorizations

Path Parameters

Response

Reading the response

Next step