Upload assignment model answers or add a rubric

PATCH

assignment-evaluation

assignment

{id}

model-answer

{modelAnswerId}

cURL

# Either: upload the teacher's answer key
curl -X PATCH \
  "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d/model-answer/3b27e0be-f9e8-4c4d-977b-b315bfb292ab/" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F documents=@answer-key.pdf

# Or: attach a rubric instead (required for audio answers)
curl -X PATCH \
  "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d/model-answer/3b27e0be-f9e8-4c4d-977b-b315bfb292ab/" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F rubricId=2b973c83-2830-4712-87b7-64a8c0a99035

# Then: start model answer extraction
curl -X PATCH \
  "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d/model-answer/3b27e0be-f9e8-4c4d-977b-b315bfb292ab/" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F isFinal=true

import requests

BASE_URL = "https://api.crazygoldfish.com"
HEADERS = {"Authorization": "Bearer YOUR_ACCESS_TOKEN"}
path = (
    "/assignment-evaluation/v1/assignment/"
    "3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d/model-answer/"
    "3b27e0be-f9e8-4c4d-977b-b315bfb292ab/"
)

# Either: upload the teacher's answer key
with open("answer-key.pdf", "rb") as f:
    requests.patch(
        BASE_URL + path,
        headers=HEADERS,
        files={"documents": ("answer-key.pdf", f, "application/pdf")},
    ).raise_for_status()

# Or: attach a rubric instead (required for audio answers)
requests.patch(
    BASE_URL + path,
    headers=HEADERS,
    data={"rubricId": "2b973c83-2830-4712-87b7-64a8c0a99035"},
).raise_for_status()

# Then: start model answer extraction
requests.patch(
    BASE_URL + path, headers=HEADERS, data={"isFinal": "true"}
).raise_for_status()

const BASE_URL = "https://api.crazygoldfish.com";
const HEADERS = { Authorization: "Bearer YOUR_ACCESS_TOKEN" };
const path =
  "/assignment-evaluation/v1/assignment/3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d" +
  "/model-answer/3b27e0be-f9e8-4c4d-977b-b315bfb292ab/";

// Either: upload the teacher's answer key
const key = new FormData();
key.append("documents", answerKeyFile, "answer-key.pdf");
await fetch(BASE_URL + path, { method: "PATCH", headers: HEADERS, body: key });

// Or: attach a rubric instead (required for audio answers)
const rubric = new FormData();
rubric.append("rubricId", "2b973c83-2830-4712-87b7-64a8c0a99035");
await fetch(BASE_URL + path, { method: "PATCH", headers: HEADERS, body: rubric });

// Then: start model answer extraction
const submit = new FormData();
submit.append("isFinal", "true");
await fetch(BASE_URL + path, { method: "PATCH", headers: HEADERS, body: submit });

{
  "id": "3b27e0be-f9e8-4c4d-977b-b315bfb292ab",
  "documents": [
    {
      "id": "4a7c1e90-2b6d-4f31-9c58-0d7e3f2a1b46",
      "status": 0,
      "pageNo": null,
      "uploadTime": "2025-04-06T09:31:02.118422Z",
      "url": "https://<storage-host>/documents/assignment-evaluation/unit-3-answer-key.pdf",
      "fileType": 1,
      "audio_link": null
    }
  ],
  "rubric": {},
  "status": 0
}

Step 3 of 6 in Evaluate an assignment. Call it twice: once with the answer key or the rubric, once with isFinal to start extraction.

Rules

Send exactly one of documents, rubricId, or isFinal per request. Two or more return 400.
documents follows the same file rules as the question paper: PDF, JPEG, or PNG, up to 20 MB per file, and up to 50 pages per PDF. Send either one PDF or a set of images, never both. Some mixed uploads are rejected with 400 Cannot mix PDF files with image files and others are accepted without an error, so keep the two apart in your own code.
rubricId is the id of a rubric from Create a rubric. An unknown ID returns 404 Rubric not found.
An answer key and a rubric can both be attached, in two requests. Send isFinal last.
isFinal with neither an answer key nor a rubric returns 400 No documents found for this model answer sheet.
Each path needs its trailing slash, or the PATCH is redirected and loses its body.

Send isFinal as the text true, either in multipart/form-data or as a JSON string. A JSON boolean is not accepted here, unlike the exam API.

An assignment answered by audio must have a rubric here. Without one, submitting the audio for evaluation later fails with Rubric not found for audio evaluation.

Next step

Get an assignment model answer sheet

Poll until status is 2, or wait for the assignment_evaluation_model_answer_extraction webhook.

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"

modelAnswerId

string<uuid>

required

The model answer sheet id returned by Create an assignment model answer sheet.

Example:

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

Body

multipart/form-data

documents

file[]

The teacher's answer key: one PDF, or one or more JPEG or PNG images. The same file rules as the question paper apply: 20 MB per file, 50 pages per PDF, one PDF only, and no mixing a PDF with images.

rubricId

string<uuid>

The id of a rubric from Create a rubric. Use a rubric instead of an answer key when answers are open-ended, and always for audio answers.

Example:

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

isFinal

enum<string>

Send the text true to start model answer extraction. Send it on its own, as the text true. A JSON boolean is not accepted.

Available options:

true,

false

Example:

"true"

Response

The answer key was saved, the rubric was attached, or extraction started.

string<uuid>

ID of the model answer sheet.

Example:

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

documents

object[]

The answer key files, oldest first. Empty when you score with a rubric only.

Show child attributes

rubric

object

The rubric attached to the model answer sheet, or {} when none is attached.

Show child attributes

status

enum<integer>

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

Available options:

0,

1,

2,

3

Example:

2

cURL

# Either: upload the teacher's answer key
curl -X PATCH \
  "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d/model-answer/3b27e0be-f9e8-4c4d-977b-b315bfb292ab/" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F documents=@answer-key.pdf

# Or: attach a rubric instead (required for audio answers)
curl -X PATCH \
  "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d/model-answer/3b27e0be-f9e8-4c4d-977b-b315bfb292ab/" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F rubricId=2b973c83-2830-4712-87b7-64a8c0a99035

# Then: start model answer extraction
curl -X PATCH \
  "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d/model-answer/3b27e0be-f9e8-4c4d-977b-b315bfb292ab/" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F isFinal=true

import requests

BASE_URL = "https://api.crazygoldfish.com"
HEADERS = {"Authorization": "Bearer YOUR_ACCESS_TOKEN"}
path = (
    "/assignment-evaluation/v1/assignment/"
    "3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d/model-answer/"
    "3b27e0be-f9e8-4c4d-977b-b315bfb292ab/"
)

# Either: upload the teacher's answer key
with open("answer-key.pdf", "rb") as f:
    requests.patch(
        BASE_URL + path,
        headers=HEADERS,
        files={"documents": ("answer-key.pdf", f, "application/pdf")},
    ).raise_for_status()

# Or: attach a rubric instead (required for audio answers)
requests.patch(
    BASE_URL + path,
    headers=HEADERS,
    data={"rubricId": "2b973c83-2830-4712-87b7-64a8c0a99035"},
).raise_for_status()

# Then: start model answer extraction
requests.patch(
    BASE_URL + path, headers=HEADERS, data={"isFinal": "true"}
).raise_for_status()

const BASE_URL = "https://api.crazygoldfish.com";
const HEADERS = { Authorization: "Bearer YOUR_ACCESS_TOKEN" };
const path =
  "/assignment-evaluation/v1/assignment/3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d" +
  "/model-answer/3b27e0be-f9e8-4c4d-977b-b315bfb292ab/";

// Either: upload the teacher's answer key
const key = new FormData();
key.append("documents", answerKeyFile, "answer-key.pdf");
await fetch(BASE_URL + path, { method: "PATCH", headers: HEADERS, body: key });

// Or: attach a rubric instead (required for audio answers)
const rubric = new FormData();
rubric.append("rubricId", "2b973c83-2830-4712-87b7-64a8c0a99035");
await fetch(BASE_URL + path, { method: "PATCH", headers: HEADERS, body: rubric });

// Then: start model answer extraction
const submit = new FormData();
submit.append("isFinal", "true");
await fetch(BASE_URL + path, { method: "PATCH", headers: HEADERS, body: submit });

{
  "id": "3b27e0be-f9e8-4c4d-977b-b315bfb292ab",
  "documents": [
    {
      "id": "4a7c1e90-2b6d-4f31-9c58-0d7e3f2a1b46",
      "status": 0,
      "pageNo": null,
      "uploadTime": "2025-04-06T09:31:02.118422Z",
      "url": "https://<storage-host>/documents/assignment-evaluation/unit-3-answer-key.pdf",
      "fileType": 1,
      "audio_link": null
    }
  ],
  "rubric": {},
  "status": 0
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Upload assignment model answers or add a rubric

Rules

Next step

Get an assignment model answer sheet

Authorizations

Path Parameters

Body

Response

​Rules

​Next step

Get an assignment model answer sheet

Authorizations

Path Parameters

Body

Response

Rules

Next step