Skip to content

API Documentation Index

Complete API reference for Momentry Core. All endpoints are documented with request/response formats, examples, and error handling.

📋 Module Overview

Core APIs (01-19)

Module File Description
01 auth Authentication - login, logout, JWT, API key
02 health Health check endpoints
03 register File registration
04 lookup File lookup and metadata
05 process Video processing pipeline
06 search Search operations
07 identity Identity management
08 identity_agent Identity agent operations
08 media Media access and proxy
09 tmdb TMDb integration
10 pipeline Pipeline management
11 error_codes Error code reference
12 agent Agent API
13 config Configuration management
14 identity_history Identity history tracking
15 tkg Temporal Knowledge Graph
16 workspace Workspace management
17 progress Progress tracking
18 profile File profile and metadata
19 people_api People management API

New APIs (20-24)

Module File Description Status
20 service_management_api Service start/stop/health ✅ P0 - Critical
21 monitor_api Queue/Worker/Pipeline monitoring ✅ P1 - Important
22 trace_agent_api Trace and TKG operations ✅ P1 - Important
23 vlm_search_api Vision Language Model search ✅ P1 - Important
24 pose_appearance_api Pose keypoints and appearance colors ✅ P2 - Standard

Studio Team Guides (21-26)

Module File Description
21 studio_team_guide.md Integration guide for Studio team
22 studio_pipeline_changes.md Pipeline changes documentation
23 studio_face_group_name_fix.md Face group name fix guide
24 studio_trace_profile_read_write_bug.md Trace profile bug documentation
25 face_filter_api.md Face filtering API
26 trace_thumbnail_regenerate.md Thumbnail regeneration

Additional Modules

File Description
scene_vlm_stats_api.md Scene VLM statistics API
99_incomplete.md Incomplete features reference
_template.md Documentation template

🔍 Quick Reference by Category

Authentication & Security

  • Auth API - Login, logout, JWT tokens, API keys

File Operations

Search & Query

  • Search - General search
  • VLM Search - Vision Language Model search
  • TKG - Temporal Knowledge Graph

Identity & People

System & Monitoring

Media & Content

  • Media - Media access
  • TMDb - TMDb integration

Configuration & Management

📖 Usage Guidelines

Authentication

Most API endpoints require authentication via API key:

curl -H "X-API-Key: your-api-key" \
     http://localhost:3002/api/v1/...

See Auth API for details.

Base URLs

Environment Base URL
Production http://localhost:3002
External https://m5api.momentry.ddns.net
Development http://localhost:3003

Common Patterns

File Processing

  1. Register file: POST /api/v1/register
  2. Process file: POST /api/v1/process
  3. Check progress: GET /api/v1/progress/{file_uuid}
  4. Search results: GET /api/v1/search

Identity Management

  1. List identities: GET /api/v1/identities
  2. Bind faces: POST /api/v1/identities/{identity_uuid}/bind
  3. Search identities: GET /api/v1/search/identities

🔧 Development

Adding New Endpoints

  1. Use _template.md
  2. Follow naming convention: NN_topic.md
  3. Add YAML frontmatter
  4. Include complete examples
  5. Add to this index

Documentation Standards

All modules must include: - ✅ YAML frontmatter - ✅ Module metadata (module, description, depends) - ✅ Endpoint documentation with examples - ✅ Error codes - ✅ Version history

📊 Statistics

Metric Count
Total API Modules 31
Core APIs 20
New APIs 5
Studio Guides 6
Total Endpoints 100+

Version History

Version Date Changes
1.0 2026-10-24 Initial comprehensive API index

Last Updated: 2026-10-24
Maintained By: Core Team