Create an assignment answer sheet
Create an answer sheet for one student on an assignment, and get the ID used to submit their answer.
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
statusand its model answer sheet’sstatusmust both be2(Completed). Otherwise this returns400withAssignment is not extracted yetorModel answer sheet is not extracted yet. studentIdandnameare required.batchId,sessionId, andteacherIdare optional, and CrazyGoldFish stores and returns them unchanged.studentIdandteacherIdhold up to 50 characters.name,batchId, andsessionIdhold up to 200. A longer value returns a500.- Nothing stops you creating two sheets for the same student, so keep your own record of the
idyou use. - A successful call returns
201, not200.
Add your own metadata
SendadditionalInfo 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.
additionalInfomust be a JSON object with at most 5 keys. A sixth key returns400additionalInfo cannot have more than 5 keys. Anything other than an object returns400additionalInfo 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.
nullreturns400. - The key
questionIdis reserved, and counts toward the 5. It must be theidof a question on this assignment, taken fromparentQuestions[].questions[]in Get extracted assignment questions. A value that is not a UUID returns400, and a UUID that is not a question on this assignment returns404Question not found. - For an audio answer,
questionIdnames 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
additionalInfoagain 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
Access token from Get an access token.
Path Parameters
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
Your own ID for the student. Also a filter on List assignment answer sheets.
Maximum string length:
50Example:
"STU-10432"
Your own ID for the teacher. Also a filter on List assignment answer sheets.
Maximum string length:
50Example:
"TEA-204"
Response
The answer sheet was created. Its status is 0 (Open) until you submit an answer.