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 cf6b8ac..daaddea 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 @@ -60,10 +60,7 @@ curl http://localhost:3002/health | 18 | GET | `/api/v1/jobs` | Monitor jobs (filterable) | ```bash -curl -X POST http://localhost:3002/api/v1/files/register \ - -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \ - -H "Content-Type: application/json" \ - -d '{"file_path":"/sftpgo/data/demo/video.mp4"}' +curl -X POST http://localhost:3002/api/v1/files/register -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" -H "Content-Type: application/json" -d '{"file_path":"/sftpgo/data/demo/video.mp4"}' ``` ```json {"success":true,"file_uuid":"3abeee81d94597629ed8cb943f182e94","duration":5954.0} @@ -92,20 +89,14 @@ curl "http://localhost:3002/api/v1/files?page=1&page_size=2" -H "X-API-Key: muse | 26 | POST | `/api/v1/search/frames` | Frame-level search | ```bash -curl -X POST http://localhost:3002/api/v1/search/universal \ - -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \ - -H "Content-Type: application/json" \ - -d '{"query":"name","limit":2,"mode":"bm25","uuid":"3abeee81d94597629ed8cb943f182e94"}' +curl -X POST http://localhost:3002/api/v1/search/universal -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" -H "Content-Type: application/json" -d '{"query":"name","limit":2,"mode":"bm25","uuid":"3abeee81d94597629ed8cb943f182e94"}' ``` ```json {"count":1,"results":[{"text":"What's your name?","score":0.90}]} ``` ```bash -curl -X POST http://localhost:3002/api/v1/search/universal \ - -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \ - -H "Content-Type: application/json" \ - -d '{"query":"friends","limit":2,"mode":"bm25","uuid":"3abeee81d94597629ed8cb943f182e94"}' +curl -X POST http://localhost:3002/api/v1/search/universal -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" -H "Content-Type: application/json" -d '{"query":"friends","limit":2,"mode":"bm25","uuid":"3abeee81d94597629ed8cb943f182e94"}' ``` ```json {"count":1,"results":[{"text":"You won't find it difficult to make some new friends.","score":0.90}]} @@ -128,10 +119,7 @@ Parameters: - `limit`: max results ```bash -curl -X POST "http://localhost:3002/api/v1/file/3abeee81d94597629ed8cb943f182e94/face_trace/sortby" \ - -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \ - -H "Content-Type: application/json" \ - -d '{"sort_by":"face_count","limit":2}' +curl -X POST "http://localhost:3002/api/v1/file/3abeee81d94597629ed8cb943f182e94/face_trace/sortby" -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" -H "Content-Type: application/json" -d '{"sort_by":"face_count","limit":2}' ``` ```json {"success":true,"total_traces":6892,"total_faces":108204,"traces":[ @@ -147,8 +135,7 @@ Parameters: - `interpolate`: boolean (fills sparse gaps with lerp bbox) ```bash -curl "http://localhost:3002/api/v1/file/3abeee81d94597629ed8cb943f182e94/trace/2/faces?limit=2&interpolate=true" \ - -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" +curl "http://localhost:3002/api/v1/file/3abeee81d94597629ed8cb943f182e94/trace/2/faces?limit=2&interpolate=true" -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" ``` ```json {"success":true,"trace_id":2,"total":1,"faces":[ @@ -168,14 +155,12 @@ curl "http://localhost:3002/api/v1/file/3abeee81d94597629ed8cb943f182e94/trace/2 | 32 | GET | `/api/v1/file/:file_uuid/trace/:trace_id/video` | Trace clip (?padding=) | ```bash -curl -o thumb.jpg "http://localhost:3002/api/v1/file/3abeee81d94597629ed8cb943f182e94/thumbnail?frame=4650" \ - -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" +curl -o thumb.jpg "http://localhost:3002/api/v1/file/3abeee81d94597629ed8cb943f182e94/thumbnail?frame=4650" -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" ``` Returns JPEG binary (82KB, 1920×1080). ```bash -curl -o trace_clip.mp4 "http://localhost:3002/api/v1/file/3abeee81d94597629ed8cb943f182e94/trace/2/video" \ - -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" +curl -o trace_clip.mp4 "http://localhost:3002/api/v1/file/3abeee81d94597629ed8cb943f182e94/trace/2/video" -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" ``` Returns MP4 video binary (3.0MB) with bbox overlay. @@ -195,8 +180,7 @@ Returns MP4 video binary (3.0MB) with bbox overlay. | 40 | GET | `/api/v1/faces/candidates` | Unbound face gallery | ```bash -curl "http://localhost:3002/api/v1/identities?page=1&page_size=3" \ - -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" +curl "http://localhost:3002/api/v1/identities?page=1&page_size=3" -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" ``` ```json {"identities":[ @@ -207,8 +191,7 @@ curl "http://localhost:3002/api/v1/identities?page=1&page_size=3" \ ``` ```bash -curl "http://localhost:3002/api/v1/faces/candidates?page=1&page_size=2" \ - -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" +curl "http://localhost:3002/api/v1/faces/candidates?page=1&page_size=2" -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" ``` ```json {"total":42,"candidates":[{"frame_number":30,"confidence":0.85},...]} @@ -225,10 +208,7 @@ curl "http://localhost:3002/api/v1/faces/candidates?page=1&page_size=2" \ | 43 | POST | `/api/v1/identity/:from_uuid/mergeinto` | Merge two identities | ```bash -curl -X POST "http://localhost:3002/api/v1/identity/a9a90105-6d6b-46ff-92da-0c3c1a57dff4/bind" \ - -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \ - -H "Content-Type: application/json" \ - -d '{"file_uuid":"3abeee81d94597629ed8cb943f182e94","face_id":"face_42"}' +curl -X POST "http://localhost:3002/api/v1/identity/a9a90105-6d6b-46ff-92da-0c3c1a57dff4/bind" -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" -H "Content-Type: application/json" -d '{"file_uuid":"3abeee81d94597629ed8cb943f182e94","face_id":"face_42"}' ``` ```json {"success":true} @@ -245,8 +225,7 @@ curl -X POST "http://localhost:3002/api/v1/identity/a9a90105-6d6b-46ff-92da-0c3c | 46 | GET | `/api/v1/resources` | List all resources | ```bash -curl "http://localhost:3002/api/v1/resources" \ - -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" +curl "http://localhost:3002/api/v1/resources" -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" ``` ```json {"resources":[{"resource_id":"mxbai-embed-large-v1","resource_type":"embedding_model"}]} @@ -264,10 +243,7 @@ curl "http://localhost:3002/api/v1/resources" \ | 50 | GET | `/api/v1/agents/5w1h/status` | Job status | ```bash -curl -X POST "http://localhost:3002/api/v1/agents/translate" \ - -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" \ - -H "Content-Type: application/json" \ - -d '{"text":"Hello world","target_language":"zh-TW"}' +curl -X POST "http://localhost:3002/api/v1/agents/translate" -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b69" -H "Content-Type: application/json" -d '{"text":"Hello world","target_language":"zh-TW"}' ``` ```json {"success":true,"translated_text":"你好世界"}