99 incomplete
Incomplete / Undocumented APIs¶
This module tracks API endpoints that exist in the codebase but are either undocumented, partially documented, or stubs.
Note: Endpoints listed here should be fully documented and moved to their appropriate module once implemented.
Identity Binding¶
POST /api/v1/identity/:identity_uuid/bind¶
Auth: Required Scope: identity-level
Bind a single face detection to an identity. Unlike bind/trace which binds all faces in a trace, this binds one specific face.
Request Parameters¶
| Field | Type | Required | Description |
|---|---|---|---|
file_uuid |
string | Yes | File containing the face |
face_id |
string | Yes | Face detection ID to bind |
Status¶
⚠️ Undocumented — exists in code but no full request/response documentation.
Resource Management¶
POST /api/v1/resource/register¶
Auth: Required Scope: system-level
Register an external resource (e.g., storage backend, API service).
Status¶
⚠️ Undocumented — endpoint exists but no documentation.
POST /api/v1/resource/heartbeat¶
Auth: Required Scope: system-level
Send heartbeat for a registered resource to verify it's still alive.
Status¶
⚠️ Undocumented — endpoint exists but no documentation.
GET /api/v1/resources¶
Auth: Required Scope: system-level
List all registered resources with their status.
Status¶
⚠️ Undocumented — endpoint exists but no documentation.
5W1H Agent¶
POST /api/v1/agents/5w1h/analyze¶
Auth: Required Scope: file-level
Run 5W1H analysis on all cut scenes for a file. Uses LLM (Gemma4) to summarize each scene with who/what/where/when/why/how.
Status¶
⚠️ Partially documented — listed in 12_agent.md but missing full request/response examples.
POST /api/v1/agents/5w1h/batch¶
Auth: Required Scope: system-level
Run 5W1H analysis on multiple files at once.
Request Parameters¶
| Field | Type | Required | Description |
|---|---|---|---|
file_uuids |
string[] | Yes | Array of file UUIDs to analyze |
Status¶
⚠️ Partially documented — listed in 12_agent.md but missing full request/response examples.
GET /api/v1/agents/5w1h/status¶
Auth: Required Scope: system-level
Get 5W1H analysis status across all videos (which files have been analyzed, which are pending).
Status¶
⚠️ Partially documented — listed in 12_agent.md but missing full response schema.
Identity Agent¶
POST /api/v1/agents/identity/match-from-photo¶
Auth: Required Scope: system-level
Match an identity using an uploaded photo. Extracts face embedding, finds best trace match.
Status¶
⚠️ Partially documented — exists in 08_identity_agent.md but missing full response schema and error cases.
POST /api/v1/agents/identity/match-from-trace¶
Auth: Required Scope: file-level
Match an identity using a trace. Multi-angle embedding comparison with propagation.
Status¶
⚠️ Partially documented — exists in 08_identity_agent.md but missing full response schema and error cases.
Stubs / Not Implemented¶
Visual Search Endpoints¶
| Method | Endpoint | Status |
|---|---|---|
| POST | /api/v1/search/visual |
Stub — defined but not functional |
| POST | /api/v1/search/visual/class |
Stub — defined but not functional |
| POST | /api/v1/search/visual/density |
Stub — defined but not functional |
| POST | /api/v1/search/visual/combination |
Stub — defined but not functional |
| POST | /api/v1/search/visual/stats |
Stub — defined but not functional |
Unmounted Routes¶
These endpoints are defined in source code but not mounted in the router:
| Endpoint | Notes |
|---|---|
/api/v1/search/people |
✅ Mounted |
/api/v1/who |
Defined but not mounted |
/api/v1/who/candidates |
Defined but not mounted |
Tracking¶
| Count | Status |
|---|---|
| Undocumented | 3 (resource management) |
| Partially documented | 5 (5W1H ×3, identity agent ×2) |
| Stub/not functional | 5 (visual search) |
| Defined but unmounted | 2 (who, who/candidates) |
| Total | 16 |
Created: 2026-06-20 — Gap analysis from core API vs doc_wasm sync Updated: 2026-06-20 — Initial tracking list