APIリファレンス
Subseek の Hono API サーバーの公開エンドポイント仕様。各エンドポイントのページは docusaurus-plugin-openapi-docs によって OpenAPI スキーマから自動生成されている。
エンドポイント分類
| カテゴリ | 主な用途 |
|---|---|
| Search | 字幕の全文検索 |
| Channels | チャンネル取得・検索・解決 |
| Search History | 検索履歴の保存・取得 |
| Credits | 動画アクセスのクレジット消費 |
| User | サブスク情報取得・Google プロフィール同期 |
| Contact | お問い合わせフォーム送信 |
| Subtitle Fetch | 字幕取得ジョブの進捗ポーリング |
全エンドポイントの一覧は subseek-api を参照。
自動生成の更新手順
apps/api で OpenAPI スキーマ(openapi.json 等)を更新したあと、以下を実行して mdx を再生成する。
pnpm --filter @subseek/docs gen-api-docs
既存の生成物を一旦消す場合は pnpm --filter @subseek/docs clean-api-docs を併用する。