PATCH - Update Model Answer

This API allows authenticated users to update an existing model answer by either attaching rubric-based evaluation criteria or uploading supporting documents.

Key Parameters:

assignmentId (path param, required): Unique ID of the assignment.
userType (form-data, required): Role of the user submitting the model answer (e.g., 1 for teacher).
rubricId (form-data, optional): The unique ID of the rubric used for evaluation or you can refer this doc to get the rubricId.
isFinal (form-data, optional): Pass true if this is the final model answer being submitted for evaluation.
documents[] (form-data, optional): Uploads related documents such as reference material or answer sheets.

Behavior:

You must only pass one of these at a time: documents, rubricId, or isFinal.
If isFinal=true, the model answer sheet will be sent for evaluation.
You can either upload documents or provide a rubricId in a single request — not both. This is to ensure clarity in what part of the model answer you’re updating.

PATCH

assignment-evaluation

assignment

{id}

model-answer

{modelAnswerId}

Update Assignment Model Answer

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/model-answer/{modelAnswerId}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form userType=1 \
  --form rubricId=2b973c83-2830-4712-87b7-64a8c0a99035 \
  --form isFinal=true \
  --form 'documents=<string>' \
  --form documents.items='@example-file'

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

Path Parameters

string

required

Unique identifier of the assignment

modelAnswerId

string

required

Unique identifier of the model answer

Body

multipart/form-data

userType

string

Numeric type representing the role of the user.

Example:

"1"

rubricId

string

Unique ID of the rubric to associate with the model answer sheet or you can refer this doc to get the rubricId

Example:

"2b973c83-2830-4712-87b7-64a8c0a99035"

isFinal

enum<string>

Flag to trigger evaluation if set to 'true'. Only one of documents, rubricId, or isFinal is allowed.

Available options:

true,

false

Example:

"true"

documents

file[]

List of model answer sheet documents to upload (if any).

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 (refer this doc to get the constants)

Example:

1

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.) <Tip> 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](/api-reference/endpoint/webhook/v1-get-webhook-template). </Tip>

⌘I

Update Assignment Model Answer

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/model-answer/{modelAnswerId}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form userType=1 \
  --form rubricId=2b973c83-2830-4712-87b7-64a8c0a99035 \
  --form isFinal=true \
  --form 'documents=<string>' \
  --form documents.items='@example-file'

{
  "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
}

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

PATCH - Update Model Answer

Key Parameters:

Behavior:

Authorizations

Path Parameters

Body

Response