Skip to main content
POST
/
v1
/
assignments
Create an assignment
curl --request POST \
  --url https://api.example.com/v1/assignments \
  --header 'Content-Type: application/json' \
  --data '
{
  "lesson_id": "<string>",
  "type": {},
  "title": "<string>",
  "description": "<string>",
  "due_at": "<string>",
  "rubric": {}
}
'
import requests

url = "https://api.example.com/v1/assignments"

payload = {
"lesson_id": "<string>",
"type": {},
"title": "<string>",
"description": "<string>",
"due_at": "<string>",
"rubric": {}
}
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({
lesson_id: '<string>',
type: {},
title: '<string>',
description: '<string>',
due_at: '<string>',
rubric: {}
})
};

fetch('https://api.example.com/v1/assignments', 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/assignments",
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([
'lesson_id' => '<string>',
'type' => [

],
'title' => '<string>',
'description' => '<string>',
'due_at' => '<string>',
'rubric' => [

]
]),
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/assignments"

payload := strings.NewReader("{\n \"lesson_id\": \"<string>\",\n \"type\": {},\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"due_at\": \"<string>\",\n \"rubric\": {}\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/assignments")
.header("Content-Type", "application/json")
.body("{\n \"lesson_id\": \"<string>\",\n \"type\": {},\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"due_at\": \"<string>\",\n \"rubric\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/assignments")

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 \"lesson_id\": \"<string>\",\n \"type\": {},\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"due_at\": \"<string>\",\n \"rubric\": {}\n}"

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

Body

lesson_id
string
required
type
enum
required
essay | upload | code | oral | project.
title
string
required
description
string
due_at
string
ISO 8601.
rubric
Rubric
required

Examples

await hk.assignments.create({
  lesson_id: "lsn_123",
  type: "essay",
  title: "Explain mass-energy equivalence",
  rubric: {
    scale: { min: 0, max: 10 },
    criteria: [
      { name: "clarity",  weight: 0.4 },
      { name: "accuracy", weight: 0.4 },
      { name: "sources",  weight: 0.2 },
    ],
  },
});
$hk->assignments->create([
    'lesson_id' => 'lsn_123',
    'type' => 'essay',
    'title' => 'Explain mass-energy equivalence',
    'rubric' => [
        'scale' => ['min' => 0, 'max' => 10],
        'criteria' => [
            ['name' => 'clarity',  'weight' => 0.4],
            ['name' => 'accuracy', 'weight' => 0.4],
            ['name' => 'sources',  'weight' => 0.2],
        ],
    ],
]);

Returns

An Assignment.