Skip to main content
POST
Create an assignment
Step 1 of 6 in Evaluate an assignment. This call returns the assignment id. Save it: every later call uses it.

Rules

  • assignmentName is the only required field.
  • parentInstituteId, instituteId, courseId, and section are your own IDs. CrazyGoldFish stores them and returns them unchanged.
  • grade is sent to the AI as the student level. If you leave it out, the AI is told 10th.
  • No files are uploaded here. Upload the question paper in the next step.
  • Keep every value within its length limit: 200 characters for each field on this call.
The path needs its trailing slash. Without it, the API redirects the request and the POST loses its body.

Next step

Upload an assignment question paper

Upload the question paper, then start question extraction.

Authorizations

Authorization
string
header
required

Access token from Get an access token.

Body

application/json
assignmentName
string
required

Name of the assignment.

Maximum string length: 200
Example:

"Unit 3 English essay"

parentInstituteId
string

Your own ID for the parent institute. Stored and returned unchanged.

Maximum string length: 200
Example:

"100"

instituteId
string

Your own ID for the school or institute. Stored and returned unchanged.

Maximum string length: 200
Example:

"200"

courseId
string

Your own ID for the course. Stored and returned unchanged.

Maximum string length: 200
Example:

"300"

grade
string

Grade or class. Sent to the AI as the student level, and defaults to 10th when you leave it out.

Maximum string length: 200
Example:

"7"

section
string

Section or division.

Maximum string length: 200
Example:

"A"

Response

The assignment was created.

id
string<uuid>

ID of the new assignment. Save it: every later call uses it.

Example:

"3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d"

documents
object[]

Always empty here. Upload the question paper with a PATCH.