POST - Assignment

This API allows authenticated users to create a new assignment by providing essential details like assignment name, institute info, and class metadata.

Key Notes:

assignmentName (required): The title of the assignment.
parentInstituteId, instituteId, courseId: Help link the assignment to the correct organizational hierarchy.
grade and section: Specify the targeted academic group for the assignment.

Scenario: Creating an Assignment for Grade 8 - Section B

A teacher wants to assign a new English essay task to Grade 8 students of Section B.
They send a POST request with all necessary metadata.
Upon success, the assignment is created and returns an ID, ready for document uploads and evaluation.

POST

assignment-evaluation

assignment

Create Assignment

curl --request POST \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assignmentName": "English Assignment",
  "parentInstituteId": "101",
  "instituteId": "202",
  "courseId": "303",
  "grade": "8",
  "section": "B"
}
'

{
  "id": "2600413f-7c6e-46ef-8ea9-3e7b5834879f",
  "documents": []
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

assignmentName

string

required

Name of the assignment

Example:

"English Assignment"

parentInstituteId

string

ID of the parent institute

Example:

"101"

instituteId

string

ID of the institute

Example:

"202"

courseId

string

ID of the course

Example:

"303"

grade

string

Grade of the assignment

Example:

"8"

section

string

Section of the assignment

Example:

"B"

Response

Assignment created successfully.

string

Unique identifier for the assignment

Example:

"2600413f-7c6e-46ef-8ea9-3e7b5834879f"

documents

array

Example:

[]

PATCH - Assignment This API allows authenticated users to update an existing assignment by modifying its details or uploading assignment documents. **Key Notes:** - `id` (required in path): Unique identifier of the assignment to be updated. - Request body accepts `multipart/form-data` for file uploads. - You can update metadata like `assignmentName`, `grade`, `section`, or upload a document file using the `documents` field. - Use the `isFinal` flag to signal that the document upload is complete, which will trigger document extraction. **Scenario: Uploading the Final Document** - A teacher updates the assignment by uploading the final assignment PDF and setting `isFinal` to `true`. - This flags the system to begin extracting content from the uploaded file. <Danger> If both `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**. </Danger>

Create Assignment

curl --request POST \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assignmentName": "English Assignment",
  "parentInstituteId": "101",
  "instituteId": "202",
  "courseId": "303",
  "grade": "8",
  "section": "B"
}
'

{
  "id": "2600413f-7c6e-46ef-8ea9-3e7b5834879f",
  "documents": []
}

Documentation Index

Authorizations

Body

Response