{ "openapi": "3.1.0", "info": { "title": "Backend 源码接口", "description": "API service for App Factory reusable modules", "version": "1.0.0", "x-source-commit": "f33cc2b935f31b36240d724948dc8b9c765430cc" }, "paths": { "/api/v1/health/": { "get": { "tags": [ "health", "健康检查" ], "summary": "基础健康检查", "description": "返回应用的基本健康状态信息，用于快速检测应用是否正常运行。", "operationId": "health_check_api_v1_health__get", "responses": { "200": { "description": "应用健康", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" }, "example": { "status": "healthy", "version": "1.0.0", "timestamp": "2024-01-01T00:00:00Z" } } } } } } }, "/api/v1/health/detailed": { "get": { "tags": [ "health", "健康检查" ], "summary": "详细健康检查", "description": "返回更详细的系统状态信息。", "operationId": "detailed_health_check_api_v1_health_detailed_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } } } } } }, "/api/v1/health/ready": { "get": { "tags": [ "health", "健康检查" ], "summary": "就绪检查", "description": "检查所有依赖服务的连接状态，用于 Kubernetes 就绪探针。\n\n返回各服务的状态：\n- **database**: PostgreSQL 数据库连接状态\n- **redis**: Redis 缓存服务连接状态", "operationId": "readiness_check_api_v1_health_ready_get", "responses": { "200": { "description": "所有服务就绪", "content": { "application/json": { "schema": {}, "example": { "status": "ready", "checks": { "database": { "status": "healthy", "latency_ms": 5.23 }, "redis": { "status": "healthy", "latency_ms": 1.05 } }, "version": "1.0.0", "environment": "production", "timestamp": "2024-01-01T00:00:00Z" } } } }, "503": { "description": "服务未就绪", "content": { "application/json": { "example": { "status": "not_ready", "checks": { "database": { "status": "unhealthy", "error": "Connection refused" }, "redis": { "status": "healthy", "latency_ms": 1.05 } }, "version": "1.0.0", "environment": "production", "timestamp": "2024-01-01T00:00:00Z" } } } } } } }, "/api/v1/storage": { "get": { "tags": [ "storage" ], "summary": "List Files And Folders", "operationId": "list_files_and_folders_api_v1_storage_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" } }, { "name": "asset_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Asset Type" } }, { "name": "parent_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Parent Id" } }, { "name": "is_favorite", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Favorite" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Page Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/storage/upload": { "post": { "tags": [ "storage" ], "summary": "Upload Tool File", "description": "工具侧文件上传（鉴权）。\n\n不创建 user_assets、不占用用户云存储配额。\n返回 URL 供后续工具处理；兼容旧客户端对 asset.file_url 的解析。\n匿名工具上传请走 /api/v1/upload/minio。", "operationId": "upload_tool_file_api_v1_storage_upload_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_tool_file_api_v1_storage_upload_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/storage/{asset_id}": { "delete": { "tags": [ "storage" ], "summary": "Delete Asset", "operationId": "delete_asset_api_v1_storage__asset_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Asset Id" } } ], "responses": { "410": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/storage/batch-move": { "post": { "tags": [ "storage" ], "summary": "Batch Move Assets", "operationId": "batch_move_assets_api_v1_storage_batch_move_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchMoveRequest" } } }, "required": true }, "responses": { "410": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "boolean", "title": "Response Batch Move Assets Api V1 Storage Batch Move Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/storage/files/{path}": { "get": { "tags": [ "storage" ], "summary": "Get File", "description": "获取本地存储的文件，支持 Range 请求和 CORS（工具处理产物，非用户云盘）", "operationId": "get_file_api_v1_storage_files__path__get", "parameters": [ { "name": "path", "in": "path", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/resolve": { "post": { "tags": [ "resolve" ], "summary": "Resolve", "description": "统一内容解析接口 - 支持抖音/快手/小红书/B站/TikTok/YouTube\n\n返回统一格式的数据结构，包含：\n- 基本信息：title, type, video_url, audio_url, cover_url, platform\n- 作者信息：author, author_id, author_avatar\n- 视频属性：duration, width, height\n- 统计数据：view_count, like_count, comment_count, share_count, collect_count\n- 发布时间：release_time", "operationId": "resolve_api_v1_resolve_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agent/tasks": { "post": { "tags": [ "agent" ], "summary": "Run Agent Task", "description": "Submit a new agent task.\nRequires authentication.", "operationId": "run_agent_task_api_v1_agent_tasks_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTaskCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTaskResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/agent/tasks/{task_id}": { "get": { "tags": [ "agent" ], "summary": "Get Agent Task", "description": "Get the status and result of an agent task.\nRequires authentication.", "operationId": "get_agent_task_api_v1_agent_tasks__task_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTaskResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agent/tasks/{task_id}/stream": { "get": { "tags": [ "agent" ], "summary": "Stream Agent Task", "description": "Stream agent task updates using SSE.\n\nSupports two frame types:\n- **Snapshot frames** (default, no ``event:`` field): full ``AgentTaskResponse`` JSON.\n Sent on every task state change.\n- **Incremental frames** (typed with ``event:`` field): granular events like\n ``text_delta``, ``tool_use``, ``tool_result``, ``confirmation_request``,\n ``confirmation_result``, ``assistant_message``, ``terminal``.\n\nThe stream stays open during ``awaiting_confirmation``; it closes on\n``completed``, ``failed``, or ``cancelled``.", "operationId": "stream_agent_task_api_v1_agent_tasks__task_id__stream_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Stream Agent Task Api V1 Agent Tasks Task Id Stream Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agent/tasks/{task_id}/confirm": { "post": { "tags": [ "agent" ], "summary": "Confirm Tool Execution", "description": "Confirm or reject a high-cost tool execution that is awaiting user authorization.\n\nThe agent loop is suspended at the tool's check_permissions=ASK stage.\nThis endpoint resolves the pending confirmation, allowing the loop to\neither proceed with tool execution (approved=True) or skip it (approved=False).", "operationId": "confirm_tool_execution_api_v1_agent_tasks__task_id__confirm_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolConfirmRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Confirm Tool Execution Api V1 Agent Tasks Task Id Confirm Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agent/tasks/{task_id}/pending-confirmations": { "get": { "tags": [ "agent" ], "summary": "Get Pending Confirmations", "description": "Get all pending tool confirmations for a task.", "operationId": "get_pending_confirmations_api_v1_agent_tasks__task_id__pending_confirmations_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Get Pending Confirmations Api V1 Agent Tasks Task Id Pending Confirmations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agent/tasks/{task_id}/cancel": { "post": { "tags": [ "agent" ], "summary": "Cancel Agent Task", "description": "Cancel a running agent task.", "operationId": "cancel_agent_task_api_v1_agent_tasks__task_id__cancel_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Cancel Agent Task Api V1 Agent Tasks Task Id Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agent/sessions": { "get": { "tags": [ "agent" ], "summary": "List Agent Sessions", "description": "List agent sessions for the current user.", "operationId": "list_agent_sessions_api_v1_agent_sessions_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AgentSessionSummary" }, "type": "array", "title": "Response List Agent Sessions Api V1 Agent Sessions Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/agent/sessions/{session_id}/messages": { "get": { "tags": [ "agent" ], "summary": "Get Session Messages", "description": "Get message history for a session.", "operationId": "get_session_messages_api_v1_agent_sessions__session_id__messages_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentSessionMessage" }, "title": "Response Get Session Messages Api V1 Agent Sessions Session Id Messages Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/agent/sessions/{session_id}": { "delete": { "tags": [ "agent" ], "summary": "Delete Agent Session", "description": "Delete a session and clear its cached engine.", "operationId": "delete_agent_session_api_v1_agent_sessions__session_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Delete Agent Session Api V1 Agent Sessions Session Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/project/projects": { "post": { "tags": [ "project" ], "summary": "创建项目", "description": "创建新的项目 (支持 generic, image, video, tool)", "operationId": "create_project_api_v1_project_projects_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "project" ], "summary": "获取项目列表", "description": "获取当前用户的项目列表", "operationId": "list_projects_api_v1_project_projects_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "项目类型过滤", "title": "Project Type" }, "description": "项目类型过滤" }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "状态过滤", "title": "Status" }, "description": "状态过滤" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "页码", "default": 1, "title": "Page" }, "description": "页码" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "每页数量", "default": 20, "title": "Page Size" }, "description": "每页数量" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/project/projects/{project_id}": { "get": { "tags": [ "project" ], "summary": "获取项目详情", "description": "获取项目详情（含消息历史和业务数据）", "operationId": "get_project_api_v1_project_projects__project_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "project" ], "summary": "更新项目", "description": "更新项目基本信息和配置", "operationId": "update_project_api_v1_project_projects__project_id__put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "project" ], "summary": "删除项目", "description": "删除项目", "operationId": "delete_project_api_v1_project_projects__project_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/project/projects/{project_id}/chat": { "post": { "tags": [ "project" ], "summary": "发送聊天消息", "description": "与 Agent 进行对话", "operationId": "chat_with_agent_api_v1_project_projects__project_id__chat_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentChatRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentChatResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/project/projects/{project_id}/generate": { "post": { "tags": [ "project" ], "summary": "生成内容", "description": "触发内容生成", "operationId": "generate_content_api_v1_project_projects__project_id__generate_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentGenerateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentGenerateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/project/projects/{project_id}/assets": { "get": { "tags": [ "project" ], "summary": "获取项目资产列表", "description": "获取项目的资产列表", "operationId": "get_project_assets_api_v1_project_projects__project_id__assets_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MediaAssetResponse" }, "title": "Response Get Project Assets Api V1 Project Projects Project Id Assets Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "project" ], "summary": "添加资产", "description": "向项目添加资产", "operationId": "add_project_asset_api_v1_project_projects__project_id__assets_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAssetRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAssetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/project/projects/{project_id}/assets/{asset_id}": { "delete": { "tags": [ "project" ], "summary": "删除资产", "description": "从项目删除资产", "operationId": "delete_project_asset_api_v1_project_projects__project_id__assets__asset_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Asset Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/project/projects/{project_id}/scripts": { "get": { "tags": [ "project" ], "summary": "获取脚本列表", "description": "获取项目的脚本列表", "operationId": "get_project_scripts_api_v1_project_projects__project_id__scripts_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptSegmentResponse" }, "title": "Response Get Project Scripts Api V1 Project Projects Project Id Scripts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "project" ], "summary": "更新脚本列表", "description": "更新项目的脚本列表", "operationId": "update_project_scripts_api_v1_project_projects__project_id__scripts_put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateScriptsRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptSegmentResponse" }, "title": "Response Update Project Scripts Api V1 Project Projects Project Id Scripts Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/project/projects/{project_id}/timeline": { "get": { "tags": [ "project" ], "summary": "获取时间线", "description": "获取项目的时间线", "operationId": "get_project_timeline_api_v1_project_projects__project_id__timeline_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimelineResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "project" ], "summary": "更新时间线", "description": "更新项目的时间线", "operationId": "update_project_timeline_api_v1_project_projects__project_id__timeline_put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTimelineRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimelineResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/project/projects/{project_id}/export": { "post": { "tags": [ "project" ], "summary": "导出项目", "description": "导出项目 (支持视频导出、图片导出等)", "operationId": "export_project_api_v1_project_projects__project_id__export_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectExportRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectExportResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/download/media/{path}": { "get": { "tags": [ "download" ], "summary": "Download Media File", "description": "下载媒体文件代理端点\n\n用于代理 MinIO 中的媒体文件，支持视频、音频等文件的下载\n支持 Range 请求（视频拖动播放）\n\nArgs:\n path: 媒体文件路径，如 videos/filename.mp4, audios/filename.mp3\n download: true 时用 Content-Disposition: attachment（移动端「另存为」）", "operationId": "download_media_file_api_v1_download_media__path__get", "parameters": [ { "name": "path", "in": "path", "required": true, "schema": { "type": "string", "title": "Path" } }, { "name": "download", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Download" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/download/cache/stats": { "get": { "tags": [ "download" ], "summary": "Get Cache Stats", "description": "获取缓存统计信息（无需认证）\n\n返回缓存命中率、内存使用情况等统计数据", "operationId": "get_cache_stats_api_v1_download_cache_stats_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/download/extract-text": { "post": { "tags": [ "download" ], "summary": "Extract Text", "description": "提取音频文案（口播文案）\n\n从音频URL中提取口播文案文本内容\n\n返回码说明：\n- 200: 提取成功，返回文案内容\n- 202: 正在处理中，前端应每隔 retry_after 秒轮询本接口直至完成\n- 400: 请求参数错误\n- 500: 服务器内部错误", "operationId": "extract_text_api_v1_download_extract_text_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractMediaRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/download/extract-bgm": { "post": { "tags": [ "download" ], "summary": "Extract Bgm", "description": "提取背景音乐\n\n从音频URL中提取背景音乐\n\n返回码说明：\n- 200: 提取成功\n- 202: 正在处理中，前端应每隔 retry_after 秒轮询本接口直至完成\n- 400: 请求参数错误\n- 500: 服务器内部错误", "operationId": "extract_bgm_api_v1_download_extract_bgm_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractMediaRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/download/extract-audio": { "post": { "tags": [ "download" ], "summary": "Extract Audio From Video", "description": "从视频URL提取音频\n\n从视频URL下载并提取音频，返回音频文件URL\n\n返回码说明：\n- 200: 提取成功\n- 202: 正在处理中，前端应每隔 retry_after 秒轮询本接口直至完成\n- 400: 请求参数错误\n- 500: 服务器内部错误", "operationId": "extract_audio_from_video_api_v1_download_extract_audio_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractMediaRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/download/cache/clear": { "delete": { "tags": [ "download" ], "summary": "Clear Cache", "description": "清空所有缓存\n\n需要管理员权限（当前为演示模式）", "operationId": "clear_cache_api_v1_download_cache_clear_delete", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/extraction/analyze": { "post": { "tags": [ "extraction" ], "summary": "分析 URL（纯素材解析，不下载不上传）", "description": "分析 URL 并解析素材元数据与直链。\n\n**仅数据提取**：返回平台 video/audio/cover 直链与标题等元数据。\n**不会**下载媒体文件、**不会**上传到对象存储、**不会**做 BGM/ASR。\n需要落盘/转存、口播文案、人声分离请走独立原子能力。", "operationId": "analyze_url_api_v1_extraction_analyze_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionAnalyzeRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionResultResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/extraction/upload": { "post": { "tags": [ "extraction" ], "summary": "登记本地上传文件（仅登记元数据，不做二次下载/转码）", "description": "登记用户上传的媒体文件为一条素材提取记录。\n\n仅保存用户提交的文件到存储并登记元数据（文件本身由客户端提交），\n**不做**平台下载、BGM 分离、ASR 或二次转码。", "operationId": "upload_file_extraction_api_v1_extraction_upload_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_file_extraction_api_v1_extraction_upload_post" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionResultResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/extraction/{extraction_id}": { "get": { "tags": [ "extraction" ], "summary": "获取提取结果", "description": "获取提取结果详情", "operationId": "get_extraction_api_v1_extraction__extraction_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "extraction_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Extraction Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionResultResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/extraction/{extraction_id}/progress": { "get": { "tags": [ "extraction" ], "summary": "获取提取进度 (SSE)", "description": "获取提取进度（Server-Sent Events）\n\n注意: 由于 EventSource 不支持自定义 headers，\ntoken 通过 query 参数传递。\n\n资源隔离：鉴权用短会话；SSE 轮询每轮独立开/关 session，\n禁止在长连接期间持有 Depends(get_db) 连接。", "operationId": "get_extraction_progress_api_v1_extraction__extraction_id__progress_get", "parameters": [ { "name": "extraction_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Extraction Id" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string", "description": "JWT token for SSE authentication", "title": "Token" }, "description": "JWT token for SSE authentication" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/extraction/history": { "get": { "tags": [ "extraction" ], "summary": "获取提取历史", "description": "获取用户的提取历史", "operationId": "get_extraction_history_api_v1_extraction_history_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "platform", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "平台过滤", "title": "Platform" }, "description": "平台过滤" }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "状态过滤", "title": "Status" }, "description": "状态过滤" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Page Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/extraction/{extraction_id}/save-to-assets": { "post": { "tags": [ "extraction" ], "summary": "保存到资源库（已下线）", "description": "云素材库已下线；请使用各端「我的空间」本地记录。", "operationId": "save_to_assets_api_v1_extraction__extraction_id__save_to_assets_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "extraction_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Extraction Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveToAssetsRequest" } } } }, "responses": { "410": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveToAssetsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/extraction/{extraction_id}/download/{resource_type}": { "get": { "tags": [ "extraction" ], "summary": "跳转到资源直链", "description": "按资源类型 302 跳转到解析得到的直链（服务端不二次拉取/转存）。", "operationId": "download_resource_api_v1_extraction__extraction_id__download__resource_type__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "extraction_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Extraction Id" } }, { "name": "resource_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/tools": { "get": { "tags": [ "tools" ], "summary": "Get Tools", "description": "获取工具列表\n返回所有可用的工具信息", "operationId": "get_tools_api_v1_tools_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/tools/{tool_id}": { "get": { "tags": [ "tools" ], "summary": "Get Tool By Id", "description": "根据ID获取工具信息", "operationId": "get_tool_by_id_api_v1_tools__tool_id__get", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/tool-history": { "post": { "tags": [ "tool-history" ], "summary": "创建工具使用历史记录", "description": "记录用户使用工具的历史", "operationId": "create_tool_history_api_v1_tool_history_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolHistoryCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolHistoryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "tool-history" ], "summary": "获取工具使用历史记录列表", "description": "分页获取当前用户的工具使用历史记录", "operationId": "get_tool_history_list_api_v1_tool_history_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "页码", "default": 1, "title": "Page" }, "description": "页码" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "每页数量", "default": 20, "title": "Page Size" }, "description": "每页数量" }, { "name": "tool_category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "工具分类筛选", "title": "Tool Category" }, "description": "工具分类筛选" }, { "name": "tool_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "工具ID筛选", "title": "Tool Id" }, "description": "工具ID筛选" }, { "name": "status_filter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "状态筛选", "title": "Status Filter" }, "description": "状态筛选" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolHistoryListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/tool-history/{history_id}": { "get": { "tags": [ "tool-history" ], "summary": "获取单个工具使用历史记录", "description": "根据ID获取工具使用历史记录详情", "operationId": "get_tool_history_api_v1_tool_history__history_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "history_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "History Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolHistoryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "tool-history" ], "summary": "删除工具使用历史记录", "description": "根据ID删除工具使用历史记录", "operationId": "delete_tool_history_api_v1_tool_history__history_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "history_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "History Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolHistoryDeleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/tool-history/": { "delete": { "tags": [ "tool-history" ], "summary": "批量删除工具使用历史记录", "description": "根据条件批量删除工具使用历史记录", "operationId": "delete_tool_history_batch_api_v1_tool_history__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "tool_category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "工具分类筛选", "title": "Tool Category" }, "description": "工具分类筛选" }, { "name": "tool_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "工具ID筛选", "title": "Tool Id" }, "description": "工具ID筛选" }, { "name": "status_filter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "状态筛选", "title": "Status Filter" }, "description": "状态筛选" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolHistoryDeleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/copywriting/extract-link": { "post": { "tags": [ "copywriting" ], "summary": "Extract Link", "description": "从链接提取口播文案\n\n短视频链接流水线：解析视频 → 分离音频 → ASR 识别 → 返回文案。\n普通网页仍走 HTML 抓取。", "operationId": "extract_link_api_v1_copywriting_extract_link_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkExtractionRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/copywriting/smart-original": { "post": { "tags": [ "copywriting" ], "summary": "Smart Original", "description": "智能原创", "operationId": "smart_original_api_v1_copywriting_smart_original_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmartOriginalRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/copywriting/image-to-text": { "post": { "tags": [ "copywriting" ], "summary": "Image To Text", "description": "图片转文案：经 Backend 调 Media OCR（model=auto|glm-ocr|pp-ocrv5）。", "operationId": "image_to_text_api_v1_copywriting_image_to_text_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_image_to_text_api_v1_copywriting_image_to_text_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/copywriting/word-to-text": { "post": { "tags": [ "copywriting" ], "summary": "Word To Text", "description": "文档转文案（Backend → Media anydoc）", "operationId": "word_to_text_api_v1_copywriting_word_to_text_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_word_to_text_api_v1_copywriting_word_to_text_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/copywriting/webpage-scrape": { "post": { "tags": [ "copywriting" ], "summary": "Webpage Scrape", "description": "网页解析转文案（Backend → Media web scrape）", "operationId": "webpage_scrape_api_v1_copywriting_webpage_scrape_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebpageScrapeCopyRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/copywriting/audio-to-text": { "post": { "tags": [ "copywriting" ], "summary": "Audio To Text", "description": "音频转文案\n\n将上传的音频文件转录为文字。使用远程 AI 推理服务进行语音识别。\n\n注意: 需要配置 AI 推理服务 (SH_INFER_ENABLED=true)", "operationId": "audio_to_text_api_v1_copywriting_audio_to_text_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_audio_to_text_api_v1_copywriting_audio_to_text_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/copywriting/detect-forbidden": { "post": { "tags": [ "copywriting" ], "summary": "Detect Forbidden Words", "description": "违禁词检测", "operationId": "detect_forbidden_words_api_v1_copywriting_detect_forbidden_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenWordRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/copywriting/video-script": { "post": { "tags": [ "copywriting" ], "summary": "Generate Video Script", "description": "生成视频脚本", "operationId": "generate_video_script_api_v1_copywriting_video_script_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoScriptRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/copywriting/product-review": { "post": { "tags": [ "copywriting" ], "summary": "Generate Product Review", "description": "生成产品测评", "operationId": "generate_product_review_api_v1_copywriting_product_review_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductReviewRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/copywriting/xiaohongshu": { "post": { "tags": [ "copywriting" ], "summary": "Generate Xiaohongshu", "description": "生成小红书风格文案", "operationId": "generate_xiaohongshu_api_v1_copywriting_xiaohongshu_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XiaohongshuRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/copywriting/marketing": { "post": { "tags": [ "copywriting" ], "summary": "Generate Marketing", "description": "生成营销文案", "operationId": "generate_marketing_api_v1_copywriting_marketing_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketingRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/document/formats": { "get": { "tags": [ "document" ], "summary": "Document Formats", "operationId": "document_formats_api_v1_document_formats_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/document/parse": { "post": { "tags": [ "document" ], "summary": "Document Parse", "description": "通过文件 URL 解析文档（Word / Excel / PDF / PPT / TXT 等）。", "operationId": "document_parse_api_v1_document_parse_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentParseRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/document/parse/upload": { "post": { "tags": [ "document" ], "summary": "Document Parse Upload", "description": "上传文档并解析。", "operationId": "document_parse_upload_api_v1_document_parse_upload_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_document_parse_upload_api_v1_document_parse_upload_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/web/status": { "get": { "tags": [ "web" ], "summary": "Web Status", "operationId": "web_status_api_v1_web_status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/web/scrape": { "post": { "tags": [ "web" ], "summary": "Web Scrape", "description": "抓取网页并提取降噪正文（Markdown）。", "operationId": "web_scrape_api_v1_web_scrape_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebScrapeRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/studio/projects": { "get": { "tags": [ "studio" ], "summary": "List Projects", "description": "列出当前用户的 Studio 项目", "operationId": "list_projects_api_v1_studio_projects_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response List Projects Api V1 Studio Projects Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/studio/projects/quick-render": { "post": { "tags": [ "studio" ], "summary": "Quick Render", "operationId": "quick_render_api_v1_studio_projects_quick_render_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StudioQuickRenderRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickRenderResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/api/v1/studio/projects/{project_id}": { "get": { "tags": [ "studio" ], "summary": "Get Project", "operationId": "get_project_api_v1_studio_projects__project_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StudioProjectResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/studio/projects/{project_id}/run": { "post": { "tags": [ "studio" ], "summary": "Run Project", "operationId": "run_project_api_v1_studio_projects__project_id__run_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StudioRunRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuickRenderResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/studio/projects/{project_id}/visual-assets": { "post": { "tags": [ "studio" ], "summary": "Upsert Visual Asset", "operationId": "upsert_visual_asset_api_v1_studio_projects__project_id__visual_assets_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisualAssetUpsert" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Upsert Visual Asset Api V1 Studio Projects Project Id Visual Assets Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/studio/projects/{project_id}/shots/{shot_id}": { "put": { "tags": [ "studio" ], "summary": "Patch Shot", "operationId": "patch_shot_api_v1_studio_projects__project_id__shots__shot_id__put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "shot_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Shot Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShotPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Patch Shot Api V1 Studio Projects Project Id Shots Shot Id Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/studio/jobs/{job_id}": { "get": { "tags": [ "studio" ], "summary": "Get Job", "operationId": "get_job_api_v1_studio_jobs__job_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StudioJobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/proxy/stream": { "get": { "tags": [ "proxy" ], "summary": "Proxy Stream", "description": "Proxy stream a URL to bypass CORS / anti-hotlink.\nThis routes the traffic through the backend with proper platform-specific headers.\n\n鉴权：\n- Authorization: Bearer （fetch/XHR）\n- ?token=（原生 video/audio 标签无法自定义请求头）\n\n安全措施：\n- 强制登录\n- 禁止访问私有 IP 地址 (10.x.x.x, 192.168.x.x, 127.0.0.1 等)\n- 禁止访问云服务元数据端点\n- DNS 解析检查防止 DNS 重绑定攻击\n\n资源隔离：鉴权/配额短会话；流式传输期间不持有 DB 连接。", "operationId": "proxy_stream_api_v1_proxy_stream_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Target URL to stream", "title": "Url" }, "description": "Target URL to stream" }, { "name": "platform", "in": "query", "required": false, "schema": { "type": "string", "description": "Platform hint for setting correct Referer", "title": "Platform" }, "description": "Platform hint for setting correct Referer" }, { "name": "token", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JWT token for