Submit an assignment answer sheet for evaluation
Add a student’s answer to an answer sheet as documents or as a public audio link, then send it for AI evaluation.
isFinal to start evaluation.Rules
- Send one of
documents,link, orisFinalper request. An answer sent together withisFinalreturns400, anddocumentswithlinkreturns400. - One answer sheet takes one kind of answer: files or one audio link. Do not mix them.
isFinalstarts evaluation and movesstatusto1(In Progress). Sending it with no answer on the sheet returns400No documents/link found for this answer sheet.- A sheet that is already
2(Completed) returns400Answer sheet is already extracted. Create a new sheet to grade the answer again. - Each path needs its trailing slash, or the
PATCHis redirected and loses its body. additionalInforeplaces the metadata stored on the sheet. It is not merged, so send the whole object, as a JSON string inmultipart/form-data. Leave it out to keep what is stored. It takes at most 5 keys, as on Create an assignment answer sheet.
Answers as documents
- Use PDF, JPEG, or PNG, sent as
multipart/form-data. Most other types return400Invalid file type, but the Word.docxtype passes the file-type check, so do not send one by accident. - Up to 20 MB per file, and up to 50 pages per PDF.
- Send either one PDF or a set of images, never both. Images can arrive across several requests. Some mixed uploads are rejected with
400Cannot mix PDF files with image filesand others are accepted without an error, so keep the two apart in your own code. - Every file is checked for readability. A file that does not pass is rejected with
400Blurred image, Please try to capture the image again. The same message is returned when the readability check itself cannot be completed, so if a clear file keeps failing, retry in a few minutes before re-taking the photo.
Answers as an audio link
linkmust be an HTTPS URL. HTTP,localhost, and private network addresses are rejected.- The URL must be publicly reachable without a login. CrazyGoldFish checks it while your request runs, and follows redirects.
- The URL must end in
.mp3, with no query string after it. Signed or SAS-token URLs are rejected. - The recording must be within the maximum length allowed for your account. A longer one is rejected as you submit the link, and the message gives its length and the maximum.
- The assignment’s model answer sheet must have a rubric. Without one,
isFinalreturns400Rubric not found for audio evaluation. - Only the first link is kept. A second link is still checked against every rule above, so an invalid one returns
400. A valid second link is accepted with200and then ignored, so it never replaces the first.
Evaluation limits
isFinal call counts toward the limit, including calls that are then rejected. Wait for the limit to reset, then send isFinal again.
Next step
Get an evaluated assignment score
status is 2, or wait for the assignment_evaluation_student_answer_sheet_evaluation webhook.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.
"3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d"
The answer sheet id returned by Create an assignment answer sheet.
"6e1d2c3b-4a5f-4e6d-8c7b-9a0f1e2d3c4b"
Body
Public HTTPS URL of an .mp3 recording of the student's answer. Use instead of documents. The URL must be reachable without a login, must end in .mp3 with no query string after it, and the recording must be within the maximum length CrazyGoldFish allows. Only the first link is kept per answer sheet. A later link is still checked against every rule above, so an invalid one returns 400; a valid one is accepted with 200 and then ignored. The assignment's model answer sheet must have a rubric.
"https://cdn.example.com/recordings/student-10432.mp3"
Replaces the additionalInfo on this answer sheet. Send the whole object as a JSON string, with up to 5 keys. It is not merged with what is already stored. Leave the field out to keep the stored value. The key questionId is reserved: it must be the id of a question on this assignment.
"{\"rollNumber\": \"27\", \"attempt\": 3, \"source\": \"mobile-app\"}"
Response
The answer was saved, or evaluation started. After isFinal, status is 1 (In Progress).