admin/momentry_core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix start/end → start_frame/end_frame in API docs

Browse Source
This commit is contained in:
Accusys
2026-05-14 17:57:00 +08:00
parent 0491c39d3f
commit 11f690ca35
44 changed files with 4672 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs_v1.0/API_V1.0.0/API_DOCUMENTATION.md
View File

@@ -338,7 +338,7 @@ Returns video with face bounding boxes overlaid.
```
GET /api/v1/file/{file_uuid}/video/bbox
Query: ?start=0&end=300&face_uuid=xxx
Query: ?start_frame=0&end_frame=300&face_uuid=xxx
```
Returns `video/mp4` binary with red bboxes drawn at frame intervals.

2
docs_v1.0/API_V1.0.0/API_DOCUMENTATION_V1.0.0.md
View File

@@ -338,7 +338,7 @@ Returns video with face bounding boxes overlaid.
```
GET /api/v1/file/{file_uuid}/video/bbox
Query: ?start=0&end=300&face_uuid=xxx
Query: ?start_frame=0&end_frame=300&face_uuid=xxx
```
Returns `video/mp4` binary with red bboxes drawn at frame intervals.

2
docs_v1.0/API_V1.0.0/API_DOCUMENTATION_v1.0.0.md
View File

@@ -338,7 +338,7 @@ Returns video with face bounding boxes overlaid.
```
GET /api/v1/file/{file_uuid}/video/bbox
Query: ?start=0&end=300&face_uuid=xxx
Query: ?start_frame=0&end_frame=300&face_uuid=xxx
```
Returns `video/mp4` binary with red bboxes drawn at frame intervals.

2
docs_v1.0/API_V1.0.0/DEMO_SEQUENCE_V1.0.0.md
View File

@@ -82,7 +82,7 @@ https://api.momentry.ddns.net/api/v1/file/3abeee81d94597629ed8cb943f182e94/trace
Browser 開:
```
https://api.momentry.ddns.net/api/v1/file/3abeee81d94597629ed8cb943f182e94/video/bbox?start=68000&end=69000
https://api.momentry.ddns.net/api/v1/file/3abeee81d94597629ed8cb943f182e94/video/bbox?start_frame=68000&end_frame=69000
```
**預期**: 該區間內所有臉部偵測的 bbox overlay 影片

2
docs_v1.0/API_V1.0.0/DEMO_SEQUENCE_v1.0.0.md
View File

@@ -82,7 +82,7 @@ https://api.momentry.ddns.net/api/v1/file/3abeee81d94597629ed8cb943f182e94/trace
Browser 開:
```
https://api.momentry.ddns.net/api/v1/file/3abeee81d94597629ed8cb943f182e94/video/bbox?start=68000&end=69000
https://api.momentry.ddns.net/api/v1/file/3abeee81d94597629ed8cb943f182e94/video/bbox?start_frame=68000&end_frame=69000
```
**預期**: 該區間內所有臉部偵測的 bbox overlay 影片

4
docs_v1.0/API_V1.0.0/RELEASE/RELEASE_API_REFERENCE_V1.0.0.md
View File

@@ -133,8 +133,8 @@ curl "$BASE/api/v1/file/$FILE/trace/2/faces?limit=2&interpolate=true" -H "$KEY"
| # | 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 (?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 (start_frame=&end_frame=) |
| 31 | GET | `/api/v1/file/:file_uuid/video/bbox` | Bbox overlay (start_frame=&end_frame=&duration=) |
| 32 | GET | `/api/v1/file/:file_uuid/trace/:trace_id/video` | Trace clip (?padding=) |
---

4
docs_v1.0/API_V1.0.0/RELEASE/RELEASE_API_REFERENCE_v1.0.0.md
View File

@@ -133,8 +133,8 @@ curl "$BASE/api/v1/file/$FILE/trace/2/faces?limit=2&interpolate=true" -H "$KEY"
| # | 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 (?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 (start_frame=&end_frame=) |
| 31 | GET | `/api/v1/file/:file_uuid/video/bbox` | Bbox overlay (start_frame=&end_frame=&duration=) |
| 32 | GET | `/api/v1/file/:file_uuid/trace/:trace_id/video` | Trace clip (?padding=) |
---