OX
OPEN-OX

// docs / api

API 参考

Open-OX Studio 的 HTTP 接口均为 Next.js Route Handlers,与前端同域。生成与修改类接口多为 text/event-stream (SSE)。以下为主要对外路由速查。

项目

POST/api/projects创建项目,返回 projectId(需登录)
GET/api/projects项目列表;默认全员可见,?mine=1 仅自己,支持 folder / offset / limit
GET/api/projects/[id]项目详情(轮询生成进度)
PATCH/api/projects/[id]重命名、移动文件夹等
DELETE/api/projects/[id]删除项目及关联文件

生成与修改

POST/api/ai启动生成流水线(SSE,需 projectId)
POST/api/projects/[id]/modify启动修改 Agent(SSE)
GET/api/projects/[id]/memory读取对话记忆(调试)

预览与文件

POST/api/projects/[id]/preview首次启动 E2B 沙箱预览
PUT/api/projects/[id]/preview代码变更后增量重建预览
GET/api/projects/[id]/preview/status沙箱 / 构建状态
GET/api/projects/[id]/files列出 Storage 中的文件
POST/api/projects/[id]/files从 Storage 恢复到工作区
PUT/api/projects/[id]/files将工作区文件上传到 Storage

文件夹

GET/api/folders当前用户的项目文件夹列表
POST/api/folders创建文件夹
DELETE/api/folders/[id]删除文件夹及其中的项目

模型与技能

GET/api/models可用 LLM 模型列表(含 DB 自定义模型)
GET/api/skills风格技能 id / 标签(Hero「/」菜单)

会话与认证

GET/api/auth/user当前登录用户(含 user_metadata)
GET/api/auth/feishu/start飞书 OAuth 授权跳转(服务端 redirect)
GET/api/auth/feishu/callback飞书 OAuth 回调,建立 Supabase 会话
更完整的请求流程与数据流说明见 系统架构 → API 路由