Skip to main content
POST
Create an assignment answer sheet
Step 4 of 6 in Evaluate an assignment. Call it once per student, and save the id it returns.

Rules

  • The assignment’s status and its model answer sheet’s status must both be 2 (Completed). Otherwise this returns 400 with Assignment is not extracted yet or Model answer sheet is not extracted yet.
  • studentId and name are required. batchId, sessionId, and teacherId are optional, and CrazyGoldFish stores and returns them unchanged.
  • studentId and teacherId hold up to 50 characters. name, batchId, and sessionId hold up to 200. A longer value returns a 500.
  • Nothing stops you creating two sheets for the same student, so keep your own record of the id you use.
  • A successful call returns 201, not 200.

Add your own metadata

Send additionalInfo to keep your own details on the answer sheet, such as a roll number, an attempt count, or the app the answer came from. CrazyGoldFish stores the object and returns it with the sheet.
  • additionalInfo must be a JSON object with at most 5 keys. A sixth key returns 400 additionalInfo cannot have more than 5 keys. Anything other than an object returns 400 additionalInfo must be a JSON object.
  • Only the top-level keys are counted. A value can be text, a number, a boolean, a list, or another object.
  • Leave the field out when you have nothing to send. null returns 400.
  • The key questionId is reserved, and counts toward the 5. It must be the id of a question on this assignment, taken from parentQuestions[].questions[] in Get extracted assignment questions. A value that is not a UUID returns 400, and a UUID that is not a question on this assignment returns 404 Question not found.
  • For an audio answer, questionId names the question the recording answers, and the AI grades the recording against that question. It does not change how a written answer is graded.
  • To change the metadata later, send additionalInfo again when you submit the answer sheet. The new object replaces the old one.

Next step

Submit an assignment answer sheet for evaluation

Add the student’s answer as documents or as an audio link, then start evaluation.

Authorizations

Authorization
string
header
required

Access token from Get an access token.

Path Parameters

id
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"

Body

application/json
studentId
string
required

Your own ID for the student. Also a filter on List assignment answer sheets.

Maximum string length: 50
Example:

"STU-10432"

name
string
required

The student's name.

Maximum string length: 200
Example:

"Aarav Sharma"

batchId
string

Your own ID for the batch. Stored and returned unchanged.

Maximum string length: 200
Example:

"BATCH-7A"

sessionId
string

Your own ID for the academic session. Stored and returned unchanged.

Maximum string length: 200
Example:

"2025-26"

teacherId
string

Your own ID for the teacher. Also a filter on List assignment answer sheets.

Maximum string length: 50
Example:

"TEA-204"

additionalInfo
object

Your own metadata for this answer sheet, as a JSON object with up to 5 keys. Stored and returned unchanged. Leave the field out when you have nothing to send: null returns 400. The key questionId is reserved.

Example:

Response

The answer sheet was created. Its status is 0 (Open) until you submit an answer.

id
string<uuid>

ID of the answer sheet.

Example:

"6e1d2c3b-4a5f-4e6d-8c7b-9a0f1e2d3c4b"

status
enum<integer>

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

Available options:
0,
1,
2,
3
Example:

2

batchId
string | null
Example:

"BATCH-7A"

sessionId
string | null
Example:

"2025-26"

studentId
string
Example:

"STU-10432"

name
string | null
Example:

"Aarav Sharma"

teacherId
string | null
Example:

"TEA-204"

additionalInfo
object | null

The metadata you sent as additionalInfo, with up to 5 keys. null when you sent none.

Example:
documents
object[]

The student's answer: uploaded files, or one audio link.