From df531b245740df694020a4541e5376e74a894224 Mon Sep 17 00:00:00 2001 From: Accusys Date: Thu, 14 May 2026 17:23:33 +0800 Subject: [PATCH] docs: clarify start_frame/end_frame vs start_time/end_time across API docs --- docs_v1.0/API_V1.0.0/API_DICTIONARY_V1.0.0.md | 4 ++-- docs_v1.0/API_V1.0.0/API_REFERENCE_V1.0.0.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs_v1.0/API_V1.0.0/API_DICTIONARY_V1.0.0.md b/docs_v1.0/API_V1.0.0/API_DICTIONARY_V1.0.0.md index fd0bdd9..b63e40f 100644 --- a/docs_v1.0/API_V1.0.0/API_DICTIONARY_V1.0.0.md +++ b/docs_v1.0/API_V1.0.0/API_DICTIONARY_V1.0.0.md @@ -126,8 +126,8 @@ Every path segment after the resource ID is a **verb** — an action on that res | # | Method | Route | Description | |---|--------|-------|-------------| | 43 | GET | `/api/v1/file/:file_uuid/thumbnail` | Frame JPEG (optional crop via `?frame=&x=&y=&w=&h=`) | -| 44 | GET | `/api/v1/file/:file_uuid/video` | Raw video stream (`?start=&end=` for range) | -| 45 | GET | `/api/v1/file/:file_uuid/video/bbox` | Bbox overlay video (`?start=&end=&duration=`) | +| 44 | GET | `/api/v1/file/:file_uuid/video` | Raw video stream (`?start_time=&end_time=` in seconds) | +| 45 | GET | `/api/v1/file/:file_uuid/video/bbox` | Bbox overlay video (`?start_frame=&end_frame=&duration=` frame numbers) | | 46 | GET | `/api/v1/file/:file_uuid/trace/:trace_id/video` | Trace clip (`?mode=normal\|debug&padding=`) | ## Identity Delete diff --git a/docs_v1.0/API_V1.0.0/API_REFERENCE_V1.0.0.md b/docs_v1.0/API_V1.0.0/API_REFERENCE_V1.0.0.md index 12d4f8b..575e879 100644 --- a/docs_v1.0/API_V1.0.0/API_REFERENCE_V1.0.0.md +++ b/docs_v1.0/API_V1.0.0/API_REFERENCE_V1.0.0.md @@ -207,8 +207,8 @@ curl "http://localhost:3002/api/v1/file/3abeee81d94597629ed8cb943f182e94/trace/2 | # | Method | Path | Description | |---|--------|------|-------------| | 29 | GET | `/api/v1/file/:file_uuid/thumbnail` | Frame JPEG (?frame=&x=&y=&w=&h=) | -| 30 | GET | `/api/v1/file/:file_uuid/video` | Raw video stream (?start=&end=) | -| 31 | GET | `/api/v1/file/:file_uuid/video/bbox` | Bbox overlay (?start=&end=&duration=) | +| 30 | GET | `/api/v1/file/:file_uuid/video` | Raw video stream (`?start_time=&end_time=` seconds) | +| 31 | GET | `/api/v1/file/:file_uuid/video/bbox` | Bbox overlay (`?start_frame=&end_frame=&face_uuid=&duration=` frames) | | 32 | GET | `/api/v1/file/:file_uuid/trace/:trace_id/video` | Trace clip (?mode=&padding=) | Two modes: