POST
/
v1
/
evaluation
curl --request POST \
  --url https://api-staging.crazygoldfish.com/v1/evaluation/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'accept: <accept>' \
  --data '{
  "client_id": "123456",
  "student_id": "<string>",
  "institution_id": "<string>",
  "teacher_id": "<string>",
  "parent_id": "<string>",
  "class": "<string>",
  "subject": "<string>",
  "student_name": "<string>",
  "image_urls": [
    "<string>"
  ]
}'
{
  "status": "200",
  "message": "Evaluation request submitted successfully",
  "data": {
    "evaluation_id": "<string>",
    "evaluation_status": "pending"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
accept
enum<string>
default:application/json
required
Available options:
application/json

Body

application/json
​
client_id
string
required

Unique identifier assigned to the client accessing the API.

Example:

"123456"

​
student_id
string
required

Identifies the specific student for whom the evaluation is being requested.

​
subject
string
required

Specifies the subject or topic of the handwritten notes being evaluated.

​
student_name
string
required

Specifies the name of the student for whom the evaluation is being requested.

​
image_urls
string[]
required

Contains URLs pointing to the images of handwritten notes that are to be evaluated.

​
institution_id
string

Represents the unique identifier of the institution to which the student belongs.

​
teacher_id
string

Identifies the teacher responsible for the student's evaluation.

​
parent_id
string

Specifies the unique identifier of the parent associated with the student.

​
class
string

Indicates the class or grade level of the student.

Response

200
application/json
Successful response
​
status
string
Example:

"200"

​
message
string
Example:

"Evaluation request submitted successfully"

​
data
object