Preview endpoints
Preview workflows are where SessionDock becomes more than a metadata index. These endpoints let tools listen, inspect, and annotate without opening a DAW.
Main routes
GET /api/v1/sessions/{id}/previewGET /api/v1/sessions/{id}/waveformGET /api/v1/sessions/{id}/waveform-notesPUT /api/v1/sessions/{id}/waveform-notesPATCH /api/v1/sessions/{id}/waveform-notes
Variant-aware reads
Waveform and waveform-notes both accept an optional variantId query parameter so tools can target a specific preview lane.
Example: fetch preview metadata
curl \
-H "Authorization: Bearer $SESSIONDOCK_TOKEN" \
"$SESSIONDOCK_BASE_URL/sessions/session_123/preview"
Example: replace waveform notes
curl \
-X PUT \
-H "Authorization: Bearer $SESSIONDOCK_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"notes": [
{ "timestamp": 12.5, "text": "Drop starts here" },
{ "timestamp": 18.0, "text": "Mute the riser" }
]
}' \
"$SESSIONDOCK_BASE_URL/sessions/session_123/waveform-notes?variantId=preview_main"
Good use cases
- mobile-friendly preview dashboards
- desktop review assistants
- timestamped mix feedback tooling
- automated handoff workflows for producers and engineers
Preview workflow
These routes are especially useful for review surfaces, listening workflows, and timestamped feedback tools.