Files
ai/docs/system_a/06_API接口设计文档.md
T
2026-06-15 17:45:28 +08:00

3.9 KiB
Executable File

06_API接口设计文档

1. 通用返回格式

{
  "code": 0,
  "message": "success",
  "data": {},
  "request_id": "req_xxx"
}

2. 认证接口

POST /api/auth/register
POST /api/auth/login
POST /api/auth/logout
GET  /api/auth/profile

3. 项目接口

POST /api/projects
GET  /api/projects
GET  /api/projects/:id
PATCH /api/projects/:id
POST /api/projects/:id/cancel
DELETE /api/projects/:id

创建项目:

{
  "title": "重生归来,我不再爱你",
  "input_mode": "ai_original",
  "genre": "urban_rebirth",
  "style_code": "korean_comic",
  "output_type": "short_video",
  "target_episode_count": 3,
  "episode_duration": 60
}

4. AI 原创小说接口

POST /api/projects/:id/original/idea
POST /api/projects/:id/original/outline
POST /api/projects/:id/original/chapters
POST /api/projects/:id/original/self-check
GET  /api/projects/:id/original/result

5. 上传小说接口

POST /api/projects/:id/novel/upload
POST /api/projects/:id/novel/paste
POST /api/projects/:id/novel/parse
GET  /api/projects/:id/novel/parse-result
PATCH /api/novel-chapters/:chapterId

6. 版权确认接口

POST /api/projects/:id/copyright/confirm
GET  /api/projects/:id/copyright

请求:

{
  "authorization_type": "author_self",
  "statement_text": "我确认拥有该小说的合法改编权。"
}

7. 故事圣经接口

POST /api/projects/:id/story-bible/generate
GET  /api/projects/:id/story-bible
PATCH /api/projects/:id/story-bible
POST /api/projects/:id/story-bible/confirm

8. 角色接口

POST /api/projects/:id/characters/extract
GET  /api/projects/:id/characters
POST /api/projects/:id/characters
PATCH /api/characters/:characterId
DELETE /api/characters/:characterId
POST /api/characters/:characterId/generate-images
POST /api/characters/:characterId/set-anchor
GET  /api/characters/:characterId/memories

9. 分集接口

POST /api/projects/:id/episodes/generate-plan
GET  /api/projects/:id/episodes
PATCH /api/episodes/:episodeId
POST /api/projects/:id/episodes/confirm

10. 脚本接口

POST /api/episodes/:episodeId/script/generate
GET  /api/episodes/:episodeId/script
PATCH /api/episodes/:episodeId/script
POST /api/episodes/:episodeId/script/confirm

11. 分镜接口

POST /api/episodes/:episodeId/storyboard/generate
GET  /api/episodes/:episodeId/storyboard
PATCH /api/storyboard-shots/:shotId
DELETE /api/storyboard-shots/:shotId
POST /api/episodes/:episodeId/storyboard/confirm
POST /api/storyboard-shots/:shotId/regenerate-prompt

12. 长篇记忆接口

GET  /api/projects/:id/plot-memories
POST /api/projects/:id/plot-memories/generate
GET  /api/projects/:id/plot-threads
POST /api/projects/:id/plot-threads
PATCH /api/plot-threads/:threadId
POST /api/episodes/:episodeId/continuity-check

13. 生成接口

POST /api/episodes/:episodeId/preview/generate
POST /api/episodes/:episodeId/final/generate-images
POST /api/episodes/:episodeId/audio/generate
POST /api/episodes/:episodeId/subtitle/generate
POST /api/episodes/:episodeId/video/render
GET  /api/projects/:id/progress
GET  /api/episodes/:episodeId/assets

14. 修改申请接口

POST /api/projects/:id/revisions
GET  /api/projects/:id/revisions

15. 后台接口

GET  /api/admin/projects
GET  /api/admin/projects/:id
POST /api/admin/tasks/:id/retry
POST /api/admin/tasks/:id/cancel
POST /api/admin/tasks/:id/manual-required
GET  /api/admin/tasks
GET  /api/admin/provider-logs
GET  /api/admin/costs
POST /api/admin/projects/:id/manual-review

16. 案例和数据接口

GET  /api/cases
GET  /api/cases/:id
POST /api/admin/cases
PATCH /api/admin/cases/:id
POST /api/projects/:id/analytics/import
GET  /api/projects/:id/analytics