Per Artifact Note
curl --request POST \
--url https://api.myustadia.com/api/v1/courses/{course_id}/review/note \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"note": "<string>",
"artifact_type": "<string>",
"module_index": 123,
"scene_index": 123,
"asset_id": 123
}
'import requests
url = "https://api.myustadia.com/api/v1/courses/{course_id}/review/note"
payload = {
"note": "<string>",
"artifact_type": "<string>",
"module_index": 123,
"scene_index": 123,
"asset_id": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
note: '<string>',
artifact_type: '<string>',
module_index: 123,
scene_index: 123,
asset_id: 123
})
};
fetch('https://api.myustadia.com/api/v1/courses/{course_id}/review/note', 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.myustadia.com/api/v1/courses/{course_id}/review/note",
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([
'note' => '<string>',
'artifact_type' => '<string>',
'module_index' => 123,
'scene_index' => 123,
'asset_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.myustadia.com/api/v1/courses/{course_id}/review/note"
payload := strings.NewReader("{\n \"note\": \"<string>\",\n \"artifact_type\": \"<string>\",\n \"module_index\": 123,\n \"scene_index\": 123,\n \"asset_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
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.myustadia.com/api/v1/courses/{course_id}/review/note")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"note\": \"<string>\",\n \"artifact_type\": \"<string>\",\n \"module_index\": 123,\n \"scene_index\": 123,\n \"asset_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.myustadia.com/api/v1/courses/{course_id}/review/note")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"note\": \"<string>\",\n \"artifact_type\": \"<string>\",\n \"module_index\": 123,\n \"scene_index\": 123,\n \"asset_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}B2B Courses v2
Per Artifact Note
POST /courses/{id}/review/note (S2.1)
Record a reviewer note against a single artifact.
Before recording: runs check_regen_allowed (S2.3 regen-cap pre-check).
- If the course regen cap is exhausted: returns 429 WITH code='regen_cap_reached'
BUT the note IS still recorded (design 14.5: cap withholds the regen job,
not the note). In Wave 1 there is no regen job to withhold anyway; the 429
surfaces the cap to the caller for UX purposes.
After passing the cap check: calls course_reviews.record_note which upserts
status='note', appends the curated feedback entry, and returns the ledger row.
Edits-flag write for outline/notes (S2.3 / design section 7):
When artifact_type IN ('outline', 'notes'), the ledger row itself
(status='note', iteration counts as edits signal) IS the edits-flag that
Wave 2's narration needs_refine predicate reads. No separate flag file is
written. This replaces the run_dir outline_edited.flag approach for
per-stage courses (punchlist P3-4).
Phase 2 / Wave 1: returns {noted, iteration, regen_cap_reached?}.
NO regen job is enqueued (Wave 2 wires that).
POST
/
api
/
v1
/
courses
/
{course_id}
/
review
/
note
Per Artifact Note
curl --request POST \
--url https://api.myustadia.com/api/v1/courses/{course_id}/review/note \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"note": "<string>",
"artifact_type": "<string>",
"module_index": 123,
"scene_index": 123,
"asset_id": 123
}
'import requests
url = "https://api.myustadia.com/api/v1/courses/{course_id}/review/note"
payload = {
"note": "<string>",
"artifact_type": "<string>",
"module_index": 123,
"scene_index": 123,
"asset_id": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
note: '<string>',
artifact_type: '<string>',
module_index: 123,
scene_index: 123,
asset_id: 123
})
};
fetch('https://api.myustadia.com/api/v1/courses/{course_id}/review/note', 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.myustadia.com/api/v1/courses/{course_id}/review/note",
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([
'note' => '<string>',
'artifact_type' => '<string>',
'module_index' => 123,
'scene_index' => 123,
'asset_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.myustadia.com/api/v1/courses/{course_id}/review/note"
payload := strings.NewReader("{\n \"note\": \"<string>\",\n \"artifact_type\": \"<string>\",\n \"module_index\": 123,\n \"scene_index\": 123,\n \"asset_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
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.myustadia.com/api/v1/courses/{course_id}/review/note")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"note\": \"<string>\",\n \"artifact_type\": \"<string>\",\n \"module_index\": 123,\n \"scene_index\": 123,\n \"asset_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.myustadia.com/api/v1/courses/{course_id}/review/note")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"note\": \"<string>\",\n \"artifact_type\": \"<string>\",\n \"module_index\": 123,\n \"scene_index\": 123,\n \"asset_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Response
Successful Response