Get extracted assignment questions

GET

assignment-evaluation

assignment

{id}

questions

Get extracted assignment questions

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

import requests

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

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}/questions/', 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",
  "instruction": "Answer both parts in your own words.",
  "marks": 2,
  "grade": "7",
  "courseId": "300",
  "parentQuestions": [
    {
      "id": "cabb699a-ef46-447c-85d2-f320d83f9745",
      "questionNumber": "1",
      "text": "Read the passage and answer the questions.",
      "marks": 0,
      "questions": [
        {
          "id": "2edd8bfd-3616-4899-95e9-98d67489ca11",
          "questionNumber": "a",
          "text": "Why does the narrator return to the village?",
          "marks": 1,
          "diagramDescription": null
        },
        {
          "id": "9f3b7d52-4c18-4a26-8f0e-71c4a6d5b833",
          "questionNumber": "b",
          "text": "Describe the narrator's mood in your own words.",
          "marks": 1,
          "diagramDescription": null
        }
      ]
    }
  ]
}

Step 2 of 6 in Evaluate an assignment. Call it once the assignment’s status is 2 (Completed).

Questions come back in two levels. A parentQuestions entry is a group: its text holds shared material, such as a passage, and questions holds the sub-questions a student actually answers. A paper with no grouping still returns one parent per question.

This endpoint returns 400 while extraction is still running, with Assignment is not extracted yet, and 400 with Assignment processing failed, please try again! if it failed. Poll Get an assignment and read status instead of waiting on this call.

A group’s text is emptied when it repeats its only sub-question, so a parent with text: "" is normal. Marks usually sit on the sub-questions, which is why a parent often has marks: 0.

Next step

Create an assignment model answer sheet

Add the teacher’s answer key or a rubric.

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 extracted question paper.

string<uuid>

ID of the assignment.

Example:

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

assignmentName

string

Example:

"Unit 3 English essay"

instruction

string | null

Instructions the AI read from the paper.

Example:

"Answer both parts in your own words."

marks

number<float> | null

Total marks on the paper.

Example:

2

grade

string | null

Example:

"7"

courseId

string | null

Example:

"300"

parentQuestions

object[]

Question groups, in the order they appear on the paper.

Show child attributes

Get extracted assignment questions

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

import requests

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

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}/questions/', 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",
  "instruction": "Answer both parts in your own words.",
  "marks": 2,
  "grade": "7",
  "courseId": "300",
  "parentQuestions": [
    {
      "id": "cabb699a-ef46-447c-85d2-f320d83f9745",
      "questionNumber": "1",
      "text": "Read the passage and answer the questions.",
      "marks": 0,
      "questions": [
        {
          "id": "2edd8bfd-3616-4899-95e9-98d67489ca11",
          "questionNumber": "a",
          "text": "Why does the narrator return to the village?",
          "marks": 1,
          "diagramDescription": null
        },
        {
          "id": "9f3b7d52-4c18-4a26-8f0e-71c4a6d5b833",
          "questionNumber": "b",
          "text": "Describe the narrator's mood in your own words.",
          "marks": 1,
          "diagramDescription": null
        }
      ]
    }
  ]
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Get extracted assignment questions

Next step

Create an assignment model answer sheet

Authorizations

Path Parameters

Response

​Next step

Create an assignment model answer sheet

Authorizations

Path Parameters

Response

Next step