Skip to main content
POST
/
v1
/
activities
/
generate
Generate activities
curl --request POST \
  --url https://api.example.com/v1/activities/generate \
  --header 'Content-Type: application/json' \
  --data '
{
  "lesson_id": "<string>",
  "unit_id": "<string>",
  "cohort_id": "<string>",
  "count": 123,
  "types": [
    "<string>"
  ]
}
'
import requests

url = "https://api.example.com/v1/activities/generate"

payload = {
"lesson_id": "<string>",
"unit_id": "<string>",
"cohort_id": "<string>",
"count": 123,
"types": ["<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({
lesson_id: '<string>',
unit_id: '<string>',
cohort_id: '<string>',
count: 123,
types: ['<string>']
})
};

fetch('https://api.example.com/v1/activities/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/activities/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([
'lesson_id' => '<string>',
'unit_id' => '<string>',
'cohort_id' => '<string>',
'count' => 123,
'types' => [
'<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/generate"

payload := strings.NewReader("{\n \"lesson_id\": \"<string>\",\n \"unit_id\": \"<string>\",\n \"cohort_id\": \"<string>\",\n \"count\": 123,\n \"types\": [\n \"<string>\"\n ]\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/generate")
.header("Content-Type", "application/json")
.body("{\n \"lesson_id\": \"<string>\",\n \"unit_id\": \"<string>\",\n \"cohort_id\": \"<string>\",\n \"count\": 123,\n \"types\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/activities/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 \"lesson_id\": \"<string>\",\n \"unit_id\": \"<string>\",\n \"cohort_id\": \"<string>\",\n \"count\": 123,\n \"types\": [\n \"<string>\"\n ]\n}"

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

Body

lesson_id
string
Generate for one lesson.
unit_id
string
Generate for every lesson in a unit.
cohort_id
string
Generate for every lesson in a cohort.
count
integer
default:"5"
Activities per lesson.
types
string[]
Optional weighting. Defaults to a balanced mix: ["explain", "quiz", "flashcard", "remember"].
Exactly one of lesson_id, unit_id, or cohort_id is required.

Examples

// One lesson
await hk.activities.generate({
  lesson_id: "lsn_123",
  count: 5,
  types: ["explain", "quiz", "flashcard"],
});

// Whole cohort
await hk.activities.generate({ cohort_id: "coh_123", count: 5 });
// One lesson
$hk->activities->generate([
    'lesson_id' => 'lsn_123',
    'count' => 5,
    'types' => ['explain', 'quiz', 'flashcard'],
]);

// Whole cohort
$hk->activities->generate(['cohort_id' => 'coh_123', 'count' => 5]);

Returns

A handle:
{
  "id": "gen_01HX9...",
  "status": "pending",
  "scope": { "cohort_id": "coh_123", "lesson_count": 12 },
  "estimated_ready_at": "2026-05-10T12:05:30Z"
}
Poll or webhook-listen for completion.