297 lines
12 KiB
HTML
297 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<title>04 Lookup - Momentry API Docs</title>
|
|
<style>
|
|
* { margin: 0; padding: 0; box-sizing: border-box; }
|
|
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; background: #f5f5f5; color: #333; padding: 40px; }
|
|
.container { max-width: 960px; margin: 0 auto; background: white; border-radius: 12px; box-shadow: 0 2px 12px rgba(0,0,0,0.08); padding: 40px; }
|
|
h1 { font-size: 24px; margin: 24px 0 12px; }
|
|
h2 { font-size: 20px; margin: 20px 0 10px; color: #222; }
|
|
h3 { font-size: 16px; margin: 16px 0 8px; color: #444; }
|
|
p { line-height: 1.6; margin: 8px 0; }
|
|
table { border-collapse: collapse; width: 100%; margin: 12px 0; font-size: 14px; }
|
|
th, td { border: 1px solid #ddd; padding: 8px 12px; text-align: left; }
|
|
th { background: #f0f0f0; font-weight: 600; }
|
|
code { background: #f0f0f0; padding: 2px 6px; border-radius: 3px; font-size: 13px; }
|
|
pre { background: #f8f8f8; border: 1px solid #ddd; border-radius: 6px; padding: 12px; overflow-x: auto; margin: 12px 0; }
|
|
pre code { background: none; padding: 0; }
|
|
a { color: #0066cc; }
|
|
.back { display: inline-block; margin-bottom: 20px; color: #666; }
|
|
.back:hover { color: #333; }
|
|
.topbar { display: flex; justify-content: space-between; align-items: center; margin-bottom: 20px; }
|
|
.logout-btn { font-size: 13px; color: #999; text-decoration: none; }
|
|
.logout-btn:hover { color: #cc0000; }
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<div class="container">
|
|
<div class="topbar">
|
|
<a class="back" href="index.html">← Back to index</a>
|
|
<a class="logout-btn" href="#" onclick="fetch('/api/v1/auth/logout',{method:'POST'}).then(()=>window.location.reload());return false">Logout</a>
|
|
</div>
|
|
<!-- module: lookup -->
|
|
<!-- description: File lookup by name and unregistration -->
|
|
<!-- depends: 01_auth, 03_register -->
|
|
|
|
<h2>File Lookup</h2>
|
|
<h3><code>GET /api/v1/files/lookup</code></h3>
|
|
<p><strong>Auth</strong>: Required
|
|
<strong>Scope</strong>: file-level</p>
|
|
<p>Search registered files by file name. Performs a case-insensitive LIKE search on the file name column. Returns basic info about matching files.</p>
|
|
<h4>Query Parameters</h4>
|
|
<table class="table">
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Required</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>file_name</code></td>
|
|
<td>string</td>
|
|
<td>Yes</td>
|
|
<td>File name to search for (partial matches supported)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4>Example</h4>
|
|
<div class="codehilite"><pre><span></span><code><span class="c1"># Look up a specific file</span>
|
|
curl<span class="w"> </span>-s<span class="w"> </span><span class="s2">"</span><span class="nv">$API</span><span class="s2">/api/v1/files/lookup?file_name=video.mp4"</span><span class="w"> </span><span class="se">\</span>
|
|
<span class="w"> </span>-H<span class="w"> </span><span class="s2">"X-API-Key: </span><span class="nv">$KEY</span><span class="s2">"</span>
|
|
|
|
<span class="c1"># Partial name search</span>
|
|
curl<span class="w"> </span>-s<span class="w"> </span><span class="s2">"</span><span class="nv">$API</span><span class="s2">/api/v1/files/lookup?file_name=charade"</span><span class="w"> </span><span class="se">\</span>
|
|
<span class="w"> </span>-H<span class="w"> </span><span class="s2">"X-API-Key: </span><span class="nv">$KEY</span><span class="s2">"</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span><span class="s1">'.matches[].file_name'</span>
|
|
</code></pre></div>
|
|
|
|
<h4>Response (200)</h4>
|
|
<div class="codehilite"><pre><span></span><code><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"file_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"video.mp4"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"exists"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"matches"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"file_uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a03485a40b2df2d3"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"file_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"video.mp4"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"file_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"video"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"completed"</span>
|
|
<span class="w"> </span><span class="p">}</span>
|
|
<span class="w"> </span><span class="p">],</span>
|
|
<span class="w"> </span><span class="nt">"next_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"video (2).mp4"</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
|
|
<table class="table">
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>file_name</code></td>
|
|
<td>string</td>
|
|
<td>Searched name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exists</code></td>
|
|
<td>boolean</td>
|
|
<td>Exact name match exists</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>matches</code></td>
|
|
<td>array</td>
|
|
<td>Array of matching registered files</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>matches[].file_uuid</code></td>
|
|
<td>string</td>
|
|
<td>32-char hex UUID</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>matches[].file_name</code></td>
|
|
<td>string</td>
|
|
<td>Registered file name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>matches[].file_type</code></td>
|
|
<td>string</td>
|
|
<td><code>"video"</code>, <code>"audio"</code>, or <code>null</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>matches[].status</code></td>
|
|
<td>string</td>
|
|
<td>Registration/processing status</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>next_name</code></td>
|
|
<td>string</td>
|
|
<td>Suggested name for avoiding conflicts</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr />
|
|
<h2>Unregister</h2>
|
|
<h3><code>POST /api/v1/unregister</code></h3>
|
|
<p><strong>Auth</strong>: Required
|
|
<strong>Scope</strong>: file-level</p>
|
|
<p>Delete a registered file from the system. Supports single file by UUID, or batch by directory + regex pattern.</p>
|
|
<h4>What gets deleted</h4>
|
|
<table class="table">
|
|
<thead>
|
|
<tr>
|
|
<th>Removed (default)</th>
|
|
<th>Not removed</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>Database records (videos, chunks, embeddings, processor_results, pre_chunks)</td>
|
|
<td>The original source video file on disk</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Processor output JSON files (<code>{uuid}.*.json</code>) — unless <code>delete_output_files: false</code></td>
|
|
<td>Temp/working directories</td>
|
|
</tr>
|
|
<tr>
|
|
<td>In-memory cache entries</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>MongoDB cached lists</td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<blockquote>
|
|
<p>⚠️ Database deletion is <strong>irreversible</strong>. To keep output files, set <code>"delete_output_files": false</code>.</p>
|
|
</blockquote>
|
|
<h4>Request Parameters</h4>
|
|
<p>At least one mode must be specified: either <code>file_uuid</code> alone, or <code>file_path</code> + <code>pattern</code> together.</p>
|
|
<table class="table">
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Required</th>
|
|
<th>Default</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>file_uuid</code></td>
|
|
<td>string</td>
|
|
<td>*</td>
|
|
<td>—</td>
|
|
<td>Single file UUID to delete</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>file_path</code></td>
|
|
<td>string</td>
|
|
<td>*</td>
|
|
<td>—</td>
|
|
<td>Directory path (for batch delete)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>pattern</code></td>
|
|
<td>string</td>
|
|
<td>*</td>
|
|
<td>—</td>
|
|
<td>Regex pattern (requires <code>file_path</code>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>delete_output_files</code></td>
|
|
<td>boolean</td>
|
|
<td>No</td>
|
|
<td><code>true</code></td>
|
|
<td>If <code>true</code>, also delete processor output JSON files (<code>{uuid}.*.json</code>). Set to <code>false</code> to keep them.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4>Example</h4>
|
|
<div class="codehilite"><pre><span></span><code><span class="c1"># Delete a single file by UUID (default: also deletes output JSON files)</span>
|
|
curl<span class="w"> </span>-s<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s2">"</span><span class="nv">$API</span><span class="s2">/api/v1/unregister"</span><span class="w"> </span><span class="se">\</span>
|
|
<span class="w"> </span>-H<span class="w"> </span><span class="s2">"Content-Type: application/json"</span><span class="w"> </span><span class="se">\</span>
|
|
<span class="w"> </span>-H<span class="w"> </span><span class="s2">"X-API-Key: </span><span class="nv">$KEY</span><span class="s2">"</span><span class="w"> </span><span class="se">\</span>
|
|
<span class="w"> </span>-d<span class="w"> </span><span class="s1">'{"file_uuid": "'</span><span class="s2">"</span><span class="nv">$FILE_UUID</span><span class="s2">"</span><span class="s1">'"}'</span>
|
|
|
|
<span class="c1"># Keep output JSON files, only delete DB records</span>
|
|
curl<span class="w"> </span>-s<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s2">"</span><span class="nv">$API</span><span class="s2">/api/v1/unregister"</span><span class="w"> </span><span class="se">\</span>
|
|
<span class="w"> </span>-H<span class="w"> </span><span class="s2">"Content-Type: application/json"</span><span class="w"> </span><span class="se">\</span>
|
|
<span class="w"> </span>-H<span class="w"> </span><span class="s2">"X-API-Key: </span><span class="nv">$KEY</span><span class="s2">"</span><span class="w"> </span><span class="se">\</span>
|
|
<span class="w"> </span>-d<span class="w"> </span><span class="s1">'{"file_uuid": "'</span><span class="s2">"</span><span class="nv">$FILE_UUID</span><span class="s2">"</span><span class="s1">'", "delete_output_files": false}'</span>
|
|
|
|
<span class="c1"># Batch delete all mp4 files in a directory</span>
|
|
curl<span class="w"> </span>-s<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s2">"</span><span class="nv">$API</span><span class="s2">/api/v1/unregister"</span><span class="w"> </span><span class="se">\</span>
|
|
<span class="w"> </span>-H<span class="w"> </span><span class="s2">"Content-Type: application/json"</span><span class="w"> </span><span class="se">\</span>
|
|
<span class="w"> </span>-H<span class="w"> </span><span class="s2">"X-API-Key: </span><span class="nv">$KEY</span><span class="s2">"</span><span class="w"> </span><span class="se">\</span>
|
|
<span class="w"> </span>-d<span class="w"> </span><span class="s1">'{"file_path": "/path/to/dir", "pattern": ".*\\.mp4$"}'</span>
|
|
</code></pre></div>
|
|
|
|
<h4>Response (200)</h4>
|
|
<div class="codehilite"><pre><span></span><code><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"success"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"file_uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a03485a40b2df2d3"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Video unregistered successfully"</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
|
|
<table class="table">
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>success</code></td>
|
|
<td>boolean</td>
|
|
<td>True if deletion succeeded</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>file_uuid</code></td>
|
|
<td>string</td>
|
|
<td>UUID of the deleted file (single mode)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>message</code></td>
|
|
<td>string</td>
|
|
<td>Human-readable status</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4>Error Responses</h4>
|
|
<table class="table">
|
|
<thead>
|
|
<tr>
|
|
<th>HTTP</th>
|
|
<th>When</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>400</code></td>
|
|
<td>Neither <code>file_uuid</code> nor <code>file_path</code>+<code>pattern</code> provided</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>404</code></td>
|
|
<td>File UUID not found</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>401</code></td>
|
|
<td>Missing or invalid API key</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</body>
|
|
</html> |