Skip to content
AiKYNETIX

Get a session's video annotations

GET
/api/sessions/{id}/annotations/
curl --request GET \
  --url http://localhost:8000/api/sessions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/annotations/ \
  --header 'Authorization: Bearer <token>'

Returns the coach’s saved video markup for a session (#944) — a normalised-coordinate array of freehand strokes, angle guides, rulers and text bubbles. payload is [] when nothing has been drawn yet.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Response for the annotation endpoints (#944). Fields are declared explicitly rather than inferred so the generated client type is accurate: the empty-set response is all-null, so updated_at / updated_by must be nullable, and payload is a typed array — the empty GET now flows through this serializer instead of a raw dict, so the contract and the wire agree (#1227 review).

object
payload
required
Array<object>
object
key
additional properties
updated_at
required
string format: date-time
nullable
updated_by
required
string format: email
nullable
Examplegenerated
{}

401

Section titled “401”
Media typeapplication/json
object
detail
required

Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).

string
Examplegenerated
{
  "detail": "example"
}

404

Section titled “404”
Media typeapplication/json
object
detail
required

Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).

string
Examples
Example404—NoSuchSessionOnThisTeam

Absent, or owned by another team (collapsed to 404)

{
  "detail": "session_not_found"
}