 This API allows authenticated users to **retrieve the details of a specific assignment** by providing its unique ID.


 **Key Notes:** 
 - `id` (required in path): The unique identifier of the assignment to be retrieved. 
 - Returns all metadata related to the assignment including its name, institute details, grade, section, and document status.


 **Scenario: Viewing a Previously Created Assignment** 
 - A teacher wants to verify the information of an already created assignment. 
 - They send a GET request with the assignment's ID. 
 - The system returns all associated details, including whether documents were uploaded and if extraction has begun. 

GET - Assignment

bearerAuth

Get Assignment

CrazyGoldFish

API Documentation

All API endpoints are authenticated using Bearer tokens and picked up from the specification file.
Authentication credentials are required to access the API endpoints. Auth 2.0 JWT

Authentication Process

Before accessing any endpoints, clients need to obtain an access token through the authentication process, using Username and Password The access token serves as a credential to authenticate the client’s requests to the API.

Authentication

Website

API Reference

Contact Us

 Welcome to CrazyGoldFish's K12 Evaluation APIs Documentation 👋

API Products

K12 Evaluation APIs

 Welcome to the CrazyGoldFish's K12 Evaluation API documentation. 👋

Use Cases

 Use Cases by Platform 

This guide will help you understand how to leverage the API to streamline exam management and evaluation processes. This document is tailored for **Product Managers**, **CXOs**, and **decision-makers** to grasp the API's capabilities and benefits.

Exam Evaluation

TThe **Embeddable UI** allows platforms to generate a unique embeddable link for a pre-configured user interface. This UI enables users to upload handwritten answer sheets, view model answers, and receive detailed evaluations. The API simplifies the integration process, making it easy for platforms to offer this functionality as part of their workflows.

Embeddable UI

Embeddable UI for Exam Evaluation

 Welcome to CrazyGoldFish's K12 Generation API Documentation 👋

K12 Genaration APIs

 Welcome to the CrazyGoldFish's K12 Generation API documentation. 👋

 Welcome to Embeddable UI Documentation 👋

Products

 Welcome to the CrazyGoldFish's Embeddable UI documentation. 👋

Use Cases for IELTS and TOEFL Single CTA Embeddable UI

 Welcome to the CrazyGoldFish's TOEFL Evaluation API documentation. 👋

TOEFL Evaluation

 Welcome to the CrazyGoldFish's IELTS Products documentation. 👋

 IELTS 

 Welcome to the CrazyGoldFish's IELTS Evaluation API documentation. 👋

This endpoint allows B2B clients to submit a request for evaluation directly by providing reference links to the images. The API downloads the images separately, generates an evaluation report based on the provided data, and returns an acknowledgment along with an evaluation ID.

v1/evaluation/

This endpoint allows B2B clients to retrieve all the evaluation report or for a specific set of handwritten notes. Clients can provide parameters such as student name, class, subject, and date of evaluation to filter the results.

v1/evaluation

This endpoint allows B2B clients to retrieve a specific evaluation report using its unique identifier (ID). Clients can access past evaluations or reference specific reports by providing the evaluation ID.

v1/evaluation/{id}

 This API allows authenticated users to **create a new rubric** by specifying a title and an optional description.


 **Key Notes:** 
 - `name` is a required field. It defines the title of the rubric. 
 - `description` is optional and can include additional context or instructions. 
 - The created rubric is returned with metadata including `id`, `createdAt`, and `modifiedAt`.


 **Scenario: Creating a Rubric for an Assignment**

 A teacher wants to set up a new rubric to evaluate student essays.

**Outcome:**
- The teacher sends a POST request with the rubric title and description.
- The rubric is saved and ready to be assigned criteria via the system.
- This structure helps ensure consistent and transparent evaluation across students.


POST - Rubric

 Fetches the details of a specific rubric using its unique ID.   This includes basic metadata like name and description, as well as an array of associated criteria with scoring logic.


 **Key Notes:** 
 - `id` must be a valid UUID of an existing rubric. 
 - Authentication is required via Bearer Token. 
 - If the rubric is not found, a `404` error is returned. 

 **Use Cases:** 
 - Display rubric information in the frontend UI. 
 - Load criteria for scoring assignments or assessments. 
 - Pull rubric data into admin dashboards. 

 **Response includes:** 
 - `id`: Unique ID of the rubric. 
 - `name`, `description` 
 - `rubricCriteria`: Array of criteria with scoring logic. 
 - `createdAt`, `modifiedAt` timestamps. 

 

GET - Rubric

 This API allows updating an existing rubric by its unique ID.   You can modify attributes such as the rubric name and description. 


**Key Notes:** 
 - Only the fields provided in the request body will be updated. 
 - `id` must be a valid UUID of an existing rubric. 
 - Authentication via Bearer Token is required. 
 - If the rubric does not exist, a `404` error is returned.



**Use Cases:** 
 - Rename a rubric after creation. 
 - Add or update a description to provide more context.   
 - Make iterative refinements before using the rubric for evaluations. 

PATCH - Rubric

 This API allows authenticated users to **retrieve a paginated list of rubrics** they have created.


 **Key Notes:** 
 - Supports pagination with metadata like `count`, `pageSize`, `next`, and `previous`. 
 - Each rubric object includes fields like `id`, `name`, `description`, `createdAt`, `modifiedAt`, and `rubricCriteria`.


 **Scenario: Viewing Available Rubrics**

 A teacher wants to see all the rubrics they’ve created to select one for a new assignment.

**Outcome:**
- The teacher sends a GET request.
- The API responds with a list of rubrics along with pagination info.
- The teacher can choose and manage existing rubrics efficiently.


LIST - Rubric

 This API allows authenticated users to **add a new criteria** to an existing rubric by specifying its title, score range, and detailed scoring logic.


 **Key Notes:** 
 - `name`, `maxScore`, and `minScore` are **required** fields. 
 - `scoringLogic` is an array of objects, each containing a `score` and its associated `scoringLogic` explanation. 
 - This helps maintain a transparent and consistent evaluation framework.


 **Scenario: Adding a Criterion to a Rubric**

 A teacher wants to assess 'Confidence & fluency in speaking' in a student presentation rubric.

**Outcome:**
- The teacher sends a POST request with the criterion name and scoring details.
- The criterion is added to the existing rubric.
- The rubric becomes more detailed and useful for structured evaluation. 

POST - Rubric Criteria

 This API allows authenticated users to **retrieve all rubric criteria** associated with a specific rubric ID.


 **Key Notes:** 
 - `id` in the URL path refers to the unique identifier of the rubric. 
 - Each criterion contains detailed scoring information including `name`, `minScore`, `maxScore`, and `scoringLogic`. 
 - The `scoringLogic` is an array that defines what each score (e.g., 1 Star to 5 Star) represents.


 **Scenario: Viewing Criteria for a Rubric**

 A teacher wants to view detailed evaluation criteria for a rubric assigned to a student activity.

**Outcome:**
- The teacher sends a GET request with the rubric ID.
- The response returns a list of all rubric criteria with full scoring definitions.
- This helps the teacher ensure clarity and consistency during evaluation. 

GET - Rubric Criteria

 This API allows authenticated users to **partially update** an existing rubric criteria using its ID. Only the fields that need modification should be sent in the request body.


 **Key Notes:** 
 - This is a **partial update**, so all fields are optional. 
 - Useful when you want to update just one or two properties like `maxScore` or `scoringLogic`. 
 - Returns the updated rubric criteria along with its metadata.


 **Fields You Can Update:** 
 - `name`: Title of the criteria (e.g., *Cohesiveness*). 
 - `description`: (Optional) More context or explanation of the criteria. 
 - `maxScore` / `minScore`: Scoring range (e.g., *1 Star* to *5 Star*). 
 - `scoringLogic`: Array of objects defining logic per score.


 **Scenario: Editing Scoring Logic**

 A teacher wants to improve clarity in the scoring explanation for a specific score value. 

PATCH - Rubric Criteria

This endpoint allows you to generate a unique embeddable link for your UI component. This link can be embedded into any webpage or application.

Embeddable UI API

Submit a request for evaluation directly by providing questions and respective answers in a json format. The API generates an evaluation report based on the provided data, and returns an acknowledgment along with an evaluation ID.

v1/toefl/evaluation

Retrieve a specific evaluation report using its unique identifier (ID). Clients can access past evaluations or reference specific reports by providing the evaluation ID. 

Authentication

K12

Assessment Rubrics

Standardized Language Exams

GET - Assignment

Authorizations

Path Parameters

Response