From 971f8473eb4f9688b4c9101cb5645b706cc838ec Mon Sep 17 00:00:00 2001 From: Quentin Fuxa Date: Sun, 5 Oct 2025 11:09:47 +0200 Subject: [PATCH] update api doc --- docs/API.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/docs/API.md b/docs/API.md index 3c5041a..8f312ca 100644 --- a/docs/API.md +++ b/docs/API.md @@ -40,19 +40,14 @@ The current API sends complete state snapshots on each update (several time per ### Philosophy -Designed with the following principles: +Principles: -1. **Incremental Updates**: Only updates and new segments are sent -2. **Word-Level Granularity**: Each word includes timing and validation status for text and speaker -3. **Per-Segment Buffers**: Buffers are associated with specific speakers -4. **Efficient Client-Side Handling**: Segments have IDs for easy front updates -5. **Ephemeral Buffers**: Temporary, unvalidated data displayed in real-time but overwritten on next update +- **Incremental Updates**: Only updates and new segments are sent +- **Ephemeral Buffers**: Temporary, unvalidated data displayed in real-time but overwritten on next update, at speaker level ---- ## Message Format -### Transcript Update Message ```typescript {