GET
/
v1
/
evaluation
/
{id}
curl --request GET \
  --url https://api-staging.crazygoldfish.com/v1/evaluation/{id} \
  --header 'Authorization: Bearer <token>'
{
  "status": "200",
  "message": "request successfully",
  "data": {
    "evalution_id": "<string>",
    "client_id": "<string>",
    "evaluation_type": "<string>",
    "evaluation": [
      {
        "report_header": {
          "class": "<string>",
          "subject": "<string>",
          "no_of_images": "<string>",
          "student_name": "<string>",
          "date_of_evaluation": "<string>",
          "total_questions_attempted": "<string>"
        },
        "overview": {
          "holistic_evaluation": {
            "creativity": "<string>",
            "organization": "<string>",
            "content_relevance": "<string>",
            "clarity_expression": "<string>",
            "grammar_punctuation": "<string>"
          },
          "summary": "<string>"
        },
        "detailed_evaluation": {
          "total_suggestions": "<string>",
          "spelling_suggestions": "<string>",
          "punctuation_suggestions": "<string>",
          "grammar_suggestions": "<string>",
          "image_assessment": [
            {
              "image": "<string>",
              "questions": [
                {
                  "errors": [
                    {
                      "error_type": "<string>",
                      "suggestions": [
                        "<string>"
                      ]
                    }
                  ],
                  "question": 123
                }
              ]
            }
          ]
        },
        "actionables": {
          "actionable_points": [
            "<string>"
          ]
        }
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Unique evaluation ID generated during image submissions.

Query Parameters

​
client_id
string
required

Unique identifier assigned to the client accessing the API.

​
evaluation_format
enum<string>
default:json
required

Specifies the format of evaluation report to retrieve.

Available options:
json,
html_link

Response

200 - application/json
Successful response
​
status
string
Example:

"200"

​
message
string
Example:

"request successfully"

​
data
object