Generate a syllabus
curl --request POST \
--url https://api.example.com/v1/courses/{id}/syllabus/generate \
--header 'Content-Type: application/json' \
--data '
{
"brief": "<string>",
"audience": "<string>",
"hours": 123,
"research_id": "<string>"
}
'import requests
url = "https://api.example.com/v1/courses/{id}/syllabus/generate"
payload = {
"brief": "<string>",
"audience": "<string>",
"hours": 123,
"research_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({brief: '<string>', audience: '<string>', hours: 123, research_id: '<string>'})
};
fetch('https://api.example.com/v1/courses/{id}/syllabus/generate', 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/courses/{id}/syllabus/generate",
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([
'brief' => '<string>',
'audience' => '<string>',
'hours' => 123,
'research_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/courses/{id}/syllabus/generate"
payload := strings.NewReader("{\n \"brief\": \"<string>\",\n \"audience\": \"<string>\",\n \"hours\": 123,\n \"research_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/courses/{id}/syllabus/generate")
.header("Content-Type", "application/json")
.body("{\n \"brief\": \"<string>\",\n \"audience\": \"<string>\",\n \"hours\": 123,\n \"research_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/courses/{id}/syllabus/generate")
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 \"brief\": \"<string>\",\n \"audience\": \"<string>\",\n \"hours\": 123,\n \"research_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyCourses
Generate a syllabus
Generate a unit/lesson tree with learning objectives. Async.
POST
/
v1
/
courses
/
{id}
/
syllabus
/
generate
Generate a syllabus
curl --request POST \
--url https://api.example.com/v1/courses/{id}/syllabus/generate \
--header 'Content-Type: application/json' \
--data '
{
"brief": "<string>",
"audience": "<string>",
"hours": 123,
"research_id": "<string>"
}
'import requests
url = "https://api.example.com/v1/courses/{id}/syllabus/generate"
payload = {
"brief": "<string>",
"audience": "<string>",
"hours": 123,
"research_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({brief: '<string>', audience: '<string>', hours: 123, research_id: '<string>'})
};
fetch('https://api.example.com/v1/courses/{id}/syllabus/generate', 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/courses/{id}/syllabus/generate",
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([
'brief' => '<string>',
'audience' => '<string>',
'hours' => 123,
'research_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/courses/{id}/syllabus/generate"
payload := strings.NewReader("{\n \"brief\": \"<string>\",\n \"audience\": \"<string>\",\n \"hours\": 123,\n \"research_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/courses/{id}/syllabus/generate")
.header("Content-Type", "application/json")
.body("{\n \"brief\": \"<string>\",\n \"audience\": \"<string>\",\n \"hours\": 123,\n \"research_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/courses/{id}/syllabus/generate")
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 \"brief\": \"<string>\",\n \"audience\": \"<string>\",\n \"hours\": 123,\n \"research_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyPath parameters
Body
A short description of what the course should cover. Two paragraphs
is plenty; one is fine.
Free-text learner profile. E.g.
"third-year physics undergrads".Override the course’s
hours. Affects how granular the lesson split is.Behaviour
This call is async. The course transitions tostatus: "pending" and
then to "ready" (or "error"). You can poll
or subscribe to the course.syllabus_generated webhook.
Examples
await hk.courses.generateSyllabus("crs_123", {
brief: "An undergraduate intro to special relativity, ending with mass-energy equivalence.",
audience: "third-year physics undergrads",
hours: 12,
});
const ready = await hk.poll(
() => hk.courses.retrieve("crs_123", { expand: ["cohorts.lessons"] }),
{ until: c => c.status === "ready" },
);
$hk->courses->generateSyllabus('crs_123', [
'brief' => 'An undergraduate intro to special relativity, ending with mass-energy equivalence.',
'audience' => 'third-year physics undergrads',
'hours' => 12,
]);
$ready = $hk->poll(
fn () => $hk->courses->retrieve('crs_123', ['expand' => ['cohorts.lessons']]),
['until' => fn ($c) => $c->status === 'ready'],
);
Returns
The course instatus: "pending".
{
"id": "crs_123",
"status": "pending",
"estimated_ready_at": "2026-05-10T12:01:30Z"
}
⌘I