PATCH - Student Assignment Sheet

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:
- The teacher provides the assignment Sheet ID and uploads a PDF.
- Outcome:
  - The student’s scanned assignment sheet is successfully uploaded in PDF format, replacing the placeholder document.
Uploading Multiple JPEG Images for a Student’s assignment Sheet:
- A student’s handwritten assignment sheet is scanned in parts and saved as multiple JPEG images.
- The teacher uploads each image sequentially using the same assignment Sheet ID.
- Outcome:
  - All images are uploaded, completing the student’s assignment sheet and associating them for grading.

Note:

After setting isFinal to true, the AI extraction process begins. This process may take some time to complete.
To streamline workflows, the system supports a webhook feature. Upon successful extraction, a notification is sent to the configured webhook URL.
Only one of documents or isFinal can be processed at a time.

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.

PATCH

assignment-evaluation

assignment

{id}

answer-sheet

{assignmentSheetId}

Update Assignment Answer Sheet

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'documents=<string>' \
  --form isFinal=true \
  --form documents.items='@example-file'

import requests

url = "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/"

files = { "documents.items": ("example-file", open("example-file", "rb")) }
payload = {
    "documents": "<string>",
    "isFinal": "true"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.patch(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('documents', '<string>');
form.append('isFinal', 'true');
form.append('documents.items', '{
  "fileName": "example-file"
}');

const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": "57387c68-0706-4a9d-834a-237b6b63cb5d",
  "status": 0,
  "studentId": "12345",
  "name": "John Doe",
  "batchId": "batch_1",
  "sessionId": "session_1",
  "documents": [
    {
      "id": "bec0d0bf-fff6-40de-9750-65f5dcaf470d",
      "status": 1,
      "pageNo": 1,
      "uploadTime": "2025-04-06T09:04:11.716434Z",
      "url": "https://cgfblob.blob.core.windows.net/documents/assignment-evaluation/olfactory_imagery_HW_PDF_2_questions_1_H7dPCAd.pdf",
      "fileType": 1
    }
  ]
}

{
  "error": {
    "code": 400,
    "message": {
      "non_field_errors": [
        "Only one of documents, or isFinal can be provided"
      ]
    }
  }
}

{
  "detail": "Token has expired"
}

{
  "error": {
    "code": 404,
    "message": {
      "non_field_errors": [
        "Assignment is not found"
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Unique identifier of the assignment

assignmentSheetId

string

required

Unique identifier of the answer sheet

Body

multipart/form-data

documents

file[]

List of answer sheet documents to upload (if any).

isFinal

boolean

Flag to trigger evaluation if set to 'true'. Only one of documents, or isFinal is allowed.

Example:

true

Response

Answer sheet uploaded successfully.

string<uuid>

Unique identifier for the answer sheet.

Example:

"57387c68-0706-4a9d-834a-237b6b63cb5d"

status

integer

Status of the answer sheet (refer this doc to get the constants)

Example:

0

studentId

string

Unique identifier of the student.

Example:

"12345"

name

string

Name of the student.

Example:

"John Doe"

batchId

string | null

Unique identifier of the batch.

Example:

"batch_1"

sessionId

string | null

Unique identifier of the session.

Example:

"session_1"

documents

object[]

List of documents associated with the assignment.

Show child attributes

Update Assignment Answer Sheet

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'documents=<string>' \
  --form isFinal=true \
  --form documents.items='@example-file'

import requests

url = "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/"

files = { "documents.items": ("example-file", open("example-file", "rb")) }
payload = {
    "documents": "<string>",
    "isFinal": "true"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.patch(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('documents', '<string>');
form.append('isFinal', 'true');
form.append('documents.items', '{
  "fileName": "example-file"
}');

const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": "57387c68-0706-4a9d-834a-237b6b63cb5d",
  "status": 0,
  "studentId": "12345",
  "name": "John Doe",
  "batchId": "batch_1",
  "sessionId": "session_1",
  "documents": [
    {
      "id": "bec0d0bf-fff6-40de-9750-65f5dcaf470d",
      "status": 1,
      "pageNo": 1,
      "uploadTime": "2025-04-06T09:04:11.716434Z",
      "url": "https://cgfblob.blob.core.windows.net/documents/assignment-evaluation/olfactory_imagery_HW_PDF_2_questions_1_H7dPCAd.pdf",
      "fileType": 1
    }
  ]
}

{
  "error": {
    "code": 400,
    "message": {
      "non_field_errors": [
        "Only one of documents, or isFinal can be provided"
      ]
    }
  }
}

{
  "detail": "Token has expired"
}

{
  "error": {
    "code": 404,
    "message": {
      "non_field_errors": [
        "Assignment is not found"
      ]
    }
  }
}

Overview

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

PATCH - Student Assignment Sheet

Authorizations

Path Parameters

Body

Response