Upload an assignment question paper
Upload the question paper to an assignment, update its details, or start AI question extraction.
isFinal to start extraction.Rules
- Send
documentsorisFinalor metadata fields.documentsandisFinaltogether return400. - Files must be
multipart/form-data. Use PDF, JPEG, or PNG. 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.
- Every file is checked for readability. A blurred photo is rejected, so capture it again and upload it again.
- Send
isFinalas the texttrueonly after the files are uploaded. It starts extraction and movesstatusto1(In Progress). - Each path needs its trailing slash. Without it, the API redirects the request and the
PATCHloses its body.
400 with Rate limit exceeded. You can only send <limit> requests per day. The count resets shortly after midnight, server time, and every request counts, including rejected ones.Next step
Get an assignment
status is 2, or wait for the assignment_evaluation_question_paper_extraction 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"
Body
Question paper files: one PDF, or one or more JPEG or PNG images. Up to 20 MB per file, and up to 50 pages per PDF. Only one PDF per assignment, and a PDF cannot be mixed with images. You can upload images across several requests. Accepted only while the assignment's status is 0 (Open).
Response
The files were saved, or extraction started. After isFinal, status is 1 (In Progress).