GET - Assignment Model Answer

This API fetches the detailed model answer sheet for a given assignment ID. The response includes rubric data, document links (if any), and status indicators.

Path Parameter:

id (required): The unique identifier of the model answer sheet.

Response Includes:

id: Model answer sheet ID.
documents[]: List of any uploaded documents (usually empty if only rubric is used).
rubric: Rubric details used for evaluation
rubricCriteria: Each evaluation criterion (e.g., Clarity, Creativity).
scoringLogic: Explanation of scores from 1 to 5 for each criterion.
status: Evaluation status (e.g., 1 = In Progress, 2 = Extracted, etc.)

Want to receive automatic notifications when assignment model answer sheet is processed? Set up webhooks to get real-time updates on assignment model answer sheet extraction. Check out the Webhooks.

GET

assignment-evaluation

assignment

{id}

model-answer

cURL

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

{
  "id": "3b27e0be-f9e8-4c4d-977b-b315bfb292ab",
  "documents": [],
  "rubric": {
    "id": "2b973c83-2830-4712-87b7-64a8c0a99035",
    "name": "English Rubrics",
    "description": null,
    "rubricCriteria": [
      {
        "id": "d102b0ff-1111-4235-b8e9-764ef03c57cb",
        "name": "Confidence & fluency in speaking",
        "description": "",
        "maxScore": "5 Star",
        "minScore": "1 Star",
        "scoringLogic": [
          {
            "score": "5 Star",
            "scoringLogic": "Speaking: Reflects poise & confidence. Great body language, eye contact."
          }
        ],
        "createdAt": "2023-10-01T12:00:00Z",
        "modifiedAt": "2023-10-01T12:00:00Z"
      }
    ],
    "createdAt": "2023-10-01T12:00:00Z",
    "modifiedAt": "2023-10-01T12:00:00Z"
  },
  "status": 1
}

Authorizations

Authorization

string

header

required

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

Response

Model answer sheet updated successfully.

string<uuid>

Unique identifier for the model answer sheet.

Example:

"3b27e0be-f9e8-4c4d-977b-b315bfb292ab"

documents

object[]

List of documents associated with the model answer sheet.

Example:

[]

rubric

object

Show child attributes

status

integer

Status of the model answer sheet.

Example:

1

GET - Extracted Model Answer This API allows authenticated users to retrieve the model answer details of a specific assignment. The model answer may include associated documents, rubric information, and a hierarchical question structure with individual model answers per question. ### Key Parameters: - **assignmentId** (`path param`, required): The unique ID of the assignment for which the model answer is requested. ### Response Includes: - `assignmentName`: Title of the assignment. - `courseId`, `grade`: Educational context of the assignment. - `parentQuestions[]`: A list of question groups, each containing sub-questions. - For each question: - `text`, `questionNumber`, `marks` - `modelAnswer`: ID, linked rubric, step marking (if any), etc.

cURL

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

{
  "id": "3b27e0be-f9e8-4c4d-977b-b315bfb292ab",
  "documents": [],
  "rubric": {
    "id": "2b973c83-2830-4712-87b7-64a8c0a99035",
    "name": "English Rubrics",
    "description": null,
    "rubricCriteria": [
      {
        "id": "d102b0ff-1111-4235-b8e9-764ef03c57cb",
        "name": "Confidence & fluency in speaking",
        "description": "",
        "maxScore": "5 Star",
        "minScore": "1 Star",
        "scoringLogic": [
          {
            "score": "5 Star",
            "scoringLogic": "Speaking: Reflects poise & confidence. Great body language, eye contact."
          }
        ],
        "createdAt": "2023-10-01T12:00:00Z",
        "modifiedAt": "2023-10-01T12:00:00Z"
      }
    ],
    "createdAt": "2023-10-01T12:00:00Z",
    "modifiedAt": "2023-10-01T12:00:00Z"
  },
  "status": 1
}

Documentation Index

Authorizations

Response