v1/ielts/evaluation
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.
POST
/
v1
/
ielts
/
evaluation
Submit Evaluation Request
curl --request POST \
--url https://api-staging.crazygoldfish.com/v1/ielts/evaluation \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'accept: <accept>' \
--data '
{
"client_id": "12345ABC",
"student_id": "11223STU",
"exam_type": "AC",
"student_name": "John Doe",
"evaluation_text": [
{
"question_id": "q1",
"question_number": "1",
"question_section": "writing",
"question_type": "IE-AC-W-01",
"question_text": "Summarize the points made in the lecture.",
"answer_text": "The lecture discusses the various impacts of climate change.",
"question_multimedia_url": "<string>",
"answer_multimedia_url": "<string>",
"custom_rubric_id": "1234"
}
],
"institution_id": "67890XYZ",
"teacher_id": "98765LMN",
"parent_id": "54321PQR",
"image_urls": [
"http://example.com/image1.jpg",
"http://example.com/image2.jpg"
]
}
'import requests
url = "https://api-staging.crazygoldfish.com/v1/ielts/evaluation"
payload = {
"client_id": "12345ABC",
"student_id": "11223STU",
"exam_type": "AC",
"student_name": "John Doe",
"evaluation_text": [
{
"question_id": "q1",
"question_number": "1",
"question_section": "writing",
"question_type": "IE-AC-W-01",
"question_text": "Summarize the points made in the lecture.",
"answer_text": "The lecture discusses the various impacts of climate change.",
"question_multimedia_url": "<string>",
"answer_multimedia_url": "<string>",
"custom_rubric_id": "1234"
}
],
"institution_id": "67890XYZ",
"teacher_id": "98765LMN",
"parent_id": "54321PQR",
"image_urls": ["http://example.com/image1.jpg", "http://example.com/image2.jpg"]
}
headers = {
"accept": "<accept>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
accept: '<accept>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
client_id: '12345ABC',
student_id: '11223STU',
exam_type: 'AC',
student_name: 'John Doe',
evaluation_text: [
{
question_id: 'q1',
question_number: '1',
question_section: 'writing',
question_type: 'IE-AC-W-01',
question_text: 'Summarize the points made in the lecture.',
answer_text: 'The lecture discusses the various impacts of climate change.',
question_multimedia_url: '<string>',
answer_multimedia_url: '<string>',
custom_rubric_id: '1234'
}
],
institution_id: '67890XYZ',
teacher_id: '98765LMN',
parent_id: '54321PQR',
image_urls: ['http://example.com/image1.jpg', 'http://example.com/image2.jpg']
})
};
fetch('https://api-staging.crazygoldfish.com/v1/ielts/evaluation', 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/v1/ielts/evaluation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'client_id' => '12345ABC',
'student_id' => '11223STU',
'exam_type' => 'AC',
'student_name' => 'John Doe',
'evaluation_text' => [
[
'question_id' => 'q1',
'question_number' => '1',
'question_section' => 'writing',
'question_type' => 'IE-AC-W-01',
'question_text' => 'Summarize the points made in the lecture.',
'answer_text' => 'The lecture discusses the various impacts of climate change.',
'question_multimedia_url' => '<string>',
'answer_multimedia_url' => '<string>',
'custom_rubric_id' => '1234'
]
],
'institution_id' => '67890XYZ',
'teacher_id' => '98765LMN',
'parent_id' => '54321PQR',
'image_urls' => [
'http://example.com/image1.jpg',
'http://example.com/image2.jpg'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"accept: <accept>"
],
]);
$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/v1/ielts/evaluation"
payload := strings.NewReader("{\n \"client_id\": \"12345ABC\",\n \"student_id\": \"11223STU\",\n \"exam_type\": \"AC\",\n \"student_name\": \"John Doe\",\n \"evaluation_text\": [\n {\n \"question_id\": \"q1\",\n \"question_number\": \"1\",\n \"question_section\": \"writing\",\n \"question_type\": \"IE-AC-W-01\",\n \"question_text\": \"Summarize the points made in the lecture.\",\n \"answer_text\": \"The lecture discusses the various impacts of climate change.\",\n \"question_multimedia_url\": \"<string>\",\n \"answer_multimedia_url\": \"<string>\",\n \"custom_rubric_id\": \"1234\"\n }\n ],\n \"institution_id\": \"67890XYZ\",\n \"teacher_id\": \"98765LMN\",\n \"parent_id\": \"54321PQR\",\n \"image_urls\": [\n \"http://example.com/image1.jpg\",\n \"http://example.com/image2.jpg\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("accept", "<accept>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-staging.crazygoldfish.com/v1/ielts/evaluation")
.header("accept", "<accept>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": \"12345ABC\",\n \"student_id\": \"11223STU\",\n \"exam_type\": \"AC\",\n \"student_name\": \"John Doe\",\n \"evaluation_text\": [\n {\n \"question_id\": \"q1\",\n \"question_number\": \"1\",\n \"question_section\": \"writing\",\n \"question_type\": \"IE-AC-W-01\",\n \"question_text\": \"Summarize the points made in the lecture.\",\n \"answer_text\": \"The lecture discusses the various impacts of climate change.\",\n \"question_multimedia_url\": \"<string>\",\n \"answer_multimedia_url\": \"<string>\",\n \"custom_rubric_id\": \"1234\"\n }\n ],\n \"institution_id\": \"67890XYZ\",\n \"teacher_id\": \"98765LMN\",\n \"parent_id\": \"54321PQR\",\n \"image_urls\": [\n \"http://example.com/image1.jpg\",\n \"http://example.com/image2.jpg\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.crazygoldfish.com/v1/ielts/evaluation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = '<accept>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_id\": \"12345ABC\",\n \"student_id\": \"11223STU\",\n \"exam_type\": \"AC\",\n \"student_name\": \"John Doe\",\n \"evaluation_text\": [\n {\n \"question_id\": \"q1\",\n \"question_number\": \"1\",\n \"question_section\": \"writing\",\n \"question_type\": \"IE-AC-W-01\",\n \"question_text\": \"Summarize the points made in the lecture.\",\n \"answer_text\": \"The lecture discusses the various impacts of climate change.\",\n \"question_multimedia_url\": \"<string>\",\n \"answer_multimedia_url\": \"<string>\",\n \"custom_rubric_id\": \"1234\"\n }\n ],\n \"institution_id\": \"67890XYZ\",\n \"teacher_id\": \"98765LMN\",\n \"parent_id\": \"54321PQR\",\n \"image_urls\": [\n \"http://example.com/image1.jpg\",\n \"http://example.com/image2.jpg\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "200",
"message": "Evaluation request submitted successfully",
"data": [
{
"evaluation_id": "<string>"
}
]
}{
"error": "Invalid request body"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Available options:
application/json Body
application/json
Unique identifier assigned to the client accessing the API.
Example:
"12345ABC"
Identifies the specific student for whom the evaluation is being requested.
Example:
"11223STU"
Type of IELTS exam (AC for Academic, GT for General Training).
Available options:
AC, GT Example:
"AC"
Name of the student for whom the evaluation is being requested.
Example:
"John Doe"
List of evaluation questions and answers.
Show child attributes
Show child attributes
Unique identifier of the institution (optional).
Example:
"67890XYZ"
Identifier of the teacher (optional).
Example:
"98765LMN"
Unique identifier of the parent associated with the student (optional).
Example:
"54321PQR"
List of URLs pointing to the images of the evaluated work (optional).
Example:
[ "http://example.com/image1.jpg", "http://example.com/image2.jpg" ]
Was this page helpful?
Previous
v1/ielts/evaluation/{id_}Retrieve a specific evaluation report using its unique identifier (ID). Clients can access past evaluations or reference specific reports by providing the evaluation ID.
Next
⌘I
Submit Evaluation Request
curl --request POST \
--url https://api-staging.crazygoldfish.com/v1/ielts/evaluation \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'accept: <accept>' \
--data '
{
"client_id": "12345ABC",
"student_id": "11223STU",
"exam_type": "AC",
"student_name": "John Doe",
"evaluation_text": [
{
"question_id": "q1",
"question_number": "1",
"question_section": "writing",
"question_type": "IE-AC-W-01",
"question_text": "Summarize the points made in the lecture.",
"answer_text": "The lecture discusses the various impacts of climate change.",
"question_multimedia_url": "<string>",
"answer_multimedia_url": "<string>",
"custom_rubric_id": "1234"
}
],
"institution_id": "67890XYZ",
"teacher_id": "98765LMN",
"parent_id": "54321PQR",
"image_urls": [
"http://example.com/image1.jpg",
"http://example.com/image2.jpg"
]
}
'import requests
url = "https://api-staging.crazygoldfish.com/v1/ielts/evaluation"
payload = {
"client_id": "12345ABC",
"student_id": "11223STU",
"exam_type": "AC",
"student_name": "John Doe",
"evaluation_text": [
{
"question_id": "q1",
"question_number": "1",
"question_section": "writing",
"question_type": "IE-AC-W-01",
"question_text": "Summarize the points made in the lecture.",
"answer_text": "The lecture discusses the various impacts of climate change.",
"question_multimedia_url": "<string>",
"answer_multimedia_url": "<string>",
"custom_rubric_id": "1234"
}
],
"institution_id": "67890XYZ",
"teacher_id": "98765LMN",
"parent_id": "54321PQR",
"image_urls": ["http://example.com/image1.jpg", "http://example.com/image2.jpg"]
}
headers = {
"accept": "<accept>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
accept: '<accept>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
client_id: '12345ABC',
student_id: '11223STU',
exam_type: 'AC',
student_name: 'John Doe',
evaluation_text: [
{
question_id: 'q1',
question_number: '1',
question_section: 'writing',
question_type: 'IE-AC-W-01',
question_text: 'Summarize the points made in the lecture.',
answer_text: 'The lecture discusses the various impacts of climate change.',
question_multimedia_url: '<string>',
answer_multimedia_url: '<string>',
custom_rubric_id: '1234'
}
],
institution_id: '67890XYZ',
teacher_id: '98765LMN',
parent_id: '54321PQR',
image_urls: ['http://example.com/image1.jpg', 'http://example.com/image2.jpg']
})
};
fetch('https://api-staging.crazygoldfish.com/v1/ielts/evaluation', 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/v1/ielts/evaluation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'client_id' => '12345ABC',
'student_id' => '11223STU',
'exam_type' => 'AC',
'student_name' => 'John Doe',
'evaluation_text' => [
[
'question_id' => 'q1',
'question_number' => '1',
'question_section' => 'writing',
'question_type' => 'IE-AC-W-01',
'question_text' => 'Summarize the points made in the lecture.',
'answer_text' => 'The lecture discusses the various impacts of climate change.',
'question_multimedia_url' => '<string>',
'answer_multimedia_url' => '<string>',
'custom_rubric_id' => '1234'
]
],
'institution_id' => '67890XYZ',
'teacher_id' => '98765LMN',
'parent_id' => '54321PQR',
'image_urls' => [
'http://example.com/image1.jpg',
'http://example.com/image2.jpg'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"accept: <accept>"
],
]);
$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/v1/ielts/evaluation"
payload := strings.NewReader("{\n \"client_id\": \"12345ABC\",\n \"student_id\": \"11223STU\",\n \"exam_type\": \"AC\",\n \"student_name\": \"John Doe\",\n \"evaluation_text\": [\n {\n \"question_id\": \"q1\",\n \"question_number\": \"1\",\n \"question_section\": \"writing\",\n \"question_type\": \"IE-AC-W-01\",\n \"question_text\": \"Summarize the points made in the lecture.\",\n \"answer_text\": \"The lecture discusses the various impacts of climate change.\",\n \"question_multimedia_url\": \"<string>\",\n \"answer_multimedia_url\": \"<string>\",\n \"custom_rubric_id\": \"1234\"\n }\n ],\n \"institution_id\": \"67890XYZ\",\n \"teacher_id\": \"98765LMN\",\n \"parent_id\": \"54321PQR\",\n \"image_urls\": [\n \"http://example.com/image1.jpg\",\n \"http://example.com/image2.jpg\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("accept", "<accept>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-staging.crazygoldfish.com/v1/ielts/evaluation")
.header("accept", "<accept>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": \"12345ABC\",\n \"student_id\": \"11223STU\",\n \"exam_type\": \"AC\",\n \"student_name\": \"John Doe\",\n \"evaluation_text\": [\n {\n \"question_id\": \"q1\",\n \"question_number\": \"1\",\n \"question_section\": \"writing\",\n \"question_type\": \"IE-AC-W-01\",\n \"question_text\": \"Summarize the points made in the lecture.\",\n \"answer_text\": \"The lecture discusses the various impacts of climate change.\",\n \"question_multimedia_url\": \"<string>\",\n \"answer_multimedia_url\": \"<string>\",\n \"custom_rubric_id\": \"1234\"\n }\n ],\n \"institution_id\": \"67890XYZ\",\n \"teacher_id\": \"98765LMN\",\n \"parent_id\": \"54321PQR\",\n \"image_urls\": [\n \"http://example.com/image1.jpg\",\n \"http://example.com/image2.jpg\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.crazygoldfish.com/v1/ielts/evaluation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = '<accept>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_id\": \"12345ABC\",\n \"student_id\": \"11223STU\",\n \"exam_type\": \"AC\",\n \"student_name\": \"John Doe\",\n \"evaluation_text\": [\n {\n \"question_id\": \"q1\",\n \"question_number\": \"1\",\n \"question_section\": \"writing\",\n \"question_type\": \"IE-AC-W-01\",\n \"question_text\": \"Summarize the points made in the lecture.\",\n \"answer_text\": \"The lecture discusses the various impacts of climate change.\",\n \"question_multimedia_url\": \"<string>\",\n \"answer_multimedia_url\": \"<string>\",\n \"custom_rubric_id\": \"1234\"\n }\n ],\n \"institution_id\": \"67890XYZ\",\n \"teacher_id\": \"98765LMN\",\n \"parent_id\": \"54321PQR\",\n \"image_urls\": [\n \"http://example.com/image1.jpg\",\n \"http://example.com/image2.jpg\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "200",
"message": "Evaluation request submitted successfully",
"data": [
{
"evaluation_id": "<string>"
}
]
}{
"error": "Invalid request body"
}