Skip to main content
POST
/
v1
/
activities
/
{id}
/
evaluate
Evaluate an activity
curl --request POST \
  --url https://api.example.com/v1/activities/{id}/evaluate \
  --header 'Content-Type: application/json' \
  --data '
{
  "answers": [
    {}
  ],
  "student_id": "<string>"
}
'
import requests

url = "https://api.example.com/v1/activities/{id}/evaluate"

payload = {
"answers": [{}],
"student_id": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({answers: [{}], student_id: '<string>'})
};

fetch('https://api.example.com/v1/activities/{id}/evaluate', 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.example.com/v1/activities/{id}/evaluate",
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([
'answers' => [
[

]
],
'student_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$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.example.com/v1/activities/{id}/evaluate"

payload := strings.NewReader("{\n \"answers\": [\n {}\n ],\n \"student_id\": \"<string>\"\n}")

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

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.example.com/v1/activities/{id}/evaluate")
.header("Content-Type", "application/json")
.body("{\n \"answers\": [\n {}\n ],\n \"student_id\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/activities/{id}/evaluate")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"answers\": [\n {}\n ],\n \"student_id\": \"<string>\"\n}"

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

Path parameters

id
string
required

Body

answers
Answer[]
required
One entry per question, or one entry total for single-question activities like short_answer.
student_id
string
Required when called with a workspace key. Optional with a session key (it’s inferred from the key’s subject).

Examples

const submission = await hk.activities.evaluate("act_123", {
  answers: [
    { question_id: "que_1", value: true },
    { question_id: "que_2", value: "c" },
  ],
});

console.log(submission.grade_ai);
$submission = $hk->activities->evaluate('act_123', [
    'answers' => [
        ['question_id' => 'que_1', 'value' => true],
        ['question_id' => 'que_2', 'value' => 'c'],
    ],
]);

echo $submission->grade_ai;

Returns

A Submission. For interactive, inline activities, the submission is auto-graded synchronously when the question types support it (true_false, fill_blank, matching, etc.). For open-ended types, ai_status: "pending" until grading completes.