Skip to content

INDEX.md

Latest commit

 

History

History
164 lines (156 loc) · 18.3 KB

INDEX.md

File metadata and controls

164 lines (156 loc) · 18.3 KB

Anycast API 設計

概要

  • ベース URL: /api/v1
  • 形式: REST API
  • データ形式: JSON
  • 認証: Bearer Token（JWT）/ API Key（X-API-Key ヘッダーまたは Authorization: Bearer ak_...）

API 一覧

メソッド パス 説明 権限 実装 詳細
システム - - - - -
GET /health ヘルスチェック - ✅ -
GET /swagger/* Swagger UI（開発環境のみ） - ✅ -
Auth（認証） - - - - auth.md
POST /api/v1/auth/register ユーザー登録 Guest ✅ 詳細
POST /api/v1/auth/login メール/パスワード認証 Guest ✅ 詳細
POST /api/v1/auth/oauth/google Google OAuth 認証 Guest ✅ 詳細
POST /api/v1/auth/refresh トークンリフレッシュ Guest ✅ 詳細
POST /api/v1/auth/logout ログアウト Owner ✅ 詳細
PUT /api/v1/auth/password パスワード更新 Owner ✅ 詳細
API Keys（API キー） - - - - api-keys.md
POST /api/v1/me/api-keys API キー作成 Owner ✅ 詳細
GET /api/v1/me/api-keys API キー一覧取得 Owner ✅ 詳細
DELETE /api/v1/me/api-keys/:apiKeyId API キー削除 Owner ✅ 詳細
Users（ユーザー） - - - - users.md
GET /api/v1/users/:username ユーザー取得 Public ✅ 詳細
GET /api/v1/me 現在のユーザー取得 Owner ✅ 詳細
PATCH /api/v1/me ユーザー情報更新 Owner ✅ 詳細
PATCH /api/v1/me/username ユーザー名変更 Owner ✅ 詳細
GET /api/v1/me/username/check ユーザー名利用可否チェック Owner ✅ 詳細
PATCH /api/v1/me/prompt ユーザープロンプト更新 Owner ✅ 詳細
DELETE /api/v1/me アカウント削除 Owner ✅ 詳細
Channels - - - - channels.md
GET /api/v1/channels/:channelId チャンネル取得 Optional ✅ 詳細
POST /api/v1/channels チャンネル作成 Owner ✅ 詳細
PATCH /api/v1/channels/:channelId チャンネル更新 Owner ✅ 詳細
DELETE /api/v1/channels/:channelId チャンネル削除 Owner ✅ 詳細
POST /api/v1/channels/:channelId/publish チャンネル公開 Owner ✅ 詳細
POST /api/v1/channels/:channelId/unpublish チャンネル非公開 Owner ✅ 詳細
PUT /api/v1/channels/:channelId/user-prompt 台本プロンプト設定 Owner ✅ 詳細
PUT /api/v1/channels/:channelId/default-bgm デフォルト BGM 設定 Owner ✅ 詳細
DELETE /api/v1/channels/:channelId/default-bgm デフォルト BGM 削除 Owner ✅ 詳細
GET /api/v1/me/channels 自分のチャンネル一覧 Owner ✅ 詳細
GET /api/v1/me/channels/:channelId 自分のチャンネル取得 Owner ✅ 詳細
Characters - - - - characters.md
GET /api/v1/me/characters キャラクター一覧取得 Owner ✅ 詳細
GET /api/v1/me/characters/:characterId キャラクター取得 Owner ✅ 詳細
POST /api/v1/me/characters キャラクター作成 Owner ✅ 詳細
PATCH /api/v1/me/characters/:characterId キャラクター更新 Owner ✅ 詳細
DELETE /api/v1/me/characters/:characterId キャラクター削除 Owner ✅ 詳細
POST /api/v1/channels/:channelId/characters チャンネルにキャラクター追加 Owner ✅ 詳細
PUT /api/v1/channels/:channelId/characters/:characterId チャンネルのキャラクター置換 Owner ✅ 詳細
DELETE /api/v1/channels/:channelId/characters/:characterId チャンネルからキャラクター削除 Owner ✅ 詳細
BGMs（BGM） - - - - bgms.md
GET /api/v1/me/bgms BGM 一覧取得 Owner ✅ 詳細
GET /api/v1/me/bgms/:bgmId BGM 取得 Owner ✅ 詳細
POST /api/v1/me/bgms BGM 作成 Owner ✅ 詳細
PATCH /api/v1/me/bgms/:bgmId BGM 更新 Owner ✅ 詳細
DELETE /api/v1/me/bgms/:bgmId BGM 削除 Owner ✅ 詳細
Episodes - - - - episodes.md
GET /api/v1/channels/:channelId/episodes エピソード一覧取得 Optional ✅ 詳細
GET /api/v1/channels/:channelId/episodes/:episodeId エピソード取得 Optional ✅ 詳細
POST /api/v1/channels/:channelId/episodes エピソード作成 Owner ✅ 詳細
PATCH /api/v1/channels/:channelId/episodes/:episodeId エピソード更新 Owner ✅ 詳細
DELETE /api/v1/channels/:channelId/episodes/:episodeId エピソード削除 Owner ✅ 詳細
POST /api/v1/channels/:channelId/episodes/:episodeId/publish エピソード公開 Owner ✅ 詳細
POST /api/v1/channels/:channelId/episodes/:episodeId/unpublish エピソード非公開 Owner ✅ 詳細
PUT /api/v1/channels/:channelId/episodes/:episodeId/bgm エピソード BGM 設定 Owner ✅ 詳細
DELETE /api/v1/channels/:channelId/episodes/:episodeId/bgm エピソード BGM 削除 Owner ✅ 詳細
PUT /api/v1/channels/:channelId/episodes/:episodeId/audio エピソード音声アップロード Owner ✅ 詳細
DELETE /api/v1/channels/:channelId/episodes/:episodeId/audio エピソード音声削除 Owner ✅ 詳細
GET /api/v1/me/channels/:channelId/episodes 自分のチャンネルのエピソード一覧 Owner ✅ 詳細
GET /api/v1/me/channels/:channelId/episodes/:episodeId 自分のチャンネルのエピソード取得 Owner ✅ 詳細
POST /api/v1/episodes/:episodeId/play 再生回数カウント Owner ✅ 詳細
Script（台本） - - - - script.md
POST /api/v1/channels/:channelId/episodes/:episodeId/script/generate-async 台本を AI で生成（非同期） Owner ✅ 詳細
GET /api/v1/channels/:channelId/episodes/:episodeId/script-jobs/latest 最新完了済み台本生成ジョブ取得 Owner ✅ 詳細
GET /api/v1/script-jobs/:jobId 台本生成ジョブ取得 Owner ✅ 詳細
POST /api/v1/script-jobs/:jobId/cancel 台本生成ジョブキャンセル Owner ✅ 詳細
GET /api/v1/me/script-jobs 自分の台本生成ジョブ一覧 Owner ✅ 詳細
POST /api/v1/channels/:channelId/episodes/:episodeId/script/import 台本テキスト取り込み Owner ✅ 詳細
GET /api/v1/channels/:channelId/episodes/:episodeId/script/export 台本テキスト出力 Owner ✅ 詳細
GET /api/v1/channels/:channelId/episodes/:episodeId/script/lines 台本行一覧取得 Owner ✅ 詳細
POST /api/v1/channels/:channelId/episodes/:episodeId/script/lines 行追加 Owner ✅ 詳細
PATCH /api/v1/channels/:channelId/episodes/:episodeId/script/lines/:lineId 行更新 Owner ✅ 詳細
DELETE /api/v1/channels/:channelId/episodes/:episodeId/script/lines/:lineId 行削除 Owner ✅ 詳細
DELETE /api/v1/channels/:channelId/episodes/:episodeId/script/lines 全行削除 Owner ✅ 詳細
POST /api/v1/channels/:channelId/episodes/:episodeId/script/reorder 行並び替え Owner ✅ 詳細
Audio（音声生成） - - - - media.md
POST /api/v1/channels/:channelId/episodes/:episodeId/audio/generate-async 非同期音声生成（voice/full/remix） Owner ✅ 詳細
GET /api/v1/audio-jobs/:jobId 音声生成ジョブ取得 Owner ✅ 詳細
POST /api/v1/audio-jobs/:jobId/cancel 音声生成ジョブキャンセル Owner ✅ 詳細
GET /api/v1/me/audio-jobs 自分の音声生成ジョブ一覧 Owner ✅ 詳細
POST /api/v1/audios 音声アップロード Owner ✅ 詳細
WebSocket - - - - media.md
WS /ws/jobs ジョブのリアルタイム通知（音声・台本共通） Owner ✅ 詳細
Images（画像ファイル） - - - - media.md
POST /api/v1/images 画像アップロード Owner ✅ 詳細
POST /api/v1/images/generate AI 画像生成 Owner ✅ 詳細
Recommendations（おすすめ） - - - - recommendations.md
GET /api/v1/recommendations/channels おすすめチャンネル取得 Optional ✅ 詳細
GET /api/v1/recommendations/episodes おすすめエピソード取得 Optional ✅ 詳細
Search（検索） - - - - engagement.md
GET /api/v1/search/channels チャンネル検索 Public ✅ 詳細
GET /api/v1/search/episodes エピソード検索 Public ✅ 詳細
GET /api/v1/search/users ユーザー検索 Public ✅ 詳細
Reactions（リアクション） - - - - engagement.md
GET /api/v1/episodes/:episodeId/reactions リアクション状態取得 Owner ✅ 詳細
POST /api/v1/episodes/:episodeId/reactions リアクション登録（like/bad） Owner ✅ 詳細
DELETE /api/v1/episodes/:episodeId/reactions リアクション解除 Owner ✅ 詳細
GET /api/v1/me/likes 高評価したエピソード一覧 Owner ✅ 詳細
Playlists（再生リスト） - - - - engagement.md
GET /api/v1/me/playlists 再生リスト一覧取得 Owner ✅ 詳細
GET /api/v1/me/playlists/:playlistId 再生リスト詳細取得 Owner ✅ 詳細
POST /api/v1/me/playlists 再生リスト作成 Owner ✅ 詳細
PATCH /api/v1/me/playlists/:playlistId 再生リスト更新 Owner ✅ 詳細
DELETE /api/v1/me/playlists/:playlistId 再生リスト削除 Owner ✅ 詳細
POST /api/v1/me/playlists/:playlistId/items/reorder 再生リストアイテム並び替え Owner ✅ 詳細
PUT /api/v1/episodes/:episodeId/playlists エピソードの再生リスト所属一括更新 Owner ✅ 詳細
Playback History（再生履歴） - - - - engagement.md
PUT /api/v1/episodes/:episodeId/playback 再生履歴を更新 Owner ✅ 詳細
DELETE /api/v1/episodes/:episodeId/playback 再生履歴を削除 Owner ✅ 詳細
GET /api/v1/me/playback-history 再生履歴一覧を取得 Owner ✅ 詳細
DELETE /api/v1/me/playback-history 再生履歴をすべて削除 Owner ✅ 詳細
POST /api/v1/me/playback-history/batch-delete 再生履歴を一括削除 Owner 詳細
Follows（フォロー） - - - - engagement.md
GET /api/v1/users/:username/follow フォロー状態取得 Owner ✅ 詳細
POST /api/v1/users/:username/follow フォロー登録 Owner ✅ 詳細
DELETE /api/v1/users/:username/follow フォロー解除 Owner ✅ 詳細
GET /api/v1/me/follows フォロー中のユーザー一覧 Owner ✅ 詳細
Comments（コメント） - - - - engagement.md
POST /api/v1/episodes/:episodeId/comments コメント投稿 Owner 詳細
GET /api/v1/episodes/:episodeId/comments コメント一覧取得 Public 詳細
PATCH /api/v1/comments/:commentId コメント編集 Owner/Admin 詳細
DELETE /api/v1/comments/:commentId コメント削除 Owner/Admin 詳細
GET /api/v1/me/comments 自分のコメント一覧 Owner 詳細
Voices（ボイス） - - - - master.md
GET /api/v1/voices ボイス一覧取得 Owner ✅ 詳細
GET /api/v1/voices/:voiceId ボイス取得 Owner ✅ 詳細
POST /api/v1/voices/:voiceId/favorite ボイスお気に入り登録 Owner ✅ 詳細
DELETE /api/v1/voices/:voiceId/favorite ボイスお気に入り解除 Owner ✅ 詳細
Categories（カテゴリ） - - - - master.md
GET /api/v1/categories カテゴリ一覧取得 Optional ✅ 詳細
GET /api/v1/categories/:slug カテゴリ取得（スラッグ指定） Optional ✅ 詳細
Feedbacks（フィードバック） - - - - feedbacks.md
POST /api/v1/feedbacks フィードバック送信 Owner ✅ 詳細
Contacts（お問い合わせ） - - - - contacts.md
POST /api/v1/contacts お問い合わせ送信 Optional ✅ 詳細
Admin（管理者） - - - - admin.md
POST /admin/cleanup/orphaned-media 孤児メディアファイル削除 Admin ✅ 詳細
Dev（開発用） - - - - -
POST /dev/script/generate 台本直接生成（DB 不要） - ✅ 開発環境のみ有効

関連ドキュメント

  • 共通仕様 - レスポンス形式、ページネーション、権限、公開状態によるアクセス制御
  • エラーコード一覧 - API で返却されるエラーコード一覧