The API allows clients to upload and associate documents with an existing student assignment sheet for a specific assignment. Only one type of file format (either PDF or multiple images like JPEG) is allowed for a single assignment sheet. Mixing formats in a single assignment sheet is not permitted.
Scenarios:
Uploading PDF Document to a Student’s assignment Sheet:
Uploading Multiple JPEG Images for a Student’s assignment Sheet:
Note:
isFinal to true, the AI extraction process begins. This process may take some time to complete.documents or isFinal can be processed at a time.documents and isFinal are provided in the same request, a validation error is returned. Use either documents to upload, or isFinal to trigger extraction — not both together. Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Unique identifier of the assignment
Unique identifier of the answer sheet
Answer sheet uploaded successfully.
Unique identifier for the answer sheet.
"57387c68-0706-4a9d-834a-237b6b63cb5d"
Status of the answer sheet (refer this doc to get the constants)
0
Unique identifier of the student.
"12345"
Name of the student.
"John Doe"
Unique identifier of the batch.
"batch_1"
Unique identifier of the session.
"session_1"
List of documents associated with the assignment.